Package nom.tam.fits

Class HeaderCardBuilder

java.lang.Object
nom.tam.fits.HeaderCardBuilder
public class HeaderCardBuilder extends Object
Builder pattern implementation for easy readable header card creation.
Author:
nir

  • Method Details

    • card

      public HeaderCard card()
      get the current build card of the builder.
      Returns:
      the current card

    • card

      public HeaderCardBuilder card(IFitsHeader newKey)
      switch focus to the card with the specified key. If the card does not exist the card will be created when the value or the comment is set.
      Parameters:
      newKey - the new card to set
      Returns:
      this

    • comment

      public HeaderCardBuilder comment(String newComment) throws HeaderCardException
      set the comment of the current card. If the card does not exist yet the card is created with a null value, if the card needs a value use the value setter first!
      Parameters:
      newComment - the new comment to set.
      Returns:
      this
      Throws:
      HeaderCardException - if the card creation failed.

    • value

      public HeaderCardBuilder value(boolean newValue) throws HeaderCardException
      set the value of the current card.If the card did not exist yet the card will be created.
      Parameters:
      newValue - the new value to set.
      Returns:
      this
      Throws:
      HeaderCardException - if the card creation failed.

    • value

      public HeaderCardBuilder value(Date newValue) throws HeaderCardException
      set the value of the current card. If the card did not exist yet the card will be created.
      Parameters:
      newValue - the new value to set.
      Returns:
      this
      Throws:
      HeaderCardException - if the card creation failed.

    • value

      public HeaderCardBuilder value(Number value) throws HeaderCardException, LongValueException
      Sets a new number value for the current card. If the card did not exist yet the card will be created.
      Parameters:
      value - the new number value to set.
      Returns:
      this
      Throws:
      HeaderCardException - if the card creation failed.
      LongValueException - if the number value cannot be represented in the space available for it in the 80-character wide FITS header record.

    • value

      public HeaderCardBuilder value(String newValue) throws HeaderCardException, LongValueException
      set the value of the current card.If the card did not exist yet the card will be created.
      Parameters:
      newValue - the new value to set.
      Returns:
      this
      Throws:
      HeaderCardException - if the card creation failed.
      LongValueException - if the number value cannot be represented in the space available for it in the 80-character wide FITS header record.

    • scale

      @Deprecated public HeaderCardBuilder scale(int decimals)
      Deprecated.
      Use precision(int) instead.
      Sets the number of decimals to show for the following decimal values. This method is now deprecated. Use precision(int) instead.
      Parameters:
      decimals - the new number of decimal places to show.
      Returns:
      this

    • precision

      public HeaderCardBuilder precision(int decimals)
      Sets the number of decimals to show for the following decimal values. Trailing zeroes will be ommitted.
      Parameters:
      decimals - the number of decimals to show for the following decimal values.
      Returns:
      this
      Since:
      1.16

    • noScale

      @Deprecated public HeaderCardBuilder noScale()
      Deprecated.
      Use autoPrecision() instead
      This method has been deprecated. Please use autoPrecision() instead.
      Returns:
      this

    • autoPrecision

      public HeaderCardBuilder autoPrecision()
      Use the native precision for the given number type. Trailing zeroes will be ommitted.
      Returns:
      this
      Since:
      1.16

    • header

      public Header header()
      Returns the FITS header object that this builder is used with
      Returns:
      the filled header.