Class TermporalAmountValue<TYPE>

java.lang.Object
com.iizix.value.TermporalAmountValue<TYPE>
All Implemented Interfaces:
IValueObject<TYPE>
Direct Known Subclasses:
DurationValue, PeriodValue, XMLDurationValue

public abstract class TermporalAmountValue<TYPE> extends Object implements IValueObject<TYPE>
TemporalAmountValue object base class, i.e. duration and period values.
Author:
Christopher Mindus
  • Constructor Details

    • TermporalAmountValue

      public TermporalAmountValue()
  • Method Details

    • parse

      public final TYPE parse(String value, String pattern, LocaleInfo localeInfo) throws ParseException, Exception
      Creates a Value object from a String using a specified pattern and locale.
      Specified by:
      parse in interface IValueObject<TYPE>
      Parameters:
      value - The value, never null.
      pattern - The pattern, null for none.
      localeInfo - The locale info, null for default.
      Returns:
      The value object, never null.
      Throws:
      ParseException - If the value could not be parsed.
      IllegalAccessException - For pattern errors.
      IllegalArgumentException - For pattern errors.
      Exception - For other errors.
    • getFormatter

      public final Format getFormatter(String pattern, LocaleInfo localeInfo) throws IllegalArgumentException
      Returns the Formatter for a pattern.
      Specified by:
      getFormatter in interface IValueObject<TYPE>
      Parameters:
      pattern - The pattern to use, null for none.
      localeInfo - The locale information instance, or null for none.
      Returns:
      The formatter to use, or null for none.
      Throws:
      IllegalArgumentException - If the pattern is wrong.
    • toString

      public final String toString(TYPE value)
      The default "toString" representation.
      Specified by:
      toString in interface IValueObject<TYPE>
      Parameters:
      value - The value could be null.
      Returns:
      The String representation.
    • toString

      public final String toString(TYPE value, String pattern, LocaleInfo localeInfo) throws IllegalArgumentException
      Formats the value to a String.
      Specified by:
      toString in interface IValueObject<TYPE>
      Parameters:
      value - The value is never null.
      pattern - Pattern to use, null for none.
      localeInfo - The locale information instance, or null for none.
      Returns:
      The String representation using specified pattern and locale information.
      Throws:
      IllegalArgumentException - If the pattern is wrong.
    • load

      public final TYPE load(String value, Element element) throws Exception
      Loads the value from an Element.
      Specified by:
      load in interface IValueObject<TYPE>
      Parameters:
      value - The String value in the element.
      element - The element holding the information for advanced processing using JAXB.
      Throws:
      Exception - An exception due to parsing, bean unmarshalling, etc.
    • save

      public final String save(TYPE value, Element element) throws Exception
      Saves the value to an Element.
      Specified by:
      save in interface IValueObject<TYPE>
      Parameters:
      value - The value to save.
      element - The element to save information into for advanced processing using JAXB.
      Returns:
      The String value to set in the Element, or null if advanced processing is used.
      Throws:
      Exception