View Javadoc
1   package nom.tam.fits;
2   
3   /*-
4    * #%L
5    * nom.tam.fits
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   * Failed checksum verification.
36   * 
37   * @author Attila Kovacs
38   * @since 1.18.1
39   */
40  public class FitsIntegrityException extends FitsException {
41  
42      private static final long serialVersionUID = -221485588322280968L;
43  
44      /**
45       * Creates a new checksum verification failure
46       * 
47       * @param name
48       *            the type of checksum test that failed
49       * @param got
50       *            the checksum value that was found
51       * @param expected
52       *            the checksum value expected
53       */
54      FitsIntegrityException(String name, long got, long expected) {
55          super("Failed " + name + ": got " + got + ", expected " + expected);
56      }
57  
58      /**
59       * Creates a new checksum verification failure for a verification failure on
60       * a specific HDU
61       * 
62       * @param hduIndex
63       *            the zero-based index of the HDU within the FITS
64       * @param cause
65       *            the undrlying checksum verification failure
66       */
67      FitsIntegrityException(int hduIndex, FitsIntegrityException cause) {
68          super("Corrupted HDU[" + hduIndex + "]: " + cause.getMessage(), cause);
69      }
70  }