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.
  • Field Details

    • card

      private HeaderCard card
      the current card to fill.
    • key

      private IFitsHeader key
      the current selected key.
    • scale

      private int scale
      scale to use for decimal values.
  • Constructor Details

    • HeaderCardBuilder

      protected HeaderCardBuilder(Header header, IFitsHeader key)
      constructor to the header card builder.
      Parameters:
      header - the header to fill.
      key - the first header card to set.
  • 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(double 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(BigDecimal 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(float 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(int 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(long 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(String 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.
    • scale

      public HeaderCardBuilder scale(int newScale)
      set the scale for the following decimal values.
      Parameters:
      newScale - the new scale to use
      Returns:
      this
    • noScale

      public HeaderCardBuilder noScale()
      use no scale for the following decimal values.
      Returns:
      this
    • header

      public Header header()
      Returns:
      the filled header.