Class YearMonthValue

All Implemented Interfaces:
IValueObject<YearMonth>

public class YearMonthValue extends TermporalAccessorValue<YearMonth>
Value object class to handle the YearMonth datatype.
Author:
Christopher Mindus
  • Constructor Details

    • YearMonthValue

      public YearMonthValue()
  • Method Details

    • getValueType

      public final Value.Type getValueType()
      Gets the value type.
      Returns:
      Value.Type.YearMonth.
    • getValueClass

      public Class<YearMonth> getValueClass()
      Gets the class of the value.
    • getDescription

      public String getDescription()
      Gets the description of the type, used for the Designer.
    • createDefault

      public YearMonth createDefault()
      Creates the default value object for the data type.
      Returns:
      The default value.
    • parse

      public YearMonth parse(String value) throws ParseException, Exception
      Creates a Value object from a String using a specified pattern and locale.
      Parameters:
      value - The value, never null.
      Returns:
      The value object, never null.
      Throws:
      ParseException - If the value could not be parsed.
      Exception - For other errors.
    • parse

      public YearMonth parse(String value, DateTimeFormatter formatter) throws ParseException, Exception
      Creates a Value object from a String using a specified pattern and locale.
      Specified by:
      parse in class TermporalAccessorValue<YearMonth>
      Parameters:
      value - The value, never null.
      formatter - The formatter, never null.
      Returns:
      The value object, never null.
      Throws:
      ParseException - If the value could not be parsed.
      Exception - For other errors.
    • convert

      public YearMonth convert(Object value, Value.Type oldType, LocaleInfo localeInfo) throws Exception
      Converts a value from another type. If the type is not defined, check the object instance for possible conversions.
      Parameters:
      value - The value to convert.
      oldType - The old type, null for not defined.
      localeInfo - The locale information, null to look-up from current thread or if not found, for system default.
      Returns:
      The value object.
      Throws:
      Exception - For other errors.
    • asLong

      public long asLong(YearMonth value, LocaleInfo localeInfo)
      Returns a long value if possible.
      Parameters:
      value - The Value object.
      localeInfo - The locale information, null to look-up from current thread or if not found, for system default.
      Returns:
      The long value, e.g. in milliseconds, or Long.MIN_VALUE for not possible.