TabularDataSupport
public interface TabularData
TabularData
interface specifies the behavior of a specific type of complex open data objects which represent tabular data structures.Modifier and Type | Method | Description |
---|---|---|
Object[] |
calculateIndex |
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() |
Removes all CompositeData values (ie rows) from this TabularData instance. |
boolean |
containsKey |
Returns true if and only if this TabularData instance contains a CompositeData value (ie a row) whose index is the specified key. |
boolean |
containsValue |
Returns true if and only if this TabularData instance contains the specified CompositeData value. |
boolean |
equals |
Compares the specified obj parameter with this TabularData instance for equality. |
CompositeData |
get |
Returns the CompositeData value whose index is key, or null if there is no value mapping to key, in this TabularData instance. |
TabularType |
getTabularType() |
Returns the tabular type describing this TabularData instance. |
int |
hashCode() |
Returns the hash code value for this TabularData instance. |
boolean |
isEmpty() |
Returns true if the number of CompositeData values (ie the number of rows) contained in this TabularData instance is zero. |
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. |
void |
put |
Adds value to this TabularData instance. |
void |
putAll |
Add all the elements in values to this TabularData instance. |
CompositeData |
remove |
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() |
Returns the number of CompositeData values (ie the number of rows) contained in this TabularData instance. |
String |
toString() |
Returns a string representation of this TabularData instance. |
Collection |
values() |
Returns a collection view of the CompositeData values (ie the rows) contained in this TabularData instance. |
TabularType getTabularType()
TabularData
instance.Object[] calculateIndex(CompositeData value)
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.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.TabularData
instance.NullPointerException
- if value is null
InvalidOpenTypeException
- if value does not conform to this TabularData
instance's row type definition.int size()
CompositeData
values (ie the number of rows) contained in this TabularData
instance.boolean isEmpty()
true
if the number of CompositeData
values (ie the number of rows) contained in this TabularData
instance is zero.TabularData
is empty.boolean containsKey(Object[] key)
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
.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.boolean containsValue(CompositeData value)
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
.value
- the row value whose presence in this TabularData
instance is to be tested.true
if this TabularData
instance contains the specified row value.CompositeData get(Object[] key)
CompositeData
value whose index is key, or null
if there is no value mapping to key, in this TabularData
instance.key
- the key of the row to return.NullPointerException
- if the key is null
InvalidKeyException
- if the key does not conform to this TabularData
instance's * TabularType
definitionvoid put(CompositeData value)
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()
).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.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.CompositeData remove(Object[] key)
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.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.null
if there was no mapping for key.NullPointerException
- if the key is null
InvalidKeyException
- if the key does not conform to this TabularData
instance's TabularType
definitionvoid putAll(CompositeData[] values)
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.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.NullPointerException
- if an element of values is null
InvalidOpenTypeException
- if an element of values does not conform to this TabularData
instance's row type definitionKeyAlreadyExistsException
- 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.void clear()
CompositeData
values (ie rows) from this TabularData
instance.Set<?> keySet()
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.Set<List<?>>
) of the index values used in this TabularData
instance.Collection<?> values()
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.Collection<CompositeData>
) of the rows contained in this TabularData
instance.boolean equals(Object obj)
TabularData
instance for equality. Returns true
if and only if all of the following statements are true:
TabularData
interface,equals
method works properly for obj parameters which are different implementations of the TabularData
interface. int hashCode()
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()
.
String toString()
TabularData
instance. The string representation consists of the name of the implementing class, and the tabular type of this instance.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.management/javax/management/openmbean/TabularData.html