1 package nom.tam.fits.compression.provider.param.api;
2
3 /*
4 * #%L
5 * nom.tam FITS library
6 * %%
7 * Copyright (C) 1996 - 2024 nom-tam-fits
8 * %%
9 * This is free and unencumbered software released into the public domain.
10 *
11 * Anyone is free to copy, modify, publish, use, compile, sell, or
12 * distribute this software, either in source code form or as a compiled
13 * binary, for any purpose, commercial or non-commercial, and by any
14 * means.
15 *
16 * In jurisdictions that recognize copyright laws, the author or authors
17 * of this software dedicate any and all copyright interest in the
18 * software to the public domain. We make this dedication for the benefit
19 * of the public at large and to the detriment of our heirs and
20 * successors. We intend this dedication to be an overt act of
21 * relinquishment in perpetuity of all present and future rights to this
22 * software under copyright law.
23 *
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
27 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
28 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
29 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
30 * OTHER DEALINGS IN THE SOFTWARE.
31 * #L%
32 */
33
34 import nom.tam.fits.Header;
35 import nom.tam.fits.HeaderCard;
36 import nom.tam.fits.HeaderCardException;
37
38 /**
39 * (<i>for internal use</i>) Access to FITS header values with runtime exceptions only. Regular header access throws
40 * {@link HeaderCardException}s, which are hard exceptions. They really should have been softer runtime exceptions from
41 * the start, but unfortunately that was choice this library made a very long time ago, and we therefore stick to it, at
42 * least until the next major code revision (major version 2 at the earliest). So this class provides an alternative
43 * access to headers converting any <code>HeaderCardException</code>s to {@link IllegalArgumentException}.
44 *
45 * @see Header
46 *
47 * @deprecated This class serves no purpose since 1.19. Will remove in some future. Prior to 1.19 {@link Header} threw
48 * hard {@link HeaderCardException}, and this class was added so we can convert these into soft
49 * {@link IllegalArgumentException} instead. However, now that we demoted
50 * <code>HeaderCardException</code> to be soft exceptions itself, there is no reason to convert. It just
51 * adds confusion.
52 */
53 public class HeaderAccess implements IHeaderAccess {
54
55 private final Header header;
56
57 /**
58 * <p>
59 * Creates a new access to modifying a {@link HeaderCard} without the hard exceptions that <code>HeaderCard</code>
60 * may throw.
61 * </p>
62 *
63 * @param header the FITS header we wish to access and modify
64 */
65 public HeaderAccess(Header header) {
66 this.header = header;
67 }
68
69 /**
70 * Returns the header that this class is providing access to.
71 *
72 * @return the Header that we access through this class
73 *
74 * @since 1.19
75 */
76 @Override
77 public final Header getHeader() {
78 return header;
79 }
80
81 }