javax.management.openmbean

Interface TabularData

public interface TabularData

Provides an interface to a specific type of composite data structure, where keys (the columns) map to the {@link CompositeData} objects that form the rows of the table.

Since: 1.5

Method Summary
Object[]	calculateIndex(CompositeData val) Calculates the index the specified {@link CompositeData} value would have, if it was to be added to this {@link TabularData} instance.
void	clear() Removes all {@link CompositeData} values from the table.
boolean	containsKey(Object[] key) Returns true iff this instance of the {@link TabularData} class contains a {@link CompositeData} value at the specified index.
boolean	containsValue(CompositeData val) Returns true iff this instance of the {@link TabularData} class contains the specified {@link CompositeData} value.
boolean	equals(Object obj) Compares the specified object with this object for equality.
CompositeData	get(Object[] key) Retrieves the {@link CompositeData} value for the specified key, or `null` if no such mapping exists.
TabularType	getTabularType() Returns the tabular type which corresponds to this instance of {@link TabularData}.
int	hashCode() Returns the hash code of the composite data type.
boolean	isEmpty() Returns true if this {@link TabularData} instance contains no {@link CompositeData} values.
Set<?>	keySet() Returns a {@link java.util.Set} view of the keys or indices of this {@link TabularData} instance.
void	put(CompositeData val) Adds the specified {@link CompositeData} value to the table.
void	putAll(CompositeData[] vals) Adds each of the specified {@link CompositeData} values to the table.
CompositeData	remove(Object[] key) Removes the {@link CompositeData} value located at the specified index.
int	size() Returns the number of {@link CompositeData} values or rows in the table.
String	toString() Returns a textual representation of this instance.
Collection<?>	values() Returns the values associated with this instance.

Method Detail

calculateIndex

public Object[] calculateIndex(CompositeData val)

Calculates the index the specified {@link CompositeData} value would have, if it was to be added to this {@link TabularData} instance. This method includes a check that the type of the given value is the same as the row type of this instance, but not a check for existing instances of the given value. The value must also not be null. Possible indices are returned by the {@link TabularType#getIndexNames()} method of this instance's tabular type. The returned indices are the values of the fields in the supplied {@link CompositeData} instance that match the names given in the {@link TabularType}.

Parameters: val the {@link CompositeData} value whose index should be calculated.

Returns: the index the value would take on, if it were to be added.

Throws: NullPointerException if the value is null. InvalidOpenTypeException if the value does not match the row type of this instance.

clear

public void clear()

Removes all {@link CompositeData} values from the table.

containsKey

public boolean containsKey(Object[] key)

Returns true iff this instance of the {@link TabularData} class contains a {@link CompositeData} value at the specified index. In any other circumstance, including if the given key is null or of the incorrect type, according to the {@link TabularType} of this instance, this method returns false.

Parameters: key the key to test for.

Returns: true if the key maps to a {@link CompositeData} value.

containsValue

public boolean containsValue(CompositeData val)

Returns true iff this instance of the {@link TabularData} class contains the specified {@link CompositeData} value. In any other circumstance, including if the given value is null or of the incorrect type, according to the {@link TabularType} of this instance, this method returns false.

Parameters: val the value to test for.

Returns: true if the value exists.

equals

public boolean equals(Object obj)

Compares the specified object with this object for equality. The object is judged equivalent if it is non-null, and also an instance of {@link TabularData} with the same row type, and {@link CompositeData} values. The two compared instances may be equivalent even if they represent different implementations of {@link TabularData}.

Parameters: obj the object to compare for equality.

Returns: true if obj is equal to this.

get

public CompositeData get(Object[] key)

Retrieves the {@link CompositeData} value for the specified key, or null if no such mapping exists.

Parameters: key the key whose value should be returned.

Returns: the matching {@link CompositeData} value, or null if one does not exist.

Throws: NullPointerException if the key is null. InvalidKeyException if the key does not match the {@link TabularType} of this instance.

getTabularType

public TabularType getTabularType()

Returns the tabular type which corresponds to this instance of {@link TabularData}.

Returns: the tabular type for this instance.

hashCode

public int hashCode()

Returns the hash code of the composite data type. This is computed as the sum of the hash codes of each value, together with the hash code of the tabular type. These are the same elements of the type that are compared as part of the {@link #equals(java.lang.Object)} method, thus ensuring that the hashcode is compatible with the equality test.

Returns: the hash code of this instance.

isEmpty

public boolean isEmpty()

Returns true if this {@link TabularData} instance contains no {@link CompositeData} values.

Returns: true if the instance is devoid of rows.

keySet

public Set<?> keySet()

Returns a {@link java.util.Set} view of the keys or indices of this {@link TabularData} instance.

Returns: a set containing the keys of this instance.

put

public void put(CompositeData val)

Adds the specified {@link CompositeData} value to the table. The value must be non-null, of the same type as the row type of this instance, and must not have the same index as an existing value. The index is calculated using the index names of the {@link TabularType} for this instance.

Parameters: val the {@link CompositeData} value to add.

Throws: NullPointerException if val is null. InvalidOpenTypeException if the type of the given value does not match the row type. KeyAlreadyExistsException if the value has the same calculated index as an existing value.

putAll

public void putAll(CompositeData[] vals)

Adds each of the specified {@link CompositeData} values to the table. Each element of the array must meet the conditions given for the {@link #put(CompositeData)} method. In addition, the index of each value in the array must be distinct from the index of the other values in the array, as well as from the existing values in the table. The operation should be atomic; if one value can not be added, then none of the values should be. If the array is null or empty, the method simply returns.

Parameters: vals the {@link CompositeData} values to add.

Throws: NullPointerException if a value from the array is null. InvalidOpenTypeException if the type of a given value does not match the row type. KeyAlreadyExistsException if a value has the same calculated index as an existing value or of one of the other specified values.

remove

public CompositeData remove(Object[] key)

Removes the {@link CompositeData} value located at the specified index. null is returned if the value does not exist. Otherwise, the removed value is returned.

Parameters: key the key of the value to remove.

Returns: the removed value, or null if there is no value for the given key.

Throws: NullPointerException if the key is null. InvalidOpenTypeException if the key does not match the {@link TabularType} of this instance.

size

public int size()

Returns the number of {@link CompositeData} values or rows in the table.

Returns: the number of rows in the table.

toString

public String toString()

Returns a textual representation of this instance. The exact format is left up to the implementation, but it should contain the name of the implementing class and the tabular type.

Returns: a {@link java.lang.String} representation of the object.

values

public Collection<?> values()

Returns the values associated with this instance.

Returns: the values of this instance.