1 package nom.tam.fits.header;
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 * Specify user defined comments for standard keywords.
36 *
37 * @author ritchie
38 *
39 * @deprecated (<i>for internal use</i>) Visibility may be reduced to package level in the future.
40 */
41 @Deprecated
42 class StandardCommentReplacement {
43
44 private String comment;
45
46 private final Class<?> context;
47
48 private final String ref;
49
50 @Deprecated
51 protected StandardCommentReplacement(String ref, Class<?> context) {
52 this.ref = ref;
53 this.context = context;
54 comment = null;
55 }
56
57 @Deprecated
58 protected StandardCommentReplacement(String ref, Class<?> context, String comment) {
59 this.ref = ref;
60 this.context = context;
61 this.comment = comment;
62 }
63
64 @Deprecated
65 public String getComment() {
66 return comment;
67 }
68
69 @Deprecated
70 public Class<?> getContext() {
71 return context;
72 }
73
74 @Deprecated
75 public String getRef() {
76 return ref;
77 }
78
79 @Deprecated
80 public void setComment(String comment) {
81 this.comment = comment;
82 }
83 }