| javax.management.openmbean.TabularData
All known Subclasses: javax.management.openmbean.TabularDataSupport,
| TabularData | | public interface TabularData (Code) | | The TabularData interface specifies the behaviour of a specific type of complex open data objects
which represent tabular data structures.
author:
Young Yang |
| Method Summary | |
| public Object[] | calculateIndex(CompositeData value)
Calculates the index that would be used in this TabularData instance to refer to the specified
composite data value parameter if it were added to this instance.
This method checks for the type validity of the specified value,
but does not check if the calculated index is already used to refer to a value in this TabularData instance.
Parameters:
value - the composite data value whose index in thisTabularData instance is to be calculated;must be of the same composite type as this instance's row type;must not be null. | | public void | clear()
Removes all CompositeData values (ie rows) from this TabularData instance. | | public boolean | containsKey(Object[] key)
Returns true if and only if this TabularData instance contains a CompositeData value
(ie a row) whose index is the specified key. | | public boolean | containsValue(CompositeData value)
Returns true if and only if this TabularData instance contains the specified
CompositeData value. | | public boolean | equals(Object obj)
Compares the specified obj parameter with this TabularData instance for equality. | | public CompositeData | get(Object[] key)
Returns the CompositeData value whose index is
key, or null if there is no value mapping
to key, in this TabularData instance.
Parameters:
key - the key of the row to return. | | public TabularType | getTabularType()
Returns the tabular type describing this
TabularData instance. | | public int | hashCode()
Returns the hash code value for this TabularData instance. | | public boolean | isEmpty()
Returns true if the number of CompositeData
values (ie the number of rows) contained in this
TabularData instance is zero. | | public Set | keySet()
Returns a set view of the keys (ie the index values) of the CompositeData values (ie the rows)
contained in this TabularData instance. | | public void | put(CompositeData value)
Adds value to this TabularData instance.
The composite type of value must be the same as this
instance's row type (ie the composite type returned by
this.getTabularType().
TabularType.getRowTypegetRowType() ), and there must not already be an existing
value in this TabularData instance whose index is the
same as the one calculated for the value to be
added. | | public void | putAll(CompositeData[] values)
Add all the elements in values to this TabularData instance. | | public CompositeData | remove(Object[] key)
Removes the CompositeData value whose index is key from this TabularData instance,
and returns the removed value, or returns null if there is no value whose index is key.
Parameters:
key - the index of the value to get in this TabularData instance;must be valid with this TabularData instance's row type definition;must not be null. | | public int | size()
Returns the number of CompositeData values (ie the
number of rows) contained in this TabularData
instance. | | public String | toString()
Returns a string representation of this TabularData instance. | | public Collection | values()
Returns a collection view of the CompositeData values (ie the rows)
contained in this TabularData instance. |
| calculateIndex | | public Object[] calculateIndex(CompositeData value)(Code) | | Calculates the index that would be used in this TabularData instance to refer to the specified
composite data value parameter if it were added to this instance.
This method checks for the type validity of the specified value,
but does not check if the calculated index is already used to refer to a value in this TabularData instance.
Parameters:
value - the composite data value whose index in thisTabularData instance is to be calculated;must be of the same composite type as this instance's row type;must not be null. the index that the specified value would have in this TabularData instance.
throws:
NullPointerException - if value is null
throws:
InvalidOpenTypeException - if value does not conform to this TabularData instance'srow type definition. |
| clear | | public void clear()(Code) | | Removes all CompositeData values (ie rows) from this TabularData instance.
|
| containsKey | | public boolean containsKey(Object[] key)(Code) | | Returns true if and only if this TabularData instance contains a CompositeData value
(ie a row) whose index is the specified key. If key is null or does not conform to
this TabularData instance's TabularType definition, this method simply returns false.
Parameters:
key - the index value whose presence in this TabularData instance is to be tested. true if this TabularData indexes a row value with the specified key. |
| containsValue | | public boolean containsValue(CompositeData value)(Code) | | Returns true if and only if this TabularData instance contains the specified
CompositeData value. If value is null or does not conform to
this TabularData instance's row type definition, this method simply returns false.
Parameters:
value - the row value whose presence in this TabularData instance is to be tested. true if this TabularData instance contains the specified row value. |
| equals | | public boolean equals(Object obj)(Code) | | Compares the specified obj parameter with this TabularData instance for equality.
Returns true if and only if all of the following statements are true:
- obj is non null,
- obj also implements the
TabularData interface,
- their row types are equal
- their contents (ie index to value mappings) are equal
This ensures that this equals method works properly for obj parameters which are
different implementations of the TabularData interface.
Parameters:
obj - the object to be compared for equality with this TabularData instance; true if the specified object is equal to this TabularData instance. |
| get | | public CompositeData get(Object[] key)(Code) | | Returns the CompositeData value whose index is
key, or null if there is no value mapping
to key, in this TabularData instance.
Parameters:
key - the key of the row to return. the value corresponding to key.
throws:
NullPointerException - if the key isnull
throws:
InvalidKeyException - if the key does notconform to this TabularData instance's *TabularType definition |
| getTabularType | | public TabularType getTabularType()(Code) | | Returns the tabular type describing this
TabularData instance.
the tabular type. |
| hashCode | | public int hashCode()(Code) | | Returns the hash code value for this TabularData instance.
The hash code of a TabularData instance is the sum of the hash codes
of all elements of information used in equals comparisons
(ie: its tabular type and its content, where the content is defined as all the index to value mappings).
This ensures that t1.equals(t2) implies that t1.hashCode()==t2.hashCode()
for any two TabularDataSupport instances t1 and t2,
as required by the general contract of the method
Object.hashCode .
the hash code value for this TabularDataSupport instance |
| isEmpty | | public boolean isEmpty()(Code) | | Returns true if the number of CompositeData
values (ie the number of rows) contained in this
TabularData instance is zero.
true if this TabularData is empty. |
| keySet | | public Set keySet()(Code) | | Returns a set view of the keys (ie the index values) of the CompositeData values (ie the rows)
contained in this TabularData instance. The returned Set can then be used to iterate over the keys.
a set view of the index values used in this TabularData instance. |
| put | | public void put(CompositeData value)(Code) | | Adds value to this TabularData instance.
The composite type of value must be the same as this
instance's row type (ie the composite type returned by
this.getTabularType().
TabularType.getRowTypegetRowType() ), and there must not already be an existing
value in this TabularData instance whose index is the
same as the one calculated for the value to be
added. The index for value is calculated according
to this TabularData instance's TabularType
definition (see TabularType.
TabularType.getIndexNames getIndexNames() ).
Parameters:
value - the composite data value to be added as a new row to this TabularData instance;must be of the same composite type as this instance's row type;must not be null.
throws:
NullPointerException - if value is null
throws:
InvalidOpenTypeException - if value does not conform to this TabularData instance'srow type definition.
throws:
KeyAlreadyExistsException - if the index for value, calculated according tothis TabularData instance's TabularType definitionalready maps to an existing value in the underlying HashMap. |
| putAll | | public void putAll(CompositeData[] values)(Code) | | Add all the elements in values to this TabularData instance.
If any element in values does not satisfy the constraints defined in
TabularData.put(CompositeData) put ,
or if any two elements in values have the same index calculated according to this TabularData
instance's TabularType definition, then an exception describing the failure is thrown
and no element of values is added, thus leaving this TabularData instance unchanged.
Parameters:
values - the array of composite data values to be added as new rows to this TabularData instance;if values is null or empty, this method returns without doing anything.
throws:
NullPointerException - if an element of values is null
throws:
InvalidOpenTypeException - if an element of values does not conform tothis TabularData instance's row type definition
throws:
KeyAlreadyExistsException - if the index for an element of values, calculated according tothis TabularData instance's TabularType definitionalready maps to an existing value in this instance,or two elements of values have the same index. |
| remove | | public CompositeData remove(Object[] key)(Code) | | Removes the CompositeData value whose index is key from this TabularData instance,
and returns the removed value, or returns null if there is no value whose index is key.
Parameters:
key - the index of the value to get in this TabularData instance;must be valid with this TabularData instance's row type definition;must not be null. previous value associated with specified key, or nullif there was no mapping for key.
throws:
NullPointerException - if the key is null
throws:
InvalidKeyException - if the key does not conform to this TabularData instance'sTabularType definition |
| size | | public int size()(Code) | | Returns the number of CompositeData values (ie the
number of rows) contained in this TabularData
instance.
the number of values contained. |
| toString | | public String toString()(Code) | | Returns a string representation of this TabularData instance.
The string representation consists of the name of the implementing class,
and the tabular type of this instance.
a string representation of this TabularData instance |
| values | | public Collection values()(Code) | | Returns a collection view of the CompositeData values (ie the rows)
contained in this TabularData instance.
The returned collection can then be used to iterate over the values.
a collection view of the rows contained in this TabularData instance. |
|
|