com.iizix.value

Class BooleanValue

java.lang.Object

com.iizix.value.BooleanValue

All Implemented Interfaces:

IValueObject<Boolean>

public class BooleanValue
extends Object
implements IValueObject<Boolean>

Value object class to handle the Boolean 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
BooleanValue()

Method Summary

Modifier and Type	Method and Description
long	asLong(Boolean value, LocaleInfo localeInfo) Returns a long value if possible.
Boolean	convert(Object value, Value.Type oldType, LocaleInfo localeInfo) Converts a value from another type.
Boolean	createDefault() Creates the default value object for the data type.
String	getDescription() Gets the description of the type, used for the Designer.
Format	getFormatter(String pattern, LocaleInfo localeInfo) Returns the Formatter for a pattern.
Class<Boolean>	getValueClass() Gets the class of the value.
Value.Type	getValueType() Gets the value type.
Boolean	load(String value, Element element) Loads the value from an Element.
Boolean	parse(String value) Creates a Value object from a String using a specified pattern and locale.
Boolean	parse(String value, String pattern, LocaleInfo localeInfo) Creates a Value object from a String using a specified pattern and locale.
String	save(Boolean value, Element element) Saves the value to an Element.
String	toString(Boolean value) The default "toString" representation.
String	toString(Boolean value, String pattern, LocaleInfo localeInfo) Formats the value to a String.

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

BooleanValue

public BooleanValue()

Method Detail

getValueType

public final Value.Type getValueType()

Gets the value type.

Specified by:

getValueType in interface IValueObject<Boolean>

Returns:

Value.Type.Boolean.

getValueClass

public Class<Boolean> getValueClass()

Gets the class of the value.

Specified by:

getValueClass in interface IValueObject<Boolean>

getDescription

public String getDescription()

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

Specified by:

getDescription in interface IValueObject<Boolean>

createDefault

public Boolean createDefault()

Creates the default value object for the data type.

Specified by:

createDefault in interface IValueObject<Boolean>

Returns:

The default value.

parse

public Boolean parse(String value)

Creates a Value object from a String using a specified pattern and locale.

Specified by:

parse in interface IValueObject<Boolean>

Parameters:

value - The value, never null.

Returns:

The value object, never null.

parse

public Boolean parse(String value,
                     String pattern,
                     LocaleInfo localeInfo)
              throws ParseException

Creates a Value object from a String using a specified pattern and locale.

Specified by:

parse in interface IValueObject<Boolean>

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 - For parser errors.

getFormatter

public Format getFormatter(String pattern,
                           LocaleInfo localeInfo)
                    throws IllegalArgumentException

Returns the Formatter for a pattern.

Specified by:

getFormatter in interface IValueObject<Boolean>

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 - For formatter errors.

toString

public String toString(Boolean value)

The default "toString" representation.

Specified by:

toString in interface IValueObject<Boolean>

Parameters:

value - The value could be null.

Returns:

The String representation.

toString

public String toString(Boolean value,
                       String pattern,
                       LocaleInfo localeInfo)

Formats the value to a String.

Specified by:

toString in interface IValueObject<Boolean>

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.

load

public Boolean load(String value,
                    Element element)
             throws Exception

Loads the value from an Element.

Specified by:

load in interface IValueObject<Boolean>

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 String save(Boolean value,
                   Element element)
            throws Exception

Saves the value to an Element.

Specified by:

save in interface IValueObject<Boolean>

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

convert

public Boolean 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.

Specified by:

convert in interface IValueObject<Boolean>

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.

ParseException - If this conversion fails.

asLong

public long asLong(Boolean value,
                   LocaleInfo localeInfo)

Returns a long value if possible.

Specified by:

asLong in interface IValueObject<Boolean>

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.