Package nom.tam.fits.compression.provider.param.api

Class HeaderCardAccess

java.lang.Object

nom.tam.fits.compression.provider.param.api.HeaderCardAccess

All Implemented Interfaces:

IHeaderAccess

public class HeaderCardAccess
extends Object
implements IHeaderAccess

(for internal use) Access to a specific FITS header card with runtime exceptions only. Regular modifications to HeaderCard may throw HeaderCardExceptions, which are hard exceptions. They really should have been softer runtime exceptions from the start, but unfortunately that was choice this library made a very long time ago, and we therefore stick to it, at least until the next major code revision (major version 2 at the earliest). So this class provides an alternative access to a header card converting any HeaderCardExceptions to IllegalArgumentException.

Unlike HeaderAccess this class operates on single cards. Methods that specify a keywords are applied to the selected card if and only if the keyword matches that of the card's keyword.

See Also:

• Header

Constructor Summary

Constructors

Constructor	Description
HeaderCardAccess(IFitsHeader headerCard, String value)	Creates a new access to modifying a HeaderCard without the hard exceptions that HeaderCard may throw.

Method Summary

Modifier and Type	Method	Description
void	addValue(IFitsHeader key, int value)	Sets a new integer value for the specified FITS keyword, adding it to the FITS header if necessary.
void	addValue(IFitsHeader key, String value)	Sets a new string value for the specified FITS keyword, adding it to the FITS header if necessary.
HeaderCard	findCard(String key)	Returns the FITS header card for the given FITS keyword.
HeaderCard	findCard(IFitsHeader key)	Returns the FITS header card for the given FITS keyword.

Methods inherited from class java.lang.Object

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

Constructor Details

HeaderCardAccess

public HeaderCardAccess(IFitsHeader headerCard,
 String value)

Creates a new access to modifying a HeaderCard without the hard exceptions that HeaderCard may throw.

Unlike HeaderAccess this class operates on single cards. Methods that specify a keywords are applied to the selected card if and only if the keyword matches that of the card's keyword.

Parameters:

headerCard - the FITS keyword of the card we will provide access to

value - the initial string value for the card (assuming the keyword allows string values).

Method Details

addValue

public void addValue(IFitsHeader key,
 int value)

Description copied from interface: IHeaderAccess

Sets a new integer value for the specified FITS keyword, adding it to the FITS header if necessary.

Specified by:

addValue in interface IHeaderAccess

Parameters:

key - the standard or conventional FITS header keyword

value - the integer value to assign to the keyword

addValue

public void addValue(IFitsHeader key,
 String value)

Description copied from interface: IHeaderAccess

Sets a new string value for the specified FITS keyword, adding it to the FITS header if necessary.

Specified by:

addValue in interface IHeaderAccess

Parameters:

key - the standard or conventional FITS header keyword

value - the string value to assign to the keyword

findCard

public HeaderCard findCard(IFitsHeader key)

Description copied from interface: IHeaderAccess

Returns the FITS header card for the given FITS keyword.

Specified by:

findCard in interface IHeaderAccess

Parameters:

key - the standard or conventional FITS header keyword

Returns:

the matching FITS header card, or null if there is no such card within out grasp.

findCard

public HeaderCard findCard(String key)

Description copied from interface: IHeaderAccess

Returns the FITS header card for the given FITS keyword.

Specified by:

findCard in interface IHeaderAccess

Parameters:

key - the FITS header keyword

Returns:

the matching FITS header card, or null if there is no such card within out grasp.