javax.management.openmbean
Interface TabularData

All Known Implementing Classes:
TabularDataSupport sample code for javax.management.openmbean.TabularDataSupport definition code for javax.management.openmbean.TabularDataSupport

public interface TabularData

The TabularData interface specifies the behavior of a specific type of complex open data objects which represent tabular data structures.

Since:
1.5

Method Summary
 Object sample code for java.lang.Object definition code for java.lang.Object [] calculateIndex sample code for javax.management.openmbean.TabularData.calculateIndex(javax.management.openmbean.CompositeData) definition code for javax.management.openmbean.TabularData.calculateIndex(javax.management.openmbean.CompositeData) (CompositeData sample code for javax.management.openmbean.CompositeData definition code for javax.management.openmbean.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.
 void clear sample code for javax.management.openmbean.TabularData.clear() definition code for javax.management.openmbean.TabularData.clear() ()
          Removes all CompositeData values (ie rows) from this TabularData instance.
 boolean containsKey sample code for javax.management.openmbean.TabularData.containsKey(java.lang.Object[]) definition code for javax.management.openmbean.TabularData.containsKey(java.lang.Object[]) (Object sample code for java.lang.Object definition code for java.lang.Object [] key)
          Returns true if and only if this TabularData instance contains a CompositeData value (ie a row) whose index is the specified key.
 boolean containsValue sample code for javax.management.openmbean.TabularData.containsValue(javax.management.openmbean.CompositeData) definition code for javax.management.openmbean.TabularData.containsValue(javax.management.openmbean.CompositeData) (CompositeData sample code for javax.management.openmbean.CompositeData definition code for javax.management.openmbean.CompositeData  value)
          Returns true if and only if this TabularData instance contains the specified CompositeData value.
 boolean equals sample code for javax.management.openmbean.TabularData.equals(java.lang.Object) definition code for javax.management.openmbean.TabularData.equals(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  obj)
          Compares the specified obj parameter with this TabularData instance for equality.
 CompositeData sample code for javax.management.openmbean.CompositeData definition code for javax.management.openmbean.CompositeData get sample code for javax.management.openmbean.TabularData.get(java.lang.Object[]) definition code for javax.management.openmbean.TabularData.get(java.lang.Object[]) (Object sample code for java.lang.Object definition code for java.lang.Object [] key)
          Returns the CompositeData value whose index is key, or null if there is no value mapping to key, in this TabularData instance.
 TabularType sample code for javax.management.openmbean.TabularType definition code for javax.management.openmbean.TabularType getTabularType sample code for javax.management.openmbean.TabularData.getTabularType() definition code for javax.management.openmbean.TabularData.getTabularType() ()
          Returns the tabular type describing this TabularData instance.
 int hashCode sample code for javax.management.openmbean.TabularData.hashCode() definition code for javax.management.openmbean.TabularData.hashCode() ()
          Returns the hash code value for this TabularData instance.
 boolean isEmpty sample code for javax.management.openmbean.TabularData.isEmpty() definition code for javax.management.openmbean.TabularData.isEmpty() ()
          Returns true if the number of CompositeData values (ie the number of rows) contained in this TabularData instance is zero.
 Set sample code for java.util.Set definition code for java.util.Set keySet sample code for javax.management.openmbean.TabularData.keySet() definition code for javax.management.openmbean.TabularData.keySet() ()
          Returns a set view of the keys (ie the index values) of the CompositeData values (ie the rows) contained in this TabularData instance.
 void put sample code for javax.management.openmbean.TabularData.put(javax.management.openmbean.CompositeData) definition code for javax.management.openmbean.TabularData.put(javax.management.openmbean.CompositeData) (CompositeData sample code for javax.management.openmbean.CompositeData definition code for javax.management.openmbean.CompositeData  value)
          Adds value to this TabularData instance.
 void putAll sample code for javax.management.openmbean.TabularData.putAll(javax.management.openmbean.CompositeData[]) definition code for javax.management.openmbean.TabularData.putAll(javax.management.openmbean.CompositeData[]) (CompositeData sample code for javax.management.openmbean.CompositeData definition code for javax.management.openmbean.CompositeData [] values)
          Add all the elements in values to this TabularData instance.
 CompositeData sample code for javax.management.openmbean.CompositeData definition code for javax.management.openmbean.CompositeData remove sample code for javax.management.openmbean.TabularData.remove(java.lang.Object[]) definition code for javax.management.openmbean.TabularData.remove(java.lang.Object[]) (Object sample code for java.lang.Object definition code for java.lang.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.
 int size sample code for javax.management.openmbean.TabularData.size() definition code for javax.management.openmbean.TabularData.size() ()
          Returns the number of CompositeData values (ie the number of rows) contained in this TabularData instance.
 String sample code for java.lang.String definition code for java.lang.String toString sample code for javax.management.openmbean.TabularData.toString() definition code for javax.management.openmbean.TabularData.toString() ()
          Returns a string representation of this TabularData instance.
 Collection sample code for java.util.Collection definition code for java.util.Collection values sample code for javax.management.openmbean.TabularData.values() definition code for javax.management.openmbean.TabularData.values() ()
          Returns a collection view of the CompositeData values (ie the rows) contained in this TabularData instance.
 

Method Detail

getTabularType sample code for javax.management.openmbean.TabularData.getTabularType() definition code for javax.management.openmbean.TabularData.getTabularType()

TabularType sample code for javax.management.openmbean.TabularType definition code for javax.management.openmbean.TabularType  getTabularType()
Returns the tabular type describing this TabularData instance.

Returns:
the tabular type.

calculateIndex sample code for javax.management.openmbean.TabularData.calculateIndex(javax.management.openmbean.CompositeData) definition code for javax.management.openmbean.TabularData.calculateIndex(javax.management.openmbean.CompositeData)

Object sample code for java.lang.Object definition code for java.lang.Object [] calculateIndex(CompositeData sample code for javax.management.openmbean.CompositeData definition code for javax.management.openmbean.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 this TabularData instance is to be calculated; must be of the same composite type as this instance's row type; must not be null.
Returns:
the index that the specified value would have in this TabularData instance.
Throws:
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if value is null
InvalidOpenTypeException sample code for javax.management.openmbean.InvalidOpenTypeException definition code for javax.management.openmbean.InvalidOpenTypeException - if value does not conform to this TabularData instance's row type definition.

size sample code for javax.management.openmbean.TabularData.size() definition code for javax.management.openmbean.TabularData.size()

int size()
Returns the number of CompositeData values (ie the number of rows) contained in this TabularData instance.

Returns:
the number of values contained.

isEmpty sample code for javax.management.openmbean.TabularData.isEmpty() definition code for javax.management.openmbean.TabularData.isEmpty()

boolean isEmpty()
Returns true if the number of CompositeData values (ie the number of rows) contained in this TabularData instance is zero.

Returns:
true if this TabularData is empty.

containsKey sample code for javax.management.openmbean.TabularData.containsKey(java.lang.Object[]) definition code for javax.management.openmbean.TabularData.containsKey(java.lang.Object[])

boolean containsKey(Object sample code for java.lang.Object definition code for java.lang.Object [] key)
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.
Returns:
true if this TabularData indexes a row value with the specified key.

containsValue sample code for javax.management.openmbean.TabularData.containsValue(javax.management.openmbean.CompositeData) definition code for javax.management.openmbean.TabularData.containsValue(javax.management.openmbean.CompositeData)

boolean containsValue(CompositeData sample code for javax.management.openmbean.CompositeData definition code for javax.management.openmbean.CompositeData  value)
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.
Returns:
true if this TabularData instance contains the specified row value.

get sample code for javax.management.openmbean.TabularData.get(java.lang.Object[]) definition code for javax.management.openmbean.TabularData.get(java.lang.Object[])

CompositeData sample code for javax.management.openmbean.CompositeData definition code for javax.management.openmbean.CompositeData  get(Object sample code for java.lang.Object definition code for java.lang.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.
Returns:
the value corresponding to key.
Throws:
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if the key is null
InvalidKeyException sample code for javax.management.openmbean.InvalidKeyException definition code for javax.management.openmbean.InvalidKeyException - if the key does not conform to this TabularData instance's * TabularType definition

put sample code for javax.management.openmbean.TabularData.put(javax.management.openmbean.CompositeData) definition code for javax.management.openmbean.TabularData.put(javax.management.openmbean.CompositeData)

void put(CompositeData sample code for javax.management.openmbean.CompositeData definition code for javax.management.openmbean.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().getRowType() sample code for javax.management.openmbean.TabularType.getRowType() definition code for javax.management.openmbean.TabularType.getRowType() ), 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.getIndexNames() sample code for javax.management.openmbean.TabularType.getIndexNames() definition code for javax.management.openmbean.TabularType.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 sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if value is null
InvalidOpenTypeException sample code for javax.management.openmbean.InvalidOpenTypeException definition code for javax.management.openmbean.InvalidOpenTypeException - if value does not conform to this TabularData instance's row type definition.
KeyAlreadyExistsException sample code for javax.management.openmbean.KeyAlreadyExistsException definition code for javax.management.openmbean.KeyAlreadyExistsException - if the index for value, calculated according to this TabularData instance's TabularType definition already maps to an existing value in the underlying HashMap.

remove sample code for javax.management.openmbean.TabularData.remove(java.lang.Object[]) definition code for javax.management.openmbean.TabularData.remove(java.lang.Object[])

CompositeData sample code for javax.management.openmbean.CompositeData definition code for javax.management.openmbean.CompositeData  remove(Object sample code for java.lang.Object definition code for java.lang.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.
Returns:
previous value associated with specified key, or null if there was no mapping for key.
Throws:
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if the key is null
InvalidKeyException sample code for javax.management.openmbean.InvalidKeyException definition code for javax.management.openmbean.InvalidKeyException - if the key does not conform to this TabularData instance's TabularType definition

putAll sample code for javax.management.openmbean.TabularData.putAll(javax.management.openmbean.CompositeData[]) definition code for javax.management.openmbean.TabularData.putAll(javax.management.openmbean.CompositeData[])

void putAll(CompositeData sample code for javax.management.openmbean.CompositeData definition code for javax.management.openmbean.CompositeData [] values)
Add all the elements in values to this TabularData instance. If any element in values does not satisfy the constraints defined in put sample code for javax.management.openmbean.TabularData.put(javax.management.openmbean.CompositeData) definition code for javax.management.openmbean.TabularData.put(javax.management.openmbean.CompositeData) , 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 sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if an element of values is null
InvalidOpenTypeException sample code for javax.management.openmbean.InvalidOpenTypeException definition code for javax.management.openmbean.InvalidOpenTypeException - if an element of values does not conform to this TabularData instance's row type definition
KeyAlreadyExistsException sample code for javax.management.openmbean.KeyAlreadyExistsException definition code for javax.management.openmbean.KeyAlreadyExistsException - if the index for an element of values, calculated according to this TabularData instance's TabularType definition already maps to an existing value in this instance, or two elements of values have the same index.

clear sample code for javax.management.openmbean.TabularData.clear() definition code for javax.management.openmbean.TabularData.clear()

void clear()
Removes all CompositeData values (ie rows) from this TabularData instance.


keySet sample code for javax.management.openmbean.TabularData.keySet() definition code for javax.management.openmbean.TabularData.keySet()

Set sample code for java.util.Set definition code for java.util.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. The returned Set can then be used to iterate over the keys.

Returns:
a set view of the index values used in this TabularData instance.

values sample code for javax.management.openmbean.TabularData.values() definition code for javax.management.openmbean.TabularData.values()

Collection sample code for java.util.Collection definition code for java.util.Collection  values()
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.

Returns:
a collection view of the rows contained in this TabularData instance.

equals sample code for javax.management.openmbean.TabularData.equals(java.lang.Object) definition code for javax.management.openmbean.TabularData.equals(java.lang.Object)

boolean equals(Object sample code for java.lang.Object definition code for java.lang.Object  obj)
Compares the specified obj parameter with this TabularData instance for equality.

Returns true if and only if all of the following statements are true:

This ensures that this equals method works properly for obj parameters which are different implementations of the TabularData interface.
 

Overrides:
equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) in class Object sample code for java.lang.Object definition code for java.lang.Object
Parameters:
obj - the object to be compared for equality with this TabularData instance;
Returns:
true if the specified object is equal to this TabularData instance.
See Also:
Object.hashCode() sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

hashCode sample code for javax.management.openmbean.TabularData.hashCode() definition code for javax.management.openmbean.TabularData.hashCode()

int hashCode()
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() sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() .

Overrides:
hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
the hash code value for this TabularDataSupport instance
See Also:
Object.equals(java.lang.Object) sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

toString sample code for javax.management.openmbean.TabularData.toString() definition code for javax.management.openmbean.TabularData.toString()

String sample code for java.lang.String definition code for java.lang.String  toString()
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.

Overrides:
toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
a string representation of this TabularData instance