public class TabularType extends OpenType<TabularData>
TabularType class is the open type class
whose instances describe the types of TabularData values.ALLOWED_CLASSNAMES, ALLOWED_CLASSNAMES_LIST| Constructor and Description |
|---|
TabularType(String typeName,
String description,
CompositeType rowType,
String[] indexNames)
Constructs a
TabularType instance, checking for the validity of the given parameters. |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj)
Compares the specified
obj parameter with this TabularType instance for equality. |
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. |
CompositeType |
getRowType()
Returns the type of the row elements of tabular data values
described by this
TabularType instance. |
int |
hashCode()
Returns the hash code value for this
TabularType instance. |
boolean |
isValue(Object obj)
Tests whether obj is a value which could be
described by this
TabularType instance. |
String |
toString()
Returns a string representation of this
TabularType instance. |
getClassName, getDescription, getTypeName, isArraypublic TabularType(String typeName, String description, CompositeType rowType, String[] indexNames) throws OpenDataException
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().
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 get and
remove of class
TabularData to match their array of values parameter to items.
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.public CompositeType getRowType()
TabularType instance.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 boolean isValue(Object obj)
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.
isValue in class OpenType<TabularData>obj - the value whose open type is to be tested for
compatibility with this TabularType instance.true if obj is a value for this
tabular type, false otherwise.public boolean equals(Object obj)
obj parameter with this TabularType instance for equality.
Two TabularType instances are equal if and only if all of the following statements are true:
equals in class OpenType<TabularData>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.Object.hashCode(),
HashMappublic int hashCode()
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.
hashCode in class OpenType<TabularData>TabularType instanceObject.equals(java.lang.Object),
System.identityHashCode(java.lang.Object)public String toString()
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.
toString in class OpenType<TabularData>TabularType instance Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2024, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.