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.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 

javax.management.openmbean
class TabularDataSupport

java.lang.Object extended by javax.management.openmbean.TabularDataSupport
All Implemented Interfaces:
Serializable, Cloneable, Map, TabularData
Most common way to construct:

TabularType tabularType = …;

TabularDataSupport data = new TabularDataSupport(tabularType);

Based on 23 examples 

public class TabularDataSupport
extends Object
implements TabularData, Map, Cloneable, Serializable

The TabularDataSupport class is the open data class which implements the TabularData and the Map interfaces, and which is internally based on a hash map data structure.

Constructor Summary
TabularDataSupport(TabularType tabularType)

          Creates an empty TabularDataSupport instance whose open-type is tabularType, and whose underlying HashMap has a default initial capacity (101) and default load factor (0.75).
TabularDataSupport(TabularType tabularType, int initialCapacity, float loadFactor)

          Creates an empty TabularDataSupport instance whose open-type is tabularType, and whose underlying HashMap has the specified initial capacity and load factor.
 
Method Summary
 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.
 void
clear()

          Removes all rows from this TabularDataSupport instance.
 Object
clone()

          Returns a clone of this TabularDataSupport instance: the clone is obtained by calling super.clone(), and then cloning the underlying map.
 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.
 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.
 boolean
containsValue(CompositeData value)

          Returns true if and only if this TabularData instance contains the specified CompositeData value.
 boolean
containsValue(Object value)

          Returns true if and only if this TabularData instance contains the specified value.
 Set
entrySet()

          Returns a collection view of the index to row mappings contained in this instance.
 boolean
equals(Object obj)

          Compares the specified obj parameter with this TabularDataSupport instance for equality.
 Object
get(Object key)

          This method simply calls get((Object[]) key).
 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
getTabularType()

          Returns the tabular type describing this TabularData instance.
 int
hashCode()

          Returns the hash code value for this TabularDataSupport instance.
 boolean
isEmpty()

          Returns true if this TabularDataSupport instance contains no rows.
 Set
keySet()

          Returns a set view of the keys contained in the underlying map of this instance used to index the rows.
 void
put(CompositeData value)

          
 Object
put(Object key, Object value)

          This method simply calls put((CompositeData) value) and therefore ignores its key parameter which can be null.
 void
putAll(CompositeData[] values)

          Add all the elements in values to this TabularData instance.
 void
putAll(Map t)

          Add all the values contained in the specified map t to this TabularData instance.
 Object
remove(Object key)

          This method simply calls remove((Object[]) key).
 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
size()

          Returns the number of rows in this TabularDataSupport instance.
 String
toString()

          Returns a string representation of this TabularDataSupport instance.
 Collection
values()

          Returns a collection view of the rows contained in this instance.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TabularDataSupport

public TabularDataSupport(TabularType tabularType)
Creates an empty TabularDataSupport instance whose open-type is tabularType, and whose underlying HashMap has a default initial capacity (101) and default load factor (0.75).

This constructor simply calls this(tabularType, 101, 0.75f);

Parameters:
tabularType - the tabular type describing this TabularData instance; cannot be null.

TabularDataSupport

public TabularDataSupport(TabularType tabularType,
                          int initialCapacity,
                          float loadFactor)
Creates an empty TabularDataSupport instance whose open-type is tabularType, and whose underlying HashMap has the specified initial capacity and load factor.

Parameters:
tabularType - the tabular type describing this TabularData instance; cannot be null.
initialCapacity - the initial capacity of the HashMap.
loadFactor - the load factor of the HashMap
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 rows from this TabularDataSupport instance.

clone

public Object clone()
Returns a clone of this TabularDataSupport instance: the clone is obtained by calling super.clone(), and then cloning the underlying map. Only a shallow clone of the underlying map is made, i.e. no cloning of the indexes and row values is made as they are immutable.

Overrides:
clone in class Object

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 cannot be cast to a one dimension array of Object instances, this method simply returns false; otherwise it returns the the result of the call to this.containsKey((Object[]) key).

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.

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.

containsValue

public boolean containsValue(Object value)
Returns true if and only if this TabularData instance contains the specified value.

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.

entrySet

public Set entrySet()
Returns a collection view of the index to row mappings contained in this {@code TabularDataSupport} instance. Each element in the returned collection is a {@code Map.Entry,CompositeData>} but is declared as a {@code Map.Entry} for compatibility reasons. Each of the map entry keys is an unmodifiable {@code List}. The collection is backed by the underlying map of this {@code TabularDataSupport} instance, so changes to the {@code TabularDataSupport} instance are reflected in the collection, and vice-versa. The collection supports element removal, which removes the corresponding mapping from the map, via the {@link Iterator#remove}, {@link Collection#remove}, {@link Collection#removeAll}, {@link Collection#retainAll}, and {@link Collection#clear} operations. It does not support the {@link Collection#add} or {@link Collection#addAll} operations.

IMPORTANT NOTICE: Do not use the {@code setValue} method of the {@code Map.Entry} elements contained in the returned collection view. Doing so would corrupt the index to row mappings contained in this {@code TabularDataSupport} instance.

Returns:
a collection view ({@code Set,CompositeData>>}) of the mappings contained in this map.

equals

public boolean equals(Object obj)
Compares the specified obj parameter with this TabularDataSupport 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 TabularDataSupport instance;
Returns:
true if the specified object is equal to this TabularDataSupport instance.

get

public Object get(Object key)
This method simply calls get((Object[]) key).

Parameters:
key

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 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:
the value corresponding to key.

getTabularType

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

hashCode

public int hashCode()
Returns the hash code value for this TabularDataSupport instance.

The hash code of a TabularDataSupport 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 CompositeData values).

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

However, note that another instance of a class implementing the TabularData interface may be equal to this TabularDataSupport instance as defined by {@link #equals}, but may have a different hash code if it is calculated differently.

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

isEmpty

public boolean isEmpty()
Returns true if this TabularDataSupport instance contains no rows.

Returns:
true if this TabularDataSupport instance contains no rows.

keySet

public Set keySet()
Returns a set view of the keys contained in the underlying map of this {@code TabularDataSupport} instance used to index the rows. Each key contained in this {@code Set} is an unmodifiable {@code List} so the returned set view is a {@code Set>} but is declared as a {@code Set} for compatibility reasons. The set is backed by the underlying map of this {@code TabularDataSupport} instance, so changes to the {@code TabularDataSupport} instance are reflected in the set, and vice-versa. The set supports element removal, which removes the corresponding row from this {@code TabularDataSupport} instance, via the {@link Iterator#remove}, {@link Set#remove}, {@link Set#removeAll}, {@link Set#retainAll}, and {@link Set#clear} operations. It does not support the {@link Set#add} or {@link Set#addAll} operations.

Returns:
a set view ({@code Set>}) of the keys used to index the rows of this {@code TabularDataSupport} instance.

put

public void put(CompositeData value)
Parameters:
value

put

public Object put(Object key,
                  Object value)
This method simply calls put((CompositeData) value) and therefore ignores its key parameter which can be null.

Parameters:
key - an ignored parameter.
value - the {@link CompositeData} to put.
Returns:
the value which is put

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.

putAll

public void putAll(Map t)
Add all the values contained in the specified map t to this TabularData instance. This method converts the collection of values contained in this map into an array of CompositeData values, if possible, and then call the method putAll(CompositeData[]). Note that the keys used in the specified map t are ignored. This method allows, for example to add the content of another TabularData instance with the same row type (but possibly different index names) into this instance.

Parameters:
t - the map whose values are to be added as new rows to this TabularData instance; if t is null or empty, this method returns without doing anything.

remove

public Object remove(Object key)
This method simply calls remove((Object[]) key).

Parameters:
key - an Object[] representing the key to remove.
Returns:
previous value associated with specified key, or null if there was no mapping for key.

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 rows in this TabularDataSupport instance.

Returns:
the number of rows in this TabularDataSupport instance.

toString

public String toString()
Returns a string representation of this TabularDataSupport instance.

The string representation consists of the name of this class (ie javax.management.openmbean.TabularDataSupport), the string representation of the tabular type of this instance, and the string representation of the contents (ie list the key=value mappings as returned by a call to dataMap.{@link java.util.HashMap#toString() toString()}).

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

values

public Collection values()
Returns a collection view of the rows contained in this {@code TabularDataSupport} 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. The collection is backed by the underlying map, so changes to the {@code TabularDataSupport} instance are reflected in the collection, and vice-versa. The collection supports element removal, which removes the corresponding index to row mapping from this {@code TabularDataSupport} instance, via the {@link Iterator#remove}, {@link Collection#remove}, {@link Collection#removeAll}, {@link Collection#retainAll}, and {@link Collection#clear} operations. It does not support the {@link Collection#add} or {@link Collection#addAll} operations.

Returns:
a collection view ({@code Collection}) of the values contained in this {@code TabularDataSupport} instance.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
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/.