Package nom.tam.fits.header.hierarch

Class BlanksDotHierarchKeyFormatter

java.lang.Object
nom.tam.fits.header.hierarch.BlanksDotHierarchKeyFormatter
All Implemented Interfaces:
IHierarchKeyFormatter
public class BlanksDotHierarchKeyFormatter extends Object implements IHierarchKeyFormatter
Deprecated.
Non-standard HIERARCH keyword formatter that separates hierarchical keyword component by multiple while spaces. Otherwise, it is similar to StandardIHierarchKeyFormatter. Its use over the more standard formatter is discouraged.

  • Constructor Summary

    Constructors
    Constructor
    Description
    BlanksDotHierarchKeyFormatter(int count)
    Deprecated.
    Creates a HIERARCH keyword formatter instance with the desired number of blank spaces spearating components.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    append(String key, nom.tam.fits.utilities.FitsLineAppender buffer)
    Deprecated.
    Appends the formatted HIERARCH keyword to the Fits line buffer.
    int
    getExtraSpaceRequired(String key)
    Deprecated.
    Returns the extra spaces required when printing the key, relative to a space separated components following "HIERARCH " and the "= " prior to the value.
    final boolean
    isCaseSensitive()
    Deprecated.
    Checks if this formatter allows support for case-sensitive (mixed-case) hierarchical keywords.
    void
    setCaseSensitive(boolean value)
    Deprecated.
    Sets whether case-sensitive (mixed-case) HIERARCH keywords are supported.
    String
    toHeaderString(String key)
    Deprecated.
    Returns the string reppresentation of the specified HIERARCH keyword in the FITS header

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface nom.tam.fits.header.hierarch.IHierarchKeyFormatter

    getAssignStringForSpace, getMinAssignLength

  • Constructor Details

    • BlanksDotHierarchKeyFormatter

      public BlanksDotHierarchKeyFormatter(int count) throws IllegalArgumentException
      Deprecated.
      Creates a HIERARCH keyword formatter instance with the desired number of blank spaces spearating components.
      Parameters:
      count - The number of blank spaces to separate hierarchical components (at least 1 is required).
      Throws:
      IllegalArgumentException - if count is less than 1

  • Method Details

    • append

      public void append(String key, nom.tam.fits.utilities.FitsLineAppender buffer)
      Deprecated.
      Description copied from interface: IHierarchKeyFormatter
      Appends the formatted HIERARCH keyword to the Fits line buffer. For example as a step towards builing up the header card for this keyword.
      Specified by:
      append in interface IHierarchKeyFormatter
      Parameters:
      key - The HIERARCH keyword in out own internal representation (HIERARCH. followed by the dot-sepatated hierarchical components).
      buffer - The FITS line buffer to which we want the formatted HIERARCH-style keyword to be appended.

    • getExtraSpaceRequired

      public int getExtraSpaceRequired(String key)
      Deprecated.
      Description copied from interface: IHierarchKeyFormatter
      Returns the extra spaces required when printing the key, relative to a space separated components following "HIERARCH " and the "= " prior to the value.
      Specified by:
      getExtraSpaceRequired in interface IHierarchKeyFormatter
      Parameters:
      key - the HIERARCH-style header key.
      Returns:
      the number of extra spaces relative to the most compact notation for the components.

    • toHeaderString

      public String toHeaderString(String key)
      Deprecated.
      Description copied from interface: IHierarchKeyFormatter
      Returns the string reppresentation of the specified HIERARCH keyword in the FITS header
      Specified by:
      toHeaderString in interface IHierarchKeyFormatter
      Parameters:
      key - the HIERARCH keyword, in the dot separated convention of this library
      Returns:
      how this key looks in the FITS header with this formatting convention.

    • setCaseSensitive

      public void setCaseSensitive(boolean value)
      Deprecated.
      Description copied from interface: IHierarchKeyFormatter
      Sets whether case-sensitive (mixed-case) HIERARCH keywords are supported.
      Specified by:
      setCaseSensitive in interface IHierarchKeyFormatter
      Parameters:
      value - If false (default), then all HIERARCH keywords will be converted to upper-case. Otherwise, case will be preserved.
      See Also:

    • isCaseSensitive

      public final boolean isCaseSensitive()
      Deprecated.
      Description copied from interface: IHierarchKeyFormatter
      Checks if this formatter allows support for case-sensitive (mixed-case) hierarchical keywords.
      Specified by:
      isCaseSensitive in interface IHierarchKeyFormatter
      Returns:
      If false (default), then all HIERARCH keywords will be converted to upper-case. Otherwise, case will be preserved.