OpenJDK 27 · javax.management.openmbean.TabularData · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public Object[]	Returns: the index that the specified `value` would have in this `TabularData` instance. calculateIndex(CompositeData 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. 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.
public void	clear() Removes all `CompositeData` values (ie rows) from this `TabularData` instance.
public boolean	Returns: `true` if this `TabularData` indexes a row value with the specified key. containsKey(Object[] the index value whose presence in this `TabularData` instance is to be tested. 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	Returns: `true` if this `TabularData` instance contains the specified row value. containsValue(CompositeData the row value whose presence in this `TabularData` instance is to be tested. value) Returns `true` if and only if this `TabularData` instance contains the specified `CompositeData` value.
public boolean	Returns: `true` if the specified object is equal to this `TabularData` instance. equals(Object the object to be compared for equality with this `TabularData` instance; obj) Compares the specified `obj` parameter with this `TabularData` instance for equality.
public CompositeData	Returns: the value corresponding to `key`. get(Object[] the key of the row to return. key) Returns the `CompositeData` value whose index is `key`, or `null` if there is no value mapping to `key`, in this `TabularData` instance.
public TabularType	Returns: the tabular type. getTabularType() Returns the tabular type describing this `TabularData` instance.
public int	Returns: the hash code value for this `TabularDataSupport` instance hashCode() Returns the hash code value for this `TabularData` instance.
public boolean	Returns: true if this `TabularData` is empty. isEmpty() Returns `true` if the number of `CompositeData` values (ie the number of rows) contained in this `TabularData` instance is zero.
public Set<?>	Returns: a set view (`Set<List<?>>`) of the index values used in this `TabularData` instance. 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 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. value) Adds `value` to this `TabularData` instance.
public void	putAll(CompositeData[] 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. values) Add all the elements in `values` to this `TabularData` instance.
public CompositeData	Returns: previous value associated with specified key, or `null` if there was no mapping for key. remove(Object[] 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. 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`.
public int	Returns: the number of values contained. size() Returns the number of `CompositeData` values (ie the number of rows) contained in this `TabularData` instance.
public String	Returns: a string representation of this `TabularData` instance toString() Returns a string representation of this `TabularData` instance.
public Collection<?>	Returns: a collection view (`Collection<CompositeData>`) of the rows contained in this `TabularData` instance. values() Returns a collection view of the `CompositeData` values (ie the rows) contained in this `TabularData` instance.

Method Detail

calculateIndex back to summary

calculateIndex	back to 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:CompositeData 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:Object[] the index that the specified `value` would have in this `TabularData` instance. Exceptions NullPointerException: if `value` is `null` InvalidOpenTypeException: if `value` does not conform to this `TabularData` instance's row type definition.

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:CompositeData: 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:Object[]

the index that the specified value would have in this TabularData instance.

Exceptions

NullPointerException:: if value is null
InvalidOpenTypeException:: if value does not conform to this TabularData instance's row type definition.

clear	back to summary
public void clear() Removes all `CompositeData` values (ie rows) from this `TabularData` instance.

containsKey back to summary

containsKey	back to summary
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`. If `key` is `null` or does not conform to this `TabularData` instance's `TabularType` definition, this method simply returns `false`. Parameters key:Object[] the index value whose presence in this `TabularData` instance is to be tested. Returns:boolean `true` if this `TabularData` indexes a row value with 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. If key is null or does not conform to this TabularData instance's TabularType definition, this method simply returns false.

Parameters

key:Object[]: the index value whose presence in this TabularData instance is to be tested.

Returns:boolean

true if this TabularData indexes a row value with the specified key.

containsValue back to summary

containsValue	back to summary
public boolean containsValue(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:CompositeData the row value whose presence in this `TabularData` instance is to be tested. Returns:boolean `true` if this `TabularData` instance contains the specified row value.

public boolean containsValue(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:CompositeData: the row value whose presence in this TabularData instance is to be tested.

Returns:boolean

true if this TabularData instance contains the specified row value.

equals back to summary

equals	back to summary
public boolean equals(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: `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:Object the object to be compared for equality with this `TabularData` instance; Returns:boolean `true` if the specified object is equal to this `TabularData` instance.

public boolean equals(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:

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:Object: the object to be compared for equality with this TabularData instance;

Returns:boolean

true if the specified object is equal to this TabularData instance.

get back to summary

get	back to summary
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:Object[] the key of the row to return. Returns:CompositeData the value corresponding to `key`. Exceptions NullPointerException: if the `key` is `null` InvalidKeyException: if the `key` does not conform to this `TabularData` instance's * `TabularType` definition

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:Object[]: the key of the row to return.

Returns:CompositeData

the value corresponding to key.

Exceptions

NullPointerException:: if the key is null
InvalidKeyException:: if the key does not conform to this TabularData instance's * TabularType definition

getTabularType back to summary

getTabularType	back to summary
public TabularType getTabularType() Returns the tabular type describing this `TabularData` instance. Returns:TabularType the tabular type.

public TabularType getTabularType()

Returns the tabular type describing this TabularData instance.

Returns:TabularType: the tabular type.

hashCode back to summary

hashCode	back to summary
public 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()`. Returns:int the hash code value for this `TabularDataSupport` instance

public 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().

Returns:int: the hash code value for this TabularDataSupport instance

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Returns `true` if the number of `CompositeData` values (ie the number of rows) contained in this `TabularData` instance is zero. Returns:boolean true if this `TabularData` is empty.

public boolean isEmpty()

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

Returns:boolean: true if this TabularData is empty.

keySet back to summary

keySet	back to summary
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. The returned `Set` is a `Set<List<?>>` but is declared as a `Set<?>` for compatibility reasons. The returned set can be used to iterate over the keys. Returns:Set<?> a set view (`Set<List<?>>`) of the index values used in this `TabularData` instance.

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. The returned Set is a Set<List<?>> but is declared as a Set<?> for compatibility reasons. The returned set can be used to iterate over the keys.

Returns:Set<?>: a set view (Set<List<?>>) of the index values used in this TabularData instance.

put back to summary

put	back to summary
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().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()`). Parameters value:CompositeData 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. Exceptions NullPointerException: if `value` is `null` InvalidOpenTypeException: if `value` does not conform to this `TabularData` instance's row type definition. 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.

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().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()).

Parameters

value:CompositeData: 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.

Exceptions

NullPointerException:: if value is null
InvalidOpenTypeException:: if value does not conform to this TabularData instance's row type definition.
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.

putAll back to summary

putAll	back to summary
public void putAll(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`, 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:CompositeData[] 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. Exceptions NullPointerException: if an element of `values` is `null` InvalidOpenTypeException: if an element of `values` does not conform to this `TabularData` instance's row type definition 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.

public void putAll(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, 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:CompositeData[]: 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.

Exceptions

NullPointerException:: if an element of values is null
InvalidOpenTypeException:: if an element of values does not conform to this TabularData instance's row type definition
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.

remove back to summary

remove	back to summary
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:Object[] 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:CompositeData previous value associated with specified key, or `null` if there was no mapping for key. Exceptions NullPointerException: if the `key` is `null` InvalidKeyException: if the `key` does not conform to this `TabularData` instance's `TabularType` definition

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:Object[]: 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:CompositeData

previous value associated with specified key, or null if there was no mapping for key.

Exceptions

NullPointerException:: if the key is null
InvalidKeyException:: if the key does not conform to this TabularData instance's TabularType definition

size back to summary

size	back to summary
public int size() Returns the number of `CompositeData` values (ie the number of rows) contained in this `TabularData` instance. Returns:int the number of values contained.

public int size()

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

Returns:int: the number of values contained.

toString back to summary

toString	back to summary
public 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. Returns:String a string representation of this `TabularData` instance

public 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.

Returns:String: a string representation of this TabularData instance

values back to summary

values	back to summary
public Collection<?> values() Returns a collection view of the `CompositeData` values (ie the rows) contained in this `TabularData` instance. The returned `Collection` is a `Collection<CompositeData>` but is declared as a `Collection<?>` for compatibility reasons. The returned collection can be used to iterate over the values. Returns:Collection<?> a collection view (`Collection<CompositeData>`) of the rows contained in this `TabularData` instance.

public Collection<?> values()

Returns a collection view of the CompositeData values (ie the rows) contained in this TabularData instance. The returned Collection is a Collection<CompositeData> but is declared as a Collection<?> for compatibility reasons. The returned collection can be used to iterate over the values.

Returns:Collection<?>: a collection view (Collection<CompositeData>) of the rows contained in this TabularData instance.

public Interface TabularData

Method Summary

Method Detail