org.xins.common.types.standard
Class Boolean

java.lang.Object
  org.xins.common.types.Type
      org.xins.common.types.standard.Boolean

public final class Boolean

extends Type

Standard type _boolean.

Since:

XINS 1.0.0

Version:

$Revision: 1.13 $ $Date: 2006/08/28 09:12:33 $

Author:

Ernst de Haan

Field Summary

static Boolean

SINGLETON The only instance of this class.

Method Summary

static Boolean	fromStringForOptional(String string) Converts the specified string value to a java.lang.Boolean value.
static boolean	fromStringForRequired(String string) Converts the specified non-null string value to a boolean.
protected Object	fromStringImpl(String string) Converts from a String to an instance of the value class for this type (implementation method).
protected boolean	isValidValueImpl(String string) Determines if the specified String value is considered valid for this type (implementation method).
static String	toString(boolean value) Converts the specified boolean to a string.
static String	toString(Boolean value) Converts the specified Boolean to a string.
String	toString(Object value) Generates a string representation of the specified value for this type.

Methods inherited from class org.xins.common.types.Type

checkValue, fromString, getName, getValueClass, isValidValue, toString

Methods inherited from class java.lang.Object

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

Field Detail

SINGLETON

public static final Boolean SINGLETON

The only instance of this class. This field is never null.

Method Detail

fromStringForRequired

public static boolean fromStringForRequired(String string)
                                     throws IllegalArgumentException,
                                            TypeValueException

Converts the specified non-null string value to a boolean.

Parameters:

string - the string to convert, cannot be null.

Returns:

the boolean value.

Throws:

IllegalArgumentException - if string == null.

TypeValueException - if the specified string does not represent a valid value for this type.

fromStringForOptional

public static Boolean fromStringForOptional(String string)
                                     throws TypeValueException

Converts the specified string value to a java.lang.Boolean value.

Parameters:

string - the string to convert, can be null.

Returns:

the Boolean, or null if string == null.

Throws:

TypeValueException - if the specified string does not represent a valid value for this type.

toString

public static String toString(Boolean value)

Converts the specified Boolean to a string.

Parameters:

value - the value to convert, can be null.

Returns:

the textual representation of the value, or null if and only if value == null.

toString

public static String toString(boolean value)

Converts the specified boolean to a string.

Parameters:

value - the value to convert.

Returns:

the textual representation of the value, never null.

isValidValueImpl

protected boolean isValidValueImpl(String string)

Determines if the specified String value is considered valid for this type (implementation method).

This method is called from Type.isValidValue(String). When called from that method, it is guaranteed that the argument is not null.

Overrides:

isValidValueImpl in class Type

Parameters:

string - the String value that should be checked for validity, never null.

Returns:

true if and only if the specified String value is valid, false otherwise.

fromStringImpl

protected Object fromStringImpl(String string)

Converts from a String to an instance of the value class for this type (implementation method).

This method is not required to check the validity of the specified value (since isValidValueImpl(String) should have been called before) but if it does, then it may throw a TypeValueException.

Specified by:

fromStringImpl in class Type

Parameters:

string - the string to convert to an instance of the value class, guaranteed to be not null and guaranteed to have been passed to isValidValueImpl(String) without getting an exception.

Returns:

an instance of the value class, cannot be null.

toString

public String toString(Object value)
                throws IllegalArgumentException,
                       ClassCastException,
                       TypeValueException

Generates a string representation of the specified value for this type. The specified value must be an instance of the value class for this type (see Type.getValueClass()). Also, it may have to fall within a certain range of valid values, depending on the type.

Overrides:

toString in class Type

Parameters:

value - the value, cannot be null.

Returns:

the string representation of the specified value for this type, cannot be null.

Throws:

IllegalArgumentException - if value == null.

ClassCastException - if getValueClass().isInstance(value) == false.

TypeValueException - if the specified value is not in the allowed range.