| java.lang.Object
 javax.management.openmbean.OpenType
javax.management.openmbean.CompositeType
| Constructor Summary | |
| public | CompositeType(String typeName, String description, String[] itemNames, String[] itemDescriptions, OpenType[] itemTypes)
Constructs a CompositeType instance, checking for the validity of the given parameters. |
| Method Summary | |
| public boolean | containsKey(String itemName)
Returns true if this CompositeType instance defines an item
whose name is itemName.
Parameters:
itemName - the name of the item. | | public boolean | equals(Object obj)
Compares the specified obj parameter with this CompositeType instance for equality.
Two CompositeType instances are equal if and only if all of the following statements are true:
- their type names are equal
- their items' names and types are equal
Parameters:
obj - the object to be compared for equality with this CompositeType instance;if obj is null, equals returns false. | | public String | getDescription(String itemName)
Returns the description of the item whose name is itemName,
or null if this CompositeType instance does not define any item
whose name is itemName.
Parameters:
itemName - the name of the item. | | public OpenType | getType(String itemName)
Returns the open type of the item whose name is itemName,
or null if this CompositeType instance does not define any item
whose name is itemName.
Parameters:
itemName - the name of the time. | | public int | hashCode()
Returns the hash code value for this CompositeType instance. | | public boolean | isValue(Object obj)
Tests whether obj is a value which could be described by this CompositeType instance.
If obj is null or is not an instance of javax.management.openmbean.CompositeData,
isValue returns false.
If obj is an instance of javax.management.openmbean.CompositeData,
its composite type is tested for equality with this CompositeType instance, and isValue
returns true if and only if
CompositeType.equals(java.lang.Object) equals returns true.
Parameters:
obj - the value whose open type is to be tested for equality with this CompositeType instance. | | public Set | keySet()
Returns an unmodifiable Set view of all the item names defined by this CompositeType instance. | | public String | toString()
Returns a string representation of this CompositeType instance. |
| CompositeType | | public CompositeType(String typeName, String description, String[] itemNames, String[] itemDescriptions, OpenType[] itemTypes) throws OpenDataException(Code) | | Constructs a CompositeType instance, checking for the validity of the given parameters.
The validity constraints are described below for each parameter.
Note that the contents of the three array parameters
itemNames, itemDescriptions and itemTypes
are internally copied so that any subsequent modification of these arrays by the caller of this constructor
has no impact on the constructed CompositeType instance.
The Java class name of composite data values this composite type represents
(ie the class name returned by the
OpenType.getClassName getClassName method)
is set to the string value returned by CompositeData.class.getNameSpace().
Parameters:
typeName - The name given to the composite type this instance represents; cannot be a null or empty string.
Parameters:
description - The human readable description of the composite type this instance represents;cannot be a null or empty string.
Parameters:
itemNames - The names of the items contained in thecomposite data values described by this CompositeType instance;cannot be null and should contain at least one element; no element can be a null or empty string.Note that the order in which the item names are given is not important to differentiate aCompositeType instance from another;the item names are internally stored sorted in ascending alphanumeric order.
Parameters:
itemDescriptions - The descriptions, in the same order as itemNames, of the items contained in thecomposite data values described by this CompositeType instance;should be of the same size as itemNames;no element can be a null or empty string.
Parameters:
itemTypes - The open type instances, in the same order as itemNames, describing the items containedin the composite data values described by this CompositeType instance;should be of the same size as itemNames;no element can be null.
throws:
IllegalArgumentException - If typeName or description is a null or empty string,or itemNames or itemDescriptions or itemTypes is null,or any element of itemNames or itemDescriptionsis a null or empty string,or any element of itemTypes is null,or itemNames or itemDescriptions or itemTypesare not of the same size.
throws:
OpenDataException - If itemNames contains duplicate item names(case sensitive, but leading and trailing whitespaces removed). |
| containsKey | | public boolean containsKey(String itemName)(Code) | | Returns true if this CompositeType instance defines an item
whose name is itemName.
Parameters:
itemName - the name of the item. true if an item of this name is present. |
| equals | | public boolean equals(Object obj)(Code) | | Compares the specified obj parameter with this CompositeType instance for equality.
Two CompositeType instances are equal if and only if all of the following statements are true:
- their type names are equal
- their items' names and types are equal
Parameters:
obj - the object to be compared for equality with this CompositeType instance;if obj is null, equals returns false. true if the specified object is equal to this CompositeType instance. |
| getDescription | | public String getDescription(String itemName)(Code) | | Returns the description of the item whose name is itemName,
or null if this CompositeType instance does not define any item
whose name is itemName.
Parameters:
itemName - the name of the item. the description. |
| getType | | public OpenType getType(String itemName)(Code) | | Returns the open type of the item whose name is itemName,
or null if this CompositeType instance does not define any item
whose name is itemName.
Parameters:
itemName - the name of the time. the type. |
| hashCode | | public int hashCode()(Code) | | Returns the hash code value for this CompositeType instance.
The hash code of a CompositeType instance is the sum of the hash codes
of all elements of information used in equals comparisons
(ie: name, items names, items types).
This ensures that t1.equals(t2) implies that t1.hashCode()==t2.hashCode()
for any two CompositeType instances t1 and t2,
as required by the general contract of the method
Object.hashCode .
As CompositeType 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 CompositeType instance |
| isValue | | public boolean isValue(Object obj)(Code) | | Tests whether obj is a value which could be described by this CompositeType instance.
If obj is null or is not an instance of javax.management.openmbean.CompositeData,
isValue returns false.
If obj is an instance of javax.management.openmbean.CompositeData,
its composite type is tested for equality with this CompositeType instance, and isValue
returns true if and only if
CompositeType.equals(java.lang.Object) equals returns true.
Parameters:
obj - the value whose open type is to be tested for equality with this CompositeType instance. true if obj is a value for this composite type, false otherwise. |
| keySet | | public Set keySet()(Code) | | Returns an unmodifiable Set view of all the item names defined by this CompositeType instance.
The set's iterator will return the item names in ascending order.
a Set of String. |
| toString | | public String toString()(Code) | | Returns a string representation of this CompositeType instance.
The string representation consists of
the name of this class (ie javax.management.openmbean.CompositeType), the type name for this instance,
and the list of the items names and types string representation of this instance.
As CompositeType 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 CompositeType instance |
|
|