| java.lang.Object
 javax.management.openmbean.OpenType
javax.management.openmbean.TabularType
| Constructor Summary | |
| public | TabularType(String typeName, String description, CompositeType rowType, String[] indexNames)
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
OpenType.getClassName getClassName method)
is set to the string value returned by TabularData.class.getNameSpace().
Parameters:
typeName - The name given to the tabular type this instance represents; cannot be a null or empty string.
Parameters:
description - The human readable description of the tabular type this instance represents;cannot be a null or empty string.
Parameters:
rowType - The type of the row elements of tabular data values described by this tabular type instance;cannot be null.
Parameters:
indexNames - The names of the items the values of which are used to uniquely index each row element in thetabular data values described by this tabular type instance;cannot be null or empty. |
| Method Summary | |
| public boolean | equals(Object obj)
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
Parameters:
obj - the object to be compared for equality with this TabularType instance;if obj is null, equals returns false. | | public List | getIndexNames()
| | public CompositeType | getRowType()
Returns the type of the row elements of tabular data values
described by this TabularType instance. | | public int | hashCode()
Returns the hash code value for this TabularType instance. | | public boolean | isValue(Object obj)
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,
its tabular type is tested for equality with this tabular type instance, and isValue
returns true if and only if
TabularType.equals(java.lang.Object) equals returns true.
Parameters:
obj - the value whose open type is to be tested for equality with this TabularType instance. | | public String | toString()
Returns a string representation of this TabularType instance. |
| TabularType | | public TabularType(String typeName, String description, CompositeType rowType, String[] indexNames) throws OpenDataException(Code) | | 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
OpenType.getClassName getClassName method)
is set to the string value returned by TabularData.class.getNameSpace().
Parameters:
typeName - The name given to the tabular type this instance represents; cannot be a null or empty string.
Parameters:
description - The human readable description of the tabular type this instance represents;cannot be a null or empty string.
Parameters:
rowType - The type of the row elements of tabular data values described by this tabular type instance;cannot be null.
Parameters:
indexNames - The names of the items the values of which are used to uniquely index each row element in thetabular 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 indexNamesis used by the methods TabularData.get(java.lang.Object[]) get andTabularData.remove(java.lang.Object[]) remove of classTabularData 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.
throws:
OpenDataException - if an element's value of indexNamesis not an item name defined in rowType. |
| equals | | public boolean equals(Object obj)(Code) | | 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
Parameters:
obj - the object to be compared for equality with this TabularType instance;if obj is null, equals returns false. true if the specified object is equal to this TabularType instance. |
| getIndexNames | | public List getIndexNames()(Code) | | 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.
a List of String representing the names of the indexitems. |
| getRowType | | public CompositeType getRowType()(Code) | | Returns the type of the row elements of tabular data values
described by this TabularType instance.
the type of each row. |
| hashCode | | public int hashCode()(Code) | | 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.
the hash code value for this TabularType instance |
| isValue | | public boolean isValue(Object obj)(Code) | | 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,
its tabular type is tested for equality with this tabular type instance, and isValue
returns true if and only if
TabularType.equals(java.lang.Object) equals returns true.
Parameters:
obj - the value whose open type is to be tested for equality with this TabularType instance. true if obj is a value for this tabular type, false otherwise. |
| toString | | public String toString()(Code) | | 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.
a string representation of this TabularType instance |
|
|