View Javadoc
1   package nom.tam.fits;
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  /**
35   * The value cannot fit into the available header space, as requested. Perhaps
36   * it's preceded by a very long HIEARACH keyword, or else it's a numerical value
37   * that is too long. Either way, there is no way we can represent this value in
38   * its current form (and keyword) in a FITS header.
39   * 
40   * @author Attila Kovacs
41   * @since 1.16
42   */
43  public class LongValueException extends HeaderCardException {
44  
45      /**
46       *
47       */
48      private static final long serialVersionUID = -1446259888260331392L;
49  
50      /**
51       * Instantiates a new exception about a long value that cannot be fitted
52       * into the space available for it in the FITS header.
53       * 
54       * @param spaceAvailable
55       *            the maximum space available for the value field for the given
56       *            record.
57       */
58      public LongValueException(int spaceAvailable) {
59          super("Not enough space (" + spaceAvailable + ") for value");
60      }
61  
62      /**
63       * Instantiates a new exception about a long value that cannot be fitted
64       * into the space available for it in the FITS header.
65       * 
66       * @param key
67       *            the header keyword for which the exception occurred.
68       * @param spaceAvailable
69       *            the maximum space available for the value field for the given
70       *            record.
71       */
72      public LongValueException(String key, int spaceAvailable) {
73          super("Not enough space (" + spaceAvailable + ") for value of [" + key + "]");
74      }
75  
76      /**
77       * Instantiates a new exception about a long value that cannot be fitted
78       * into the space available for it in the FITS header.
79       * 
80       * @param spaceAvailable
81       *            the maximum space available for the value field for the given
82       *            record.
83       * @param value
84       *            the header value that was too long.
85       */
86      public LongValueException(int spaceAvailable, String value) {
87          super("Not enough space (" + spaceAvailable + ") for: [" + value + "]");
88      }
89  
90      /**
91       * Instantiates a new exception about a long value that cannot be fitted
92       * into the space available for it in the FITS header.
93       * 
94       * @param spaceAvailable
95       *            the maximum space available for the value field for the given
96       *            record.
97       * @param key
98       *            the header keyword for which the exception occurred.
99       * @param value
100      *            the header value that was too long.
101      */
102     public LongValueException(int spaceAvailable, String key, String value) {
103         super("Not enough space (" + spaceAvailable + ") for: [" + key + "=" + value + "]");
104     }
105 }