Package com.iizix.value

Class YearValue

  • All Implemented Interfaces:
    IValueObject<java.time.Year>
    public class YearValue
extends TermporalAccessorValue<java.time.Year>
    Value object class to handle the Year datatype.
    Author:
    Christopher Mindus

    • Constructor Detail

      • YearValue

        public YearValue()

    • Method Detail

      • getValueType

        public final Value.Type getValueType()
        Gets the value type.
        Returns:
        Value.Type.Year.

      • getValueClass

        public java.lang.Class<java.time.Year> getValueClass()
        Gets the class of the value.

      • getDescription

        public java.lang.String getDescription()
        Gets the description of the type, used for the Designer.

      • createDefault

        public java.time.Year createDefault()
        Creates the default value object for the data type.
        Returns:
        The default value: Year 1970.

      • parse

        public java.time.Year parse​(java.lang.String value)
                     throws java.text.ParseException,
                            java.lang.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:
        java.text.ParseException - If the value could not be parsed.
        java.lang.Exception - For other errors.

      • parse

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

      • convert

        public java.time.Year convert​(java.lang.Object value,
                              Value.Type oldType,
                              LocaleInfo localeInfo)
                       throws java.lang.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:
        java.lang.Exception - For other errors.

      • asLong

        public long asLong​(java.time.Year 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.