Class FitsHeaderImpl

java.lang.Object

nom.tam.fits.header.FitsKey

nom.tam.fits.header.FitsHeaderImpl

All Implemented Interfaces:

Serializable, IFitsHeader

@Deprecated
public class FitsHeaderImpl
extends FitsKey

Deprecated.

Use the more intuitively named FitsKey class instead. This class is provided for compatibility with prior releases.

The old concrete implementation of standardized FITS keywords, with a very unintuitive class name.

Author:

ritchie

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface IFitsHeader

IFitsHeader.HDU, IFitsHeader.SOURCE, IFitsHeader.VALUE

Modifier and Type	Interface	Description
static enum	IFitsHeader.HDU	An enumeration of HDU types in which a header keyword may be used.
static enum	IFitsHeader.SOURCE	Documentation sources for the various known conventions.
static enum	IFitsHeader.VALUE	Values types to which implementing keywords can be restricted to.

Field Summary

Fields inherited from interface IFitsHeader

MAX_INDEX

Modifier and Type	Field	Description
static final int	MAX_INDEX	Max numeric index we may use to replace n in the Java name of indexed variables.

Constructor Summary

Constructors

Constructor	Description
FitsHeaderImpl(String headerName, IFitsHeader.SOURCE status, IFitsHeader.HDU hdu, IFitsHeader.VALUE valueType, String comment)	Deprecated.

Method Summary

Methods inherited from class FitsKey

comment, hdu, impl, isCommentStyleKey, key, status, valueType

Modifier and Type	Method	Description
String	comment()	Returns the comment associated to this FITS header entry.
IFitsHeader.HDU	hdu()	Returns the type of HDU(s) in which this header entry may be used.
final FitsKey	impl()	(primarily for internal use) Returns the concrete implementation of this header entry, which provides implementation of access methods.
static boolean	isCommentStyleKey(String key)	(for internal use) Checks if a keywords is known to be a comment-style keyword.
String	key()	Returns the FITS header keyword (or keyword template) for this header entry.
IFitsHeader.SOURCE	status()	Returns the standard convention, which defines this FITS header entry
IFitsHeader.VALUE	valueType()	The type(s) of value(s) this FITS header entry might take.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface IFitsHeader

extractIndices, n

Modifier and Type	Method	Description
default int[]	extractIndices(String key)	Extracts the indices for this stndardized key from an actual keyword realization.
default IFitsHeader	n(int... numbers)	Constructs an indexed FITS header keyword entry from this stem, replacing index place-holders (indicated by lower-case 'n' in the name) with actual numerical values.

Constructor Details

FitsHeaderImpl

@Deprecated
public FitsHeaderImpl(String headerName,
 IFitsHeader.SOURCE status,
 IFitsHeader.HDU hdu,
 IFitsHeader.VALUE valueType,
 String comment)
               throws IllegalArgumentException

Deprecated.

Creates a new standardized FITS keyword with the specific usage constraints

Parameters:

headerName - The keyword as it will appear in the FITS headers, usually a string with up to 8 characters, containing uppper case letters (A-Z), digits (0-9), and/or underscore (_) or hyphen (-) characters for standard FITS keywords.

status - The convention that defines this keyword

hdu - the type of HDU this keyword may appear in

valueType - the type of value that may be associated with this keyword

comment - the standard comment to include with this keyword

Throws:

IllegalArgumentException - if the keyword name is invalid.