| java.lang.Object
 javax.management.openmbean.TabularDataSupport
| TabularDataSupport | | public class TabularDataSupport implements TabularData,Map,Cloneable,Serializable(Code) | | The TabularDataSupport class is the open data class which implements the TabularData
and the Map interfaces, and which is internally based on a hash map data structure.
author:
Young Yang |
| Constructor Summary | |
| public | TabularDataSupport(TabularType tabularType)
Creates an empty TabularDataSupport instance whose open-type is tabularType,
and whose underlying HashMap has a default initial capacity (101) and default load factor (0.75). | | public | TabularDataSupport(TabularType tabularType, int initialCapacity, float loadFactor)
Creates an empty TabularDataSupport instance whose open-type is tabularType,
and whose underlying HashMap has the specified initial capacity and load factor. |
| 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 rows from this TabularDataSupport instance. | | public Object | clone()
Returns a clone of this TabularDataSupport instance:
the clone is obtained by calling super.clone(), and then cloning the underlying map.
Only a shallow clone of the underlying map is made, i.e. | | 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 | 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 | containsValue(Object value)
Returns true if and only if this TabularData instance contains the specified
value.
Parameters:
value - the row value whose presence in this TabularData instance is to be tested. | | public Set | entrySet()
Returns a collection view of the index to row mappings contained in this TabularDataSupport instance.
Each element in the returned collection is a Map.Entry.
The collection is backed by the underlying map of this TabularDataSupport instance, in
so changes to the TabularDataSupport instance are reflected the collection, and vice-versa.
The collection supports element removal, which removes the corresponding mapping from the map, via the
Iterator.remove, Collection.remove,
removeAll, retainAll, and clear operations.
It does not support the add or addAll operations.
IMPORTANT NOTICE: Do not use the SetValue method of Map.Entry elements contained in the returned
collection view. | | public boolean | equals(Object obj)
Compares the specified obj parameter with this TabularDataSupport instance for equality. | | public Object | get(Object key)
This method simply calls get((Object[]) key). | | 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 index of the value to get in thisTabularData instance; * must be valid with thisTabularData instance's row type definition; * must notbe null. | | public TabularType | getTabularType()
Returns the tabular type describing this TabularData instance. | | public int | hashCode()
Returns the hash code value for this TabularDataSupport instance. | | public boolean | isEmpty()
Returns true if this TabularDataSupport instance contains no rows. | | public Set | keySet()
Returns a set view of the keys contained in the underlying map of this TabularDataSupport instance,
and used to index the rows. | | public Object | put(Object key, Object value)
This method simply calls put((CompositeData) value) and
therefore ignores its key parameter which can be null.
Parameters:
key - an ignored parameter.
Parameters:
value - the CompositeData to put. | | public void | put(CompositeData value)
| | public void | putAll(Map t)
Add all the values contained in the specified map t to this TabularData instance.
This method converts the collection of values contained in this map into an array of CompositeData values,
if possible, and then call the method putAll(CompositeData[]). | | public void | putAll(CompositeData[] values)
Add all the elements in values to this TabularData instance. | | public Object | remove(Object key)
This method simply calls remove((Object[]) key).
Parameters:
key - an Object[] representing the key to remove. | | 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 rows in this TabularDataSupport instance. | | public String | toString()
| | public Collection | values()
Returns a collection view of the rows contained in this TabularDataSupport instance. |
| TabularDataSupport | | public TabularDataSupport(TabularType tabularType)(Code) | | Creates an empty TabularDataSupport instance whose open-type is tabularType,
and whose underlying HashMap has a default initial capacity (101) and default load factor (0.75).
This constructor simply calls this(tabularType, 101, 0.75f);
Parameters:
tabularType - the tabular type describing this TabularData instance;cannot be null.
throws:
IllegalArgumentException - if the tabular type is null. |
| TabularDataSupport | | public TabularDataSupport(TabularType tabularType, int initialCapacity, float loadFactor)(Code) | | Creates an empty TabularDataSupport instance whose open-type is tabularType,
and whose underlying HashMap has the specified initial capacity and load factor.
Parameters:
tabularType - the tabular type describing this TabularData instance;cannot be null.
Parameters:
initialCapacity - the initial capacity of the HashMap.
Parameters:
loadFactor - the load factor of the HashMap
throws:
IllegalArgumentException - if the initial capacity is less than zero,or the load factor is nonpositive,or the tabular type is null. |
| 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 rows from this TabularDataSupport instance.
|
| clone | | public Object clone()(Code) | | Returns a clone of this TabularDataSupport instance:
the clone is obtained by calling super.clone(), and then cloning the underlying map.
Only a shallow clone of the underlying map is made, i.e. no cloning of the indexes and row values is made as they are immutable.
|
| 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 cannot be cast to a one dimension array
of Object instances, this method simply returns false; otherwise it returns the the result of the call to
this.containsKey((Object[]) key).
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. |
| 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. |
| containsValue | | public boolean containsValue(Object value)(Code) | | Returns true if and only if this TabularData instance contains the specified
value.
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. |
| entrySet | | public Set entrySet()(Code) | | Returns a collection view of the index to row mappings contained in this TabularDataSupport instance.
Each element in the returned collection is a Map.Entry.
The collection is backed by the underlying map of this TabularDataSupport instance, in
so changes to the TabularDataSupport instance are reflected the collection, and vice-versa.
The collection supports element removal, which removes the corresponding mapping from the map, via the
Iterator.remove, Collection.remove,
removeAll, retainAll, and clear operations.
It does not support the add or addAll operations.
IMPORTANT NOTICE: Do not use the SetValue method of Map.Entry elements contained in the returned
collection view. Doing so would corrupt the index to row mappings contained in this TabularDataSupport instance.
a collection view of the mappings contained in this map.
See Also: java.util.Map.Entry |
| equals | | public boolean equals(Object obj)(Code) | | Compares the specified obj parameter with this TabularDataSupport 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 tabular types are equal
- their contents (ie all CompositeData values) 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 TabularDataSupport instance; true if the specified object is equal to this TabularDataSupport 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 index of the value to get in thisTabularData instance; * must be valid with thisTabularData instance's row type definition; * must notbe null. the value corresponding to key.
throws:
NullPointerException - if the key is null
throws:
InvalidKeyException - if the key does not conform to this TabularData instance'sTabularType type definition. |
| getTabularType | | public TabularType getTabularType()(Code) | | Returns the tabular type describing this TabularData instance.
|
| hashCode | | public int hashCode()(Code) | | Returns the hash code value for this TabularDataSupport instance.
The hash code of a TabularDataSupport 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 CompositeData values).
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 .
However, note that another instance of a class implementing the TabularData interface
may be equal to this TabularDataSupport instance as defined by
TabularDataSupport.equals ,
but may have a different hash code if it is calculated differently.
the hash code value for this TabularDataSupport instance |
| isEmpty | | public boolean isEmpty()(Code) | | Returns true if this TabularDataSupport instance contains no rows.
true if this TabularDataSupport instance contains no rows. |
| keySet | | public Set keySet()(Code) | | Returns a set view of the keys contained in the underlying map of this TabularDataSupport instance,
and used to index the rows. Each key contained in this set is an unmodifiable List.
The set is backed by the underlying map of this TabularDataSupport instance,
so changes to the TabularDataSupport instance are reflected in the set, and vice-versa.
The set supports element removal, which removes the
corresponding row from this TabularDataSupport instance, via the Iterator.remove,
Set.remove, removeAll, retainAll, and
clear operations.
It does not support the add or addAll operations
a set view of the keys used to index the rows of this TabularDataSupport instance. |
| put | | public Object put(Object key, Object value)(Code) | | This method simply calls put((CompositeData) value) and
therefore ignores its key parameter which can be null.
Parameters:
key - an ignored parameter.
Parameters:
value - the CompositeData to put. the value which is put
throws:
NullPointerException - if the value is null
throws:
ClassCastException - if the value is not of the type CompositeData
throws:
InvalidOpenTypeException - if the value does not conform to this TabularData instance'sTabularType definition
throws:
KeyAlreadyExistsException - if the key for the value parameter, calculated according tothis TabularData instance's TabularType definitionalready maps to an existing value |
| putAll | | public void putAll(Map t)(Code) | | Add all the values contained in the specified map t to this TabularData instance.
This method converts the collection of values contained in this map into an array of CompositeData values,
if possible, and then call the method putAll(CompositeData[]). Note that the keys used in the specified
map t are ignored. This method allows, for example to add the content of another TabularData
instance with the same row type (but possibly different index names) into this instance.
Parameters:
t - the map whose values are to be added as new rows to this TabularData instance;if t is null or empty, this method returns without doing anything.
throws:
NullPointerException - if a value in t is null.
throws:
ClassCastException - if a value in t is not an instance of CompositeData.
throws:
InvalidOpenTypeException - if a value in t does not conform tothis TabularData instance's row type definition.
throws:
KeyAlreadyExistsException - if the index for a value in t, calculated according tothis TabularData instance's TabularType definitionalready maps to an existing value in this instance,or two values in t have the same index. |
| 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
TabularDataSupport.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(ie its TabularType 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 Object remove(Object key)(Code) | | This method simply calls remove((Object[]) key).
Parameters:
key - an Object[] representing the key to remove. previous value associated with specified key, or nullif there was no mapping for key.
throws:
NullPointerException - if the key is null
throws:
ClassCastException - if the key is not of the type Object[]
throws:
InvalidKeyException - if the key does not conform to this TabularData instance'sTabularType definition |
| 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 rows in this TabularDataSupport instance.
the number of rows in this TabularDataSupport instance. |
| values | | public Collection values()(Code) | | Returns a collection view of the rows contained in this TabularDataSupport instance.
The collection is backed by the underlying map, so changes to the TabularDataSupport instance
are reflected in the collection, and vice-versa.
The collection supports element removal,
which removes the corresponding index to row mapping from this TabularDataSupport instance,
via the Iterator.remove, Collection.remove,
removeAll, retainAll, and clear operations.
It does not support the add or addAll operations.
a collection view of the values contained in this TabularDataSupport instance. |
|
|