This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.management.openmbean
interface TabularData

All Known Implementing Classes:
TabularDataSupport

Most common way to construct:

TabularType ttype = …;

TabularData tdata = new TabularDataSupport(ttype);

Based on 6 examples


public interface TabularData

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


Method Summary
 Object[]

          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

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

          Returns true if and only if this TabularData instance contains a CompositeData value (ie a row) whose index is the specified key.
 boolean

          Returns true if and only if this TabularData instance contains the specified CompositeData value.
 boolean

          Compares the specified obj parameter with this TabularData instance for equality.
 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.
 TabularType

          Returns the tabular type describing this TabularData instance.
 int

          Returns the hash code value for this TabularData instance.
 boolean

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

          Returns a set view of the keys (ie the index values) of the values (ie the rows) contained in this instance.
 void

          Adds value to this TabularData instance.
 void

          Add all the elements in values to this TabularData instance.
 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.
 int

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

          Returns a string representation of this TabularData instance.
 Collection

          Returns a collection view of the values (ie the rows) contained in this instance.
 

Method Detail

calculateIndex

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

clear

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


containsKey

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

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 - the row value whose presence in this TabularData instance is to be tested.
Returns:
true if this TabularData instance contains the specified row value.

equals

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:

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

Overrides:
equals in class 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.

get

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 key of the row to return.
Returns:
the value corresponding to key.

getTabularType

public TabularType getTabularType()
Returns the tabular type describing this TabularData instance.

Returns:
the tabular type.

hashCode

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 {@link Object#hashCode() Object.hashCode()}.

Overrides:
hashCode in class Object
Returns:
the hash code value for this TabularDataSupport instance

isEmpty

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

keySet

public Set keySet()
Returns a set view of the keys (ie the index values) of the {@code CompositeData} values (ie the rows) contained in this {@code TabularData} instance. The returned {@code Set} is a {@code Set>} but is declared as a {@code Set} for compatibility reasons. The returned set can be used to iterate over the keys.

Returns:
a set view ({@code Set>}) of the index values used in this {@code TabularData} instance.

put

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().{@link TabularType#getRowType 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.{@link TabularType#getIndexNames 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.

putAll

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 {@link #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.

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.
Returns:
previous value associated with specified key, or null if there was no mapping for key.

size

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

Returns:
the number of values contained.

toString

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.

Overrides:
toString in class Object
Returns:
a string representation of this TabularData instance

values

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

Returns:
a collection view ({@code Collection}) of the rows contained in this {@code TabularData} instance.


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.