org.xins.common.types.standard
Class Int32

java.lang.Object
  extended byorg.xins.common.types.Type
      extended byorg.xins.common.types.standard.Int32

public class Int32
extends Type

Standard type _int32.

Since:
XINS 1.0.0
Version:
$Revision: 1.12 $ $Date: 2006/08/28 09:12:33 $
Author:
Ernst de Haan

Field Summary
static Int32 SINGLETON
          The only instance of this class.
 
Constructor Summary
protected Int32(String name, int minimum, int maximum)
          Constructs a new Int32 object (constructor for subclasses).
 
Method Summary
static Integer fromStringForOptional(String string)
          Converts the specified string value to an Integer value.
static int fromStringForRequired(String string)
          Converts the specified non-null string value to an int.
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 value)
          Determines if the specified String value is considered valid for this type (implementation method).
static String toString(int value)
          Converts the specified int to a string.
static String toString(Integer value)
          Converts the specified Integer 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 Int32 SINGLETON
The only instance of this class. This field is never null.

Constructor Detail

Int32

protected Int32(String name,
                int minimum,
                int maximum)
Constructs a new Int32 object (constructor for subclasses).

Parameters:
name - the name of this type, cannot be null.
minimum - the minimum for the value.
maximum - the maximum for the value.
Method Detail

fromStringForRequired

public static int fromStringForRequired(String string)
                                 throws IllegalArgumentException,
                                        TypeValueException
Converts the specified non-null string value to an int.

Parameters:
string - the string to convert, cannot be null.
Returns:
the int value.
Throws:
IllegalArgumentException - if string == null.
TypeValueException - if the specified string does not represent a valid value for this type.

fromStringForOptional

public static Integer fromStringForOptional(String string)
                                     throws TypeValueException
Converts the specified string value to an Integer value.

Parameters:
string - the string to convert, can be null.
Returns:
the Integer, 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(Integer value)
Converts the specified Integer 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(int value)
Converts the specified int to a string.

Parameters:
value - the value to convert.
Returns:
the textual representation of the value, never null.

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 Object fromStringImpl(String string)
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.

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:

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:
ClassCastException - if getValueClass().isInstance(value) == false.
IllegalArgumentException - if value == null.
TypeValueException - if the specified value is not in the allowed range.


See http://www.xins.org/.