Package nom.tam.fits.header.hierarch

Class Hierarch

java.lang.Object
nom.tam.fits.header.hierarch.Hierarch
public final class Hierarch extends Object
Helper class for creating HIERARCH-style (or long) FITS keywords for use within this library.
Since:
1.18
Author:
Attila Kovacs

  • Method Summary

    Modifier and Type
    Method
    Description
    static String
    key(String keyword)
    Creates a hierarch-style (or long) keyword to use within this library, by prepending "HIERARCH." to the user-specified long or hierarchical keyword.
    static String
    key(String... components)
    Creates a hierarch-style keyword from its hierarchical components to use within this library, For example, for the arguments "group" and "property", this will return "HIERARCH.group.property", which is how we refer to this keyword internally within this library.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • key

      public static String key(String keyword)
      Creates a hierarch-style (or long) keyword to use within this library, by prepending "HIERARCH." to the user-specified long or hierarchical keyword. For example, for the argument "group.property", this will return "HIERARCH.group.property", which is how we refer to this keyword internally within this library.
      Parameters:
      keyword - The user-defined long or hierarchical keyword. Hierarchical keywords should have components separated by dots, e.g. system.subsystem.property. Case-sensitivity depends on the formatter used, see e.g. IHierarchKeyFormatter.isCaseSensitive().
      Returns:
      The keyword, prepended by "HIERARCH." as per the internal convention for referring to such keywords within this library.
      Since:
      1.18
      See Also:

    • key

      public static String key(String... components)
      Creates a hierarch-style keyword from its hierarchical components to use within this library, For example, for the arguments "group" and "property", this will return "HIERARCH.group.property", which is how we refer to this keyword internally within this library.
      Parameters:
      components - A list of hierarchical keyword components. These will be concatenated into a dot-separated keyword, and prepended by HIERARCH.. Case-sensitivity depends on the formatter used, see e.g. IHierarchKeyFormatter.isCaseSensitive().
      Returns:
      The keyword, prepended by "HIERARCH." as per the internal convention for referring to such keywords within this library.
      Since:
      1.18
      See Also: