Package nom.tam.fits.header

Enum IFitsHeader.HDU

java.lang.Object

java.lang.Enum<IFitsHeader.HDU>

nom.tam.fits.header.IFitsHeader.HDU

All Implemented Interfaces:

Serializable, Comparable<IFitsHeader.HDU>, java.lang.constant.Constable

Enclosing interface:

IFitsHeader

public static enum IFitsHeader.HDU
extends Enum<IFitsHeader.HDU>

An enumeration of HDU types in which a header keyword may be used.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANY	keyword may be used in any HDU
ASCII_TABLE	keyword for ASCII tables only
BINTABLE	keyword for binary tables
EXTENSION	keyword must appear in extension HDUs only
GROUPS	keyword for random groups only
IMAGE	image and/or random groups keywords
PRIMARY	keyword must appear in the primary HDU only
PRIMARY_EXTENSION	Deprecated. Use ANY instead.
TABLE	Generic table keyword, can be used both in ASCII and binary tables

Method Summary

Modifier and Type	Method	Description
static IFitsHeader.HDU	valueOf(String name)	Returns the enum constant of this type with the specified name.
static IFitsHeader.HDU[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ANY

public static final IFitsHeader.HDU ANY

keyword may be used in any HDU

IMAGE

public static final IFitsHeader.HDU IMAGE

image and/or random groups keywords

GROUPS

public static final IFitsHeader.HDU GROUPS

keyword for random groups only

TABLE

public static final IFitsHeader.HDU TABLE

Generic table keyword, can be used both in ASCII and binary tables

ASCII_TABLE

public static final IFitsHeader.HDU ASCII_TABLE

keyword for ASCII tables only

BINTABLE

public static final IFitsHeader.HDU BINTABLE

keyword for binary tables

PRIMARY

public static final IFitsHeader.HDU PRIMARY

keyword must appear in the primary HDU only

EXTENSION

public static final IFitsHeader.HDU EXTENSION

keyword must appear in extension HDUs only

PRIMARY_EXTENSION

public static final IFitsHeader.HDU PRIMARY_EXTENSION

Deprecated.

Use ANY instead.

Method Details

values

public static IFitsHeader.HDU[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IFitsHeader.HDU valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null