TabularType JDK 1.6)

Constructors

public TabularType (String typeName, String description, CompositeType rowType, String indexNames) throws OpenDataException

Constructs a TabularType instance, checking for the validity of the given parameters.

Constructs a TabularType instance, checking for the validity of the given parameters. The validity constraints are described below for each parameter.

The Java class name of tabular data values this tabular type represents (ie the class name returned by the getClassName method) is set to the string value returned by TabularData.class.getName().

Parameters:
- typeName - The name given to the tabular type this instance represents; cannot be a null or empty string.

- description - The human readable description of the tabular type this instance represents; cannot be a null or empty string.

- rowType - The type of the row elements of tabular data values described by this tabular type instance; cannot be null.

- indexNames - The names of the items the values of which are used to uniquely index each row element in the tabular data values described by this tabular type instance; cannot be null or empty. Each element should be an item name defined in rowType (no null or empty string allowed). It is important to note that the order of the item names in indexNames is used by the methods {@link TabularData#get(java.lang.Object[]) get} and {@link TabularData#remove(java.lang.Object[]) remove} of class TabularData to match their array of values parameter to items.

Throws:
- IllegalArgumentException - if rowType is null, or indexNames is a null or empty array, or an element in indexNames is a null or empty string, or typeName or description is a null or empty string.

- OpenDataException - if an element's value of indexNames is not an item name defined in rowType.

Methods

Hide/Show inherited methods

public boolean equals (Object obj) [Specified in OpenType]

Compares the specified obj parameter with this TabularType instance for equality.

Two TabularType instances are equal if and only if all of the following statements are true:

their type names are equal
their row types are equal
they use the same index names, in the same order

Returns: true if the specified object is equal to this TabularType instance.
Parameters:
- obj - the object to be compared for equality with this TabularType instance; if obj is null, equals returns false.

public String getClassName () [Inherited From OpenType]

Returns the fully qualified Java class name of the open data values this open type describes.

Returns the fully qualified Java class name of the open data values
this open type describes.
The only possible Java class names for open data values are listed in
ALLOWED_CLASSNAMES_LIST.
A multidimensional array of any one of these classes or their
corresponding primitive types is also an allowed class,
in which case the class name follows the rules defined by the method
getName() of java.lang.Class.
For example, a 3-dimensional array of Strings has for class name
"[[[Ljava.lang.String;" (without the quotes),
a 3-dimensional array of Integers has for class name
"[[[Ljava.lang.Integer;" (without the quotes),
and a 3-dimensional array of int has for class name
"[[[I" (without the quotes)
Returns: the class name.

public String getDescription () [Inherited From OpenType]

Returns the text description of this OpenType instance.

Returns the text description of this OpenType instance.
Returns: the description.

pack-privatesynchronized Descriptor getDescriptor () [Inherited From OpenType]

public List<String> getIndexNames ()

Returns, in the same order as was given to this instance's constructor, an unmodifiable List of the names of the items the values of which are used to uniquely index each row element of tabular data values described by this TabularType instance.

public CompositeType getRowType ()

Returns the type of the row elements of tabular data values described by this TabularType instance.

Returns the type of the row elements of tabular data values
described by this TabularType instance.
Returns: the type of each row.

public String getTypeName () [Inherited From OpenType]

Returns the name of this OpenType instance.

Returns the name of this OpenType instance.
Returns: the type name.

public int hashCode () [Specified in OpenType]

Returns the hash code value for this TabularType instance.

The hash code of a TabularType instance is the sum of the hash codes of all elements of information used in equals comparisons (ie: name, row type, index names). This ensures that t1.equals(t2) implies that t1.hashCode()==t2.hashCode() for any two TabularType instances t1 and t2, as required by the general contract of the method Object.hashCode().

As TabularType instances are immutable, the hash code for this instance is calculated once, on the first call to hashCode, and then the same value is returned for subsequent calls.
Returns: the hash code value for this TabularType instance

public boolean isArray () [Inherited From OpenType]

Returns true if the open data values this open type describes are arrays, false otherwise.

Returns true if the open data values this open
type describes are arrays, false otherwise.
Returns: true if this is an array type.

@Override

pack-private boolean isAssignableFrom (OpenType ot)

pack-private boolean isAssignableFrom (OpenType<Object> ot) [Inherited From OpenType]

Tests whether values of the given type can be assigned to this open type.

public boolean isValue (Object obj) [Specified in OpenType]

Tests whether obj is a value which could be described by this TabularType instance.

If obj is null or is not an instance of javax.management.openmbean.TabularData, isValue returns false.

If obj is an instance of javax.management.openmbean.TabularData, say td, the result is true if this TabularType is assignable from td.getTabularType(), as defined in CompositeType.isValue.

Returns: true if obj is a value for this tabular type, false otherwise.
Parameters:
- obj - the value whose open type is to be tested for compatibility with this TabularType instance.

public String toString () [Specified in OpenType]

Returns a string representation of this TabularType instance.

The string representation consists of the name of this class (ie javax.management.openmbean.TabularType), the type name for this instance, the row type string representation of this instance, and the index names of this instance.

As TabularType instances are immutable, the string representation for this instance is calculated once, on the first call to toString, and then the same value is returned for subsequent calls.
Returns: a string representation of this TabularType instance