org.xins.common.types.standard

Class XML

java.lang.Object

org.xins.common.types.Type

org.xins.common.types.standard.XML

Direct Known Subclasses:

XMLType

public class XML
extends Type

Standard type _xml. A value of this type represents an XML fragment.

Since:

XINS 2.2

Version:

$Revision: 1.5 $ $Date: 2012/03/03 21:23:44 $

Author:

Ernst de Haan

Field Summary

Fields

Modifier and Type	Field and Description
static XML	SINGLETON The only instance of this class.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XML(String name) Constructs a new XML instance.

Method Summary

Methods

Modifier and Type	Method and Description
static Element	fromStringForOptional(String string) Constructs an Element from the specified string.
static Element	fromStringForRequired(String string) Constructs an Element from the specified non-null string.
protected Object	fromStringImpl(String string) Converts from a String to an instance of the value class for this type (implementation method).
String	getDescription() Retrieves the description of this type.
protected boolean	isValidValueImpl(String value) Determines if the specified String value is considered valid for this type (implementation method).
static String	toString(Element element) Converts the specified Element 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 XML SINGLETON

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

Constructor Detail

XML

protected XML(String name)

Constructs a new XML instance. This constructor is protected to be used by XMLType.

Method Detail

fromStringForRequired

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

Constructs an Element from the specified non-null string.

Parameters:

string - the string to convert, cannot be null.

Returns:

the Element object, never null.

Throws:

IllegalArgumentException - if string == null.

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

fromStringForOptional

public static Element fromStringForOptional(String string)
                                     throws TypeValueException

Constructs an Element from the specified string.

Parameters:

string - the string to convert, can be null.

Returns:

the Element, or null if string == null.

Throws:

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

isValidValueImpl

protected boolean isValidValueImpl(String value)

Description copied from class: Type

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.

The implementation of this method in class Type returns true.

Overrides:

isValidValueImpl in class Type

Parameters:

value - 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 final Object fromStringImpl(String string)
                               throws TypeValueException

Description copied from class: Type

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 Type.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 Type.isValidValueImpl(String) without getting an exception.

Returns:

an instance of the value class, cannot be null.

Throws:

TypeValueException - if string is considered to be an invalid value for this type.

toString

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

Description copied from class: Type

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.

The default implementation of this method in class Type does the following:

• if value == null then it throws an IllegalArgumentException;
• if getValueClass().isInstance(value) == false then it throws a ClassCastException;
• otherwise it returns value.Object.toString().

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.

toString

public static String toString(Element element)

Converts the specified Element to a string.

Parameters:

element - the XML fragment to convert, can be null.

Returns:

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

getDescription

public String getDescription()

Description copied from class: Type

Retrieves the description of this type.

Overrides:

getDescription in class Type

Returns:

the description of this type, never null.