com.iizix.value

Class PeriodValue

java.lang.Object

com.iizix.value.TermporalAmountValue<Period>

com.iizix.value.PeriodValue

All Implemented Interfaces:

IValueObject<Period>

public class PeriodValue
extends TermporalAmountValue<Period>

Value object class to handle the Period datatype.

Author:

Christopher Mindus

Field Summary

Fields inherited from interface com.iizix.value.IValueObject

PATTERN_BASIC_ISO_DATE, PATTERN_CURRENCY, PATTERN_FULL, PATTERN_INTEGER, PATTERN_ISO_DATE, PATTERN_ISO_DATE_TIME, PATTERN_ISO_INSTANT, PATTERN_ISO_LOCAL_DATE, PATTERN_ISO_LOCAL_DATE_TIME, PATTERN_ISO_LOCAL_TIME, PATTERN_ISO_OFFSET_DATE, PATTERN_ISO_OFFSET_DATE_TIME, PATTERN_ISO_OFFSET_TIME, PATTERN_ISO_ORDINAL_DATE, PATTERN_ISO_TIME, PATTERN_ISO_WEEK_DATE, PATTERN_ISO_ZONED_DATE_TIME, PATTERN_LONG, PATTERN_MEDIUM, PATTERN_PERCENT, PATTERN_RFC_1123_DATE_TIME, PATTERN_SHORT, RESOLVER_LENIENT, RESOLVER_LENIENT_NO_BRACKETS, RESOLVER_SMART, RESOLVER_SMART_NO_BRACKETS, RESOLVER_STRICT, RESOLVER_STRICT_NO_BRACKETS

Constructor Summary

Constructors

Constructor and Description
PeriodValue()

Method Summary

Modifier and Type	Method and Description
long	asLong(Period value, LocaleInfo localeInfo) Returns a long value if possible.
Period	convert(Object value, Value.Type oldType, LocaleInfo localeInfo) Converts a value from another type.
Period	createDefault() Creates the default value object for the data type.
static Period	fromEpochMillis(long millis) Helper method to create a Period of milliseconds since the Epoch (1970-01-01 00:00:00 GMT+0:00).
String	getDescription() Gets the description of the type, used for the Designer.
Class<Period>	getValueClass() Gets the class of the value.
Value.Type	getValueType() Gets the value type.
Period	parse(String value) Creates a Value object from a String using a specified pattern and locale.

Methods inherited from class com.iizix.value.TermporalAmountValue

getFormatter, load, parse, save, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.iizix.value.IValueObject

asLongCast, isRightAligned, saveCast, toStringCast, toStringForced

Constructor Detail

PeriodValue

public PeriodValue()

Method Detail

getValueType

public final Value.Type getValueType()

Gets the value type.

Returns:

Value.Type.Period.

fromEpochMillis

public static Period fromEpochMillis(long millis)

Helper method to create a Period of milliseconds since the Epoch (1970-01-01 00:00:00 GMT+0:00).

Returns:

A Period that truncates the time part.

getValueClass

public Class<Period> getValueClass()

Gets the class of the value.

getDescription

public String getDescription()

Gets the description of the type, used for the Designer.

createDefault

public Period createDefault()

Creates the default value object for the data type.

Returns:

The default value.

parse

public Period parse(String value)
             throws ParseException,
                    IllegalAccessException,
                    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.

IllegalArgumentException - For pattern errors.

Exception - For other errors.

IllegalAccessException

convert

public Period 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(Period 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.