com.cisco.provisioning.cpe
Class DataType

java.lang.Object
  com.cisco.provisioning.cpe.internal.BaseEnum
      com.cisco.provisioning.cpe.DataType

All Implemented Interfaces:

Externalizable, Serializable, Comparable

public final class DataType
extends com.cisco.provisioning.cpe.internal.BaseEnum

The DataType class provides an enumeration of DataTypes which may be specified as part of the Configuration.addCustomPropertyDefinition(String, DataType) method.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.cisco.provisioning.cpe.internal.BaseEnum

com.cisco.provisioning.cpe.internal.BaseEnum.CompareDifferentClassEnumException

Field Summary

static DataType	BOOLEAN References an object of type Boolean.
static DataType	BYTE References an object of type Byte.
static DataType	BYTE_ARRAY References an object of type byte[].
static DataType	CHARACTER References an object of type Character.
static DataType	DOUBLE References an object of type Double.
static DataType	FLOAT References an object of type Float.
static DataType	INTEGER References an object of type Integer.
static DataType	LEASE_RESULTS References an object of type LeaseResults.
static DataType	LIST References an object of type List.
static DataType	LONG References an object of type Long.
static DataType	MAP References an object of type Map.
static DataType	RECORD_SEARCH_RESULTS References an object of type RecordSearchResults.
static DataType	SHORT References an object of type Short.
static DataType	SNMPVAR_LIST References an object of type SnmpVarList.
static DataType	STRING References an object of type String.
static DataType	UNICODE_STRING References an object of type String.

Fields inherited from class com.cisco.provisioning.cpe.internal.BaseEnum

NAME, VALUE

Constructor Summary

DataType()
Default constructor needed for externalization.

Method Summary

Class<?>	getAssociatedClass() Return the class associated with this data type.
static DataType	getNamed(String name) Returns the DataType object with the selected name (or null if it does not exist).
static SortedSet	getSortedSet() Return a sorted set of the enumeration codes associated with the enumeration type defined in this class.
static DataType	getValued(int value) Returns the DataType object with the selected value (or null if it does not exist).
boolean	isCustomPropertyDataType() Returns true if this data type can be used as part of the Configuration.addCustomPropertyDefinition(String, DataType) method.
static Iterator	iterator() Return an iterator over the enumeration codes associated with the enumeration type defined in this class.
static int	maxVal() Return the maximum ordinal value in this enumeration, or -1 if no enumeration codes are defined.
void	readExternal(ObjectInput in) Externalizable interface.
static int	size() Return an integer giving the total number of enumeration codes associated with this enumeration type.
void	writeExternal(ObjectOutput out) Externalizable interface.

Methods inherited from class com.cisco.provisioning.cpe.internal.BaseEnum

compareNames, compareTo, compareValues, getName, getSortByNameComparator, getValue, toString, toStringWithValue

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BOOLEAN

public static final DataType BOOLEAN

References an object of type Boolean.

CHARACTER

public static final DataType CHARACTER

References an object of type Character.

BYTE

public static final DataType BYTE

References an object of type Byte.

SHORT

public static final DataType SHORT

References an object of type Short.

INTEGER

public static final DataType INTEGER

References an object of type Integer.

LONG

public static final DataType LONG

References an object of type Long.

FLOAT

public static final DataType FLOAT

References an object of type Float.

DOUBLE

public static final DataType DOUBLE

References an object of type Double.

STRING

public static final DataType STRING

References an object of type String.

LIST

public static final DataType LIST

References an object of type List.

MAP

public static final DataType MAP

References an object of type Map.

BYTE_ARRAY

public static final DataType BYTE_ARRAY

References an object of type byte[].

UNICODE_STRING

public static final DataType UNICODE_STRING

References an object of type String.

LEASE_RESULTS

public static final DataType LEASE_RESULTS

References an object of type LeaseResults.

SNMPVAR_LIST

public static final DataType SNMPVAR_LIST

References an object of type SnmpVarList.

RECORD_SEARCH_RESULTS

public static final DataType RECORD_SEARCH_RESULTS

References an object of type RecordSearchResults.

Constructor Detail

DataType

public DataType()

Default constructor needed for externalization.

Note : This constructor is ONLY used for externalization. Use the defined constants instead.

Method Detail

getNamed

public static DataType getNamed(String name)

Returns the DataType object with the selected name (or null if it does not exist).

Note : This method is for internal use only. Please use the constants defined on this class to retrieve the desired DataType object.

Parameters:

name - the name associated with the desired instance of DataType

Returns:

the DataType object with the selected name (or null if it does not exist).

getSortedSet

public static SortedSet getSortedSet()

Return a sorted set of the enumeration codes associated with the enumeration type defined in this class.

The set returned does not support modifications. Set methods would modify the set will throw an UnsupportedOperationException.

Note : This method is for internal use only. Please use the constants defined on this class to retrieve the desired object.

Returns:

a sorted set of the enumeration codes.

getValued

public static DataType getValued(int value)

Returns the DataType object with the selected value (or null if it does not exist).

Note : This method is for internal use only. Please use the constants defined on this class to retrieve the desired DataType object.

Parameters:

value - the value associated with the desired instance of DataType

Returns:

the DataType object with the selected value (or null if it does not exist).

iterator

public static Iterator iterator()

Return an iterator over the enumeration codes associated with the enumeration type defined in this class.

The iterator returned does not support modifications. The remove method will throw an UnsupportedOperationException.

Note : This method is for internal use only. Please use the constants defined on this class to retrieve the desired object.

Returns:

an iterator over the enumeration codes.

maxVal

public static int maxVal()

Return the maximum ordinal value in this enumeration, or -1 if no enumeration codes are defined.

Note : This method is for internal use only. Please use the constants defined on this class to retrieve the desired object.

Returns:

the maximum ordinal value.

size

public static int size()

Return an integer giving the total number of enumeration codes associated with this enumeration type.

Note : This method is for internal use only. Please use the constants defined on this class to retrieve the desired object.

Returns:

the total number of enumeration codes.

isCustomPropertyDataType

public boolean isCustomPropertyDataType()

Returns true if this data type can be used as part of the Configuration.addCustomPropertyDefinition(String, DataType) method. Otherwise returns false.

Returns:

true if this data type can be used as the data type for a custom property. Otherwise returns false.

getAssociatedClass

public Class<?> getAssociatedClass()

Return the class associated with this data type.

Returns:

the class associated with this data type.

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Externalizable interface. The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal.

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class com.cisco.provisioning.cpe.internal.BaseEnum

Parameters:

in - the stream to read data from in order to restore the object

Throws:

IOException - if I/O errors occur

ClassNotFoundException - If the class for an object being restored cannot be found.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Externalizable interface. The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class com.cisco.provisioning.cpe.internal.BaseEnum

Parameters:

out - the stream to write the object to

Throws:

IOException - Includes any I/O exceptions that may occur