< prev index next >
src/java.management/share/classes/javax/management/openmbean/TabularDataSupport.java
Print this page
*** 49,60 ****
// jmx import
//
/**
! * The <tt>TabularDataSupport</tt> class is the <i>open data</i> class which implements the <tt>TabularData</tt>
! * and the <tt>Map</tt> interfaces, and which is internally based on a hash map data structure.
*
* @since 1.5
*/
/* It would make much more sense to implement
Map<List<?>,CompositeData> here, but unfortunately we cannot for
--- 49,61 ----
// jmx import
//
/**
! * The {@code TabularDataSupport} class is the <i>open data</i>
! * class which implements the {@code TabularData}
! * and the {@code Map} interfaces, and which is internally based on a hash map data structure.
*
* @since 1.5
*/
/* It would make much more sense to implement
Map<List<?>,CompositeData> here, but unfortunately we cannot for
*** 100,129 ****
/* *** Constructors *** */
/**
! * Creates an empty <tt>TabularDataSupport</tt> instance whose open-type is <var>tabularType</var>,
! * and whose underlying <tt>HashMap</tt> has a default initial capacity (101) and default load factor (0.75).
* <p>
! * This constructor simply calls <tt>this(tabularType, 101, 0.75f);</tt>
*
! * @param tabularType the <i>tabular type</i> describing this <tt>TabularData</tt> instance;
! * cannot be null.
*
* @throws IllegalArgumentException if the tabular type is null.
*/
public TabularDataSupport(TabularType tabularType) {
this(tabularType, 16, 0.75f);
}
/**
! * Creates an empty <tt>TabularDataSupport</tt> instance whose open-type is <var>tabularType</var>,
! * and whose underlying <tt>HashMap</tt> has the specified initial capacity and load factor.
*
! * @param tabularType the <i>tabular type</i> describing this <tt>TabularData</tt> instance;
* cannot be null.
*
* @param initialCapacity the initial capacity of the HashMap.
*
* @param loadFactor the load factor of the HashMap
--- 101,132 ----
/* *** Constructors *** */
/**
! * Creates an empty {@code TabularDataSupport} instance
! * whose open-type is <var>tabularType</var>,
! * and whose underlying {@code HashMap} has a default
! * initial capacity (101) and default load factor (0.75).
* <p>
! * This constructor simply calls {@code this(tabularType, 101, 0.75f);}
*
! * @param tabularType the <i>tabular type</i> describing this
! * {@code TabularData} instance; cannot be null.
*
* @throws IllegalArgumentException if the tabular type is null.
*/
public TabularDataSupport(TabularType tabularType) {
this(tabularType, 16, 0.75f);
}
/**
! * Creates an empty {@code TabularDataSupport} instance whose open-type is <var>tabularType</var>,
! * and whose underlying {@code HashMap} has the specified initial capacity and load factor.
*
! * @param tabularType the <i>tabular type</i> describing this {@code TabularData} instance;
* cannot be null.
*
* @param initialCapacity the initial capacity of the HashMap.
*
* @param loadFactor the load factor of the HashMap
*** 165,197 ****
/* *** TabularData specific information methods *** */
/**
! * Returns the <i>tabular type</i> describing this <tt>TabularData</tt> instance.
*/
public TabularType getTabularType() {
return tabularType;
}
/**
! * Calculates the index that would be used in this <tt>TabularData</tt> instance to refer to the specified
! * composite data <var>value</var> parameter if it were added to this instance.
* This method checks for the type validity of the specified <var>value</var>,
! * but does not check if the calculated index is already used to refer to a value in this <tt>TabularData</tt> instance.
*
* @param value the composite data value whose index in this
! * <tt>TabularData</tt> instance is to be calculated;
* must be of the same composite type as this instance's row type;
* must not be null.
*
! * @return the index that the specified <var>value</var> would have in this <tt>TabularData</tt> instance.
*
! * @throws NullPointerException if <var>value</var> is <tt>null</tt>.
*
! * @throws InvalidOpenTypeException if <var>value</var> does not conform to this <tt>TabularData</tt> instance's
* row type definition.
*/
public Object[] calculateIndex(CompositeData value) {
// Check value is valid
--- 168,201 ----
/* *** TabularData specific information methods *** */
/**
! * Returns the <i>tabular type</i> describing this {@code TabularData} instance.
*/
public TabularType getTabularType() {
return tabularType;
}
/**
! * Calculates the index that would be used in this {@code TabularData} instance to refer
! * to the specified composite data <var>value</var> parameter if it were added to this instance.
* This method checks for the type validity of the specified <var>value</var>,
! * but does not check if the calculated index is already used
! * to refer to a value in this {@code TabularData} instance.
*
* @param value the composite data value whose index in this
! * {@code TabularData} instance is to be calculated;
* must be of the same composite type as this instance's row type;
* must not be null.
*
! * @return the index that the specified <var>value</var> would have in this {@code TabularData} instance.
*
! * @throws NullPointerException if <var>value</var> is {@code null}.
*
! * @throws InvalidOpenTypeException if <var>value</var> does not conform to this {@code TabularData} instance's
* row type definition.
*/
public Object[] calculateIndex(CompositeData value) {
// Check value is valid
*** 208,225 ****
/* *** Content information query methods *** */
/**
! * Returns <tt>true</tt> if and only if this <tt>TabularData</tt> instance contains a <tt>CompositeData</tt> value
* (ie a row) whose index is the specified <var>key</var>. If <var>key</var> cannot be cast to a one dimension array
! * of Object instances, this method simply returns <tt>false</tt>; otherwise it returns the result of the call to
! * <tt>this.containsKey((Object[]) key)</tt>.
*
! * @param key the index value whose presence in this <tt>TabularData</tt> instance is to be tested.
*
! * @return <tt>true</tt> if this <tt>TabularData</tt> indexes a row value with the specified key.
*/
public boolean containsKey(Object key) {
// if key is not an array of Object instances, return false
//
--- 212,229 ----
/* *** Content information query methods *** */
/**
! * Returns {@code true} if and only if this {@code TabularData} instance contains a {@code CompositeData} value
* (ie a row) whose index is the specified <var>key</var>. If <var>key</var> cannot be cast to a one dimension array
! * of Object instances, this method simply returns {@code false}; otherwise it returns the result of the call to
! * {@code this.containsKey((Object[]) key)}.
*
! * @param key the index value whose presence in this {@code TabularData} instance is to be tested.
*
! * @return {@code true} if this {@code TabularData} indexes a row value with the specified key.
*/
public boolean containsKey(Object key) {
// if key is not an array of Object instances, return false
//
*** 232,309 ****
return this.containsKey(k);
}
/**
! * Returns <tt>true</tt> if and only if this <tt>TabularData</tt> instance contains a <tt>CompositeData</tt> value
! * (ie a row) whose index is the specified <var>key</var>. If <var>key</var> is <tt>null</tt> or does not conform to
! * this <tt>TabularData</tt> instance's <tt>TabularType</tt> definition, this method simply returns <tt>false</tt>.
*
! * @param key the index value whose presence in this <tt>TabularData</tt> instance is to be tested.
*
! * @return <tt>true</tt> if this <tt>TabularData</tt> indexes a row value with the specified key.
*/
public boolean containsKey(Object[] key) {
return ( key == null ? false : dataMap.containsKey(Arrays.asList(key)));
}
/**
! * Returns <tt>true</tt> if and only if this <tt>TabularData</tt> instance contains the specified
! * <tt>CompositeData</tt> value. If <var>value</var> is <tt>null</tt> or does not conform to
! * this <tt>TabularData</tt> instance's row type definition, this method simply returns <tt>false</tt>.
*
! * @param value the row value whose presence in this <tt>TabularData</tt> instance is to be tested.
*
! * @return <tt>true</tt> if this <tt>TabularData</tt> instance contains the specified row value.
*/
public boolean containsValue(CompositeData value) {
return dataMap.containsValue(value);
}
/**
! * Returns <tt>true</tt> if and only if this <tt>TabularData</tt> instance contains the specified
* value.
*
! * @param value the row value whose presence in this <tt>TabularData</tt> instance is to be tested.
*
! * @return <tt>true</tt> if this <tt>TabularData</tt> instance contains the specified row value.
*/
public boolean containsValue(Object value) {
return dataMap.containsValue(value);
}
/**
! * This method simply calls <tt>get((Object[]) key)</tt>.
*
! * @throws NullPointerException if the <var>key</var> is <tt>null</tt>
! * @throws ClassCastException if the <var>key</var> is not of the type <tt>Object[]</tt>
! * @throws InvalidKeyException if the <var>key</var> does not conform to this <tt>TabularData</tt> instance's
! * <tt>TabularType</tt> definition
*/
public Object get(Object key) {
return get((Object[]) key);
}
/**
! * Returns the <tt>CompositeData</tt> value whose index is
! * <var>key</var>, or <tt>null</tt> if there is no value mapping
! * to <var>key</var>, in this <tt>TabularData</tt> instance.
*
* @param key the index of the value to get in this
! * <tt>TabularData</tt> instance; * must be valid with this
! * <tt>TabularData</tt> instance's row type definition; * must not
* be null.
*
* @return the value corresponding to <var>key</var>.
*
! * @throws NullPointerException if the <var>key</var> is <tt>null</tt>
! * @throws InvalidKeyException if the <var>key</var> does not conform to this <tt>TabularData</tt> instance's
! * <tt>TabularType</tt> type definition.
*/
public CompositeData get(Object[] key) {
// Check key is not null and valid with tabularType
// (throws NullPointerException, InvalidKeyException)
--- 236,315 ----
return this.containsKey(k);
}
/**
! * Returns {@code true} if and only if this {@code TabularData} instance contains a {@code CompositeData} value
! * (ie a row) whose index is the specified <var>key</var>. If <var>key</var> is {@code null} or does not conform to
! * this {@code TabularData} instance's {@code TabularType} definition, this method simply returns {@code false}.
*
! * @param key the index value whose presence in this {@code TabularData} instance is to be tested.
*
! * @return {@code true} if this {@code TabularData} indexes a row value with the specified key.
*/
public boolean containsKey(Object[] key) {
return ( key == null ? false : dataMap.containsKey(Arrays.asList(key)));
}
/**
! * Returns {@code true} if and only if this {@code TabularData} instance contains the specified
! * {@code CompositeData} value. If <var>value</var> is {@code null} or does not conform to
! * this {@code TabularData} instance's row type definition, this method simply returns {@code false}.
*
! * @param value the row value whose presence in this {@code TabularData} instance is to be tested.
*
! * @return {@code true} if this {@code TabularData} instance contains the specified row value.
*/
public boolean containsValue(CompositeData value) {
return dataMap.containsValue(value);
}
/**
! * Returns {@code true} if and only if this {@code TabularData} instance contains the specified
* value.
*
! * @param value the row value whose presence in this {@code TabularData} instance is to be tested.
*
! * @return {@code true} if this {@code TabularData} instance contains the specified row value.
*/
public boolean containsValue(Object value) {
return dataMap.containsValue(value);
}
/**
! * This method simply calls {@code get((Object[]) key)}.
*
! * @throws NullPointerException if the <var>key</var> is {@code null}
! * @throws ClassCastException if the <var>key</var> is not of the type {@code Object[]}
! * @throws InvalidKeyException if the <var>key</var> does not conform
! * to this {@code TabularData} instance's
! * {@code TabularType} definition
*/
public Object get(Object key) {
return get((Object[]) key);
}
/**
! * Returns the {@code CompositeData} value whose index is
! * <var>key</var>, or {@code null} if there is no value mapping
! * to <var>key</var>, in this {@code TabularData} instance.
*
* @param key the index of the value to get in this
! * {@code TabularData} instance; must be valid with this
! * {@code TabularData} instance's row type definition; must not
* be null.
*
* @return the value corresponding to <var>key</var>.
*
! * @throws NullPointerException if the <var>key</var> is {@code null}
! * @throws InvalidKeyException if the <var>key</var> does not conform
! * to this {@code TabularData} instance's
! * {@code TabularType} type definition.
*/
public CompositeData get(Object[] key) {
// Check key is not null and valid with tabularType
// (throws NullPointerException, InvalidKeyException)
*** 320,346 ****
/* *** Content modification operations (one element at a time) *** */
/**
! * This method simply calls <tt>put((CompositeData) value)</tt> and
! * therefore ignores its <var>key</var> parameter which can be <tt>null</tt>.
*
* @param key an ignored parameter.
* @param value the {@link CompositeData} to put.
*
* @return the value which is put
*
! * @throws NullPointerException if the <var>value</var> is <tt>null</tt>
* @throws ClassCastException if the <var>value</var> is not of
! * the type <tt>CompositeData</tt>
* @throws InvalidOpenTypeException if the <var>value</var> does
! * not conform to this <tt>TabularData</tt> instance's
! * <tt>TabularType</tt> definition
* @throws KeyAlreadyExistsException if the key for the
* <var>value</var> parameter, calculated according to this
! * <tt>TabularData</tt> instance's <tt>TabularType</tt> definition
* already maps to an existing value
*/
public Object put(Object key, Object value) {
internalPut((CompositeData) value);
return value; // should be return internalPut(...); (5090566)
--- 326,352 ----
/* *** Content modification operations (one element at a time) *** */
/**
! * This method simply calls {@code put((CompositeData) value)} and
! * therefore ignores its <var>key</var> parameter which can be {@code null}.
*
* @param key an ignored parameter.
* @param value the {@link CompositeData} to put.
*
* @return the value which is put
*
! * @throws NullPointerException if the <var>value</var> is {@code null}
* @throws ClassCastException if the <var>value</var> is not of
! * the type {@code CompositeData}
* @throws InvalidOpenTypeException if the <var>value</var> does
! * not conform to this {@code TabularData} instance's
! * {@code TabularType} definition
* @throws KeyAlreadyExistsException if the key for the
* <var>value</var> parameter, calculated according to this
! * {@code TabularData} instance's {@code TabularType} definition
* already maps to an existing value
*/
public Object put(Object key, Object value) {
internalPut((CompositeData) value);
return value; // should be return internalPut(...); (5090566)
*** 361,401 ****
//
return dataMap.put(index, value);
}
/**
! * This method simply calls <tt>remove((Object[]) key)</tt>.
*
! * @param key an <tt>Object[]</tt> representing the key to remove.
*
! * @return previous value associated with specified key, or <tt>null</tt>
* if there was no mapping for key.
*
! * @throws NullPointerException if the <var>key</var> is <tt>null</tt>
! * @throws ClassCastException if the <var>key</var> is not of the type <tt>Object[]</tt>
! * @throws InvalidKeyException if the <var>key</var> does not conform to this <tt>TabularData</tt> instance's
! * <tt>TabularType</tt> definition
*/
public Object remove(Object key) {
return remove((Object[]) key);
}
/**
! * Removes the <tt>CompositeData</tt> value whose index is <var>key</var> from this <tt>TabularData</tt> instance,
! * and returns the removed value, or returns <tt>null</tt> if there is no value whose index is <var>key</var>.
*
! * @param key the index of the value to get in this <tt>TabularData</tt> instance;
! * must be valid with this <tt>TabularData</tt> instance's row type definition;
* must not be null.
*
! * @return previous value associated with specified key, or <tt>null</tt>
* if there was no mapping for key.
*
! * @throws NullPointerException if the <var>key</var> is <tt>null</tt>
! * @throws InvalidKeyException if the <var>key</var> does not conform to this <tt>TabularData</tt> instance's
! * <tt>TabularType</tt> definition
*/
public CompositeData remove(Object[] key) {
// Check key is not null and valid with tabularType
// (throws NullPointerException, InvalidKeyException)
--- 367,407 ----
//
return dataMap.put(index, value);
}
/**
! * This method simply calls {@code remove((Object[]) key)}.
*
! * @param key an {@code Object[]} representing the key to remove.
*
! * @return previous value associated with specified key, or {@code null}
* if there was no mapping for key.
*
! * @throws NullPointerException if the <var>key</var> is {@code null}
! * @throws ClassCastException if the <var>key</var> is not of the type {@code Object[]}
! * @throws InvalidKeyException if the <var>key</var> does not conform to this {@code TabularData} instance's
! * {@code TabularType} definition
*/
public Object remove(Object key) {
return remove((Object[]) key);
}
/**
! * Removes the {@code CompositeData} value whose index is <var>key</var> from this {@code TabularData} instance,
! * and returns the removed value, or returns {@code null} if there is no value whose index is <var>key</var>.
*
! * @param key the index of the value to get in this {@code TabularData} instance;
! * must be valid with this {@code TabularData} instance's row type definition;
* must not be null.
*
! * @return previous value associated with specified key, or {@code null}
* if there was no mapping for key.
*
! * @throws NullPointerException if the <var>key</var> is {@code null}
! * @throws InvalidKeyException if the <var>key</var> does not conform to this {@code TabularData} instance's
! * {@code TabularType} definition
*/
public CompositeData remove(Object[] key) {
// Check key is not null and valid with tabularType
// (throws NullPointerException, InvalidKeyException)
*** 412,445 ****
/* *** Content modification bulk operations *** */
/**
* Add all the values contained in the specified map <var>t</var>
! * to this <tt>TabularData</tt> instance. This method converts
* the collection of values contained in this map into an array of
! * <tt>CompositeData</tt> values, if possible, and then call the
! * method <tt>putAll(CompositeData[])</tt>. Note that the keys
* used in the specified map <var>t</var> are ignored. This method
* allows, for example to add the content of another
! * <tt>TabularData</tt> instance with the same row type (but
* possibly different index names) into this instance.
*
* @param t the map whose values are to be added as new rows to
! * this <tt>TabularData</tt> instance; if <var>t</var> is
! * <tt>null</tt> or empty, this method returns without doing
* anything.
*
* @throws NullPointerException if a value in <var>t</var> is
! * <tt>null</tt>.
* @throws ClassCastException if a value in <var>t</var> is not an
! * instance of <tt>CompositeData</tt>.
* @throws InvalidOpenTypeException if a value in <var>t</var>
! * does not conform to this <tt>TabularData</tt> instance's row
* type definition.
* @throws KeyAlreadyExistsException if the index for a value in
* <var>t</var>, calculated according to this
! * <tt>TabularData</tt> instance's <tt>TabularType</tt> definition
* already maps to an existing value in this instance, or two
* values in <var>t</var> have the same index.
*/
public void putAll(Map<?,?> t) {
--- 418,451 ----
/* *** Content modification bulk operations *** */
/**
* Add all the values contained in the specified map <var>t</var>
! * to this {@code TabularData} instance. This method converts
* the collection of values contained in this map into an array of
! * {@code CompositeData} values, if possible, and then call the
! * method {@code putAll(CompositeData[])}. Note that the keys
* used in the specified map <var>t</var> are ignored. This method
* allows, for example to add the content of another
! * {@code TabularData} instance with the same row type (but
* possibly different index names) into this instance.
*
* @param t the map whose values are to be added as new rows to
! * this {@code TabularData} instance; if <var>t</var> is
! * {@code null} or empty, this method returns without doing
* anything.
*
* @throws NullPointerException if a value in <var>t</var> is
! * {@code null}.
* @throws ClassCastException if a value in <var>t</var> is not an
! * instance of {@code CompositeData}.
* @throws InvalidOpenTypeException if a value in <var>t</var>
! * does not conform to this {@code TabularData} instance's row
* type definition.
* @throws KeyAlreadyExistsException if the index for a value in
* <var>t</var>, calculated according to this
! * {@code TabularData} instance's {@code TabularType} definition
* already maps to an existing value in this instance, or two
* values in <var>t</var> have the same index.
*/
public void putAll(Map<?,?> t) {
*** 447,497 ****
//
if ( (t == null) || (t.size() == 0) ) {
return;
}
! // Convert the values in t into an array of <tt>CompositeData</tt>
//
CompositeData[] values;
try {
values =
t.values().toArray(new CompositeData[t.size()]);
} catch (java.lang.ArrayStoreException e) {
! throw new ClassCastException("Map argument t contains values which are not instances of <tt>CompositeData</tt>");
}
// Add the array of values
//
putAll(values);
}
/**
* Add all the elements in <var>values</var> to this
! * <tt>TabularData</tt> instance. If any element in
* <var>values</var> does not satisfy the constraints defined in
! * {@link #put(CompositeData) <tt>put</tt>}, or if any two
* elements in <var>values</var> have the same index calculated
! * according to this <tt>TabularData</tt> instance's
! * <tt>TabularType</tt> definition, then an exception describing
* the failure is thrown and no element of <var>values</var> is
! * added, thus leaving this <tt>TabularData</tt> instance
* unchanged.
*
* @param values the array of composite data values to be added as
! * new rows to this <tt>TabularData</tt> instance; if
! * <var>values</var> is <tt>null</tt> or empty, this method
* returns without doing anything.
*
* @throws NullPointerException if an element of <var>values</var>
! * is <tt>null</tt>
* @throws InvalidOpenTypeException if an element of
* <var>values</var> does not conform to this
! * <tt>TabularData</tt> instance's row type definition (ie its
! * <tt>TabularType</tt> definition)
* @throws KeyAlreadyExistsException if the index for an element
* of <var>values</var>, calculated according to this
! * <tt>TabularData</tt> instance's <tt>TabularType</tt> definition
* already maps to an existing value in this instance, or two
* elements of <var>values</var> have the same index
*/
public void putAll(CompositeData[] values) {
--- 453,503 ----
//
if ( (t == null) || (t.size() == 0) ) {
return;
}
! // Convert the values in t into an array of {@code CompositeData}
//
CompositeData[] values;
try {
values =
t.values().toArray(new CompositeData[t.size()]);
} catch (java.lang.ArrayStoreException e) {
! throw new ClassCastException("Map argument t contains values which are not instances of {@code CompositeData}");
}
// Add the array of values
//
putAll(values);
}
/**
* Add all the elements in <var>values</var> to this
! * {@code TabularData} instance. If any element in
* <var>values</var> does not satisfy the constraints defined in
! * {@link #put(CompositeData) put}, or if any two
* elements in <var>values</var> have the same index calculated
! * according to this {@code TabularData} instance's
! * {@code TabularType} definition, then an exception describing
* the failure is thrown and no element of <var>values</var> is
! * added, thus leaving this {@code TabularData} instance
* unchanged.
*
* @param values the array of composite data values to be added as
! * new rows to this {@code TabularData} instance; if
! * <var>values</var> is {@code null} or empty, this method
* returns without doing anything.
*
* @throws NullPointerException if an element of <var>values</var>
! * is {@code null}
* @throws InvalidOpenTypeException if an element of
* <var>values</var> does not conform to this
! * {@code TabularData} instance's row type definition (ie its
! * {@code TabularType} definition)
* @throws KeyAlreadyExistsException if the index for an element
* of <var>values</var>, calculated according to this
! * {@code TabularData} instance's {@code TabularType} definition
* already maps to an existing value in this instance, or two
* elements of <var>values</var> have the same index
*/
public void putAll(CompositeData[] values) {
*** 527,537 ****
dataMap.put(indexes.get(i), values[i]);
}
}
/**
! * Removes all rows from this <code>TabularDataSupport</code> instance.
*/
public void clear() {
dataMap.clear();
}
--- 533,543 ----
dataMap.put(indexes.get(i), values[i]);
}
}
/**
! * Removes all rows from this {@code TabularDataSupport} instance.
*/
public void clear() {
dataMap.clear();
}
*** 539,561 ****
/* *** Informational methods from java.util.Map *** */
/**
! * Returns the number of rows in this <code>TabularDataSupport</code> instance.
*
! * @return the number of rows in this <code>TabularDataSupport</code> instance.
*/
public int size() {
return dataMap.size();
}
/**
! * Returns <tt>true</tt> if this <code>TabularDataSupport</code> instance contains no rows.
*
! * @return <tt>true</tt> if this <code>TabularDataSupport</code> instance contains no rows.
*/
public boolean isEmpty() {
return (this.size() == 0);
}
--- 545,567 ----
/* *** Informational methods from java.util.Map *** */
/**
! * Returns the number of rows in this {@code TabularDataSupport} instance.
*
! * @return the number of rows in this {@code TabularDataSupport} instance.
*/
public int size() {
return dataMap.size();
}
/**
! * Returns {@code true} if this {@code TabularDataSupport} instance contains no rows.
*
! * @return {@code true} if this {@code TabularDataSupport} instance contains no rows.
*/
public boolean isEmpty() {
return (this.size() == 0);
}
*** 654,666 ****
/* *** Commodity methods from java.lang.Object *** */
/**
! * Returns a clone of this <code>TabularDataSupport</code> instance:
! * the clone is obtained by calling <tt>super.clone()</tt>, 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.
*/
/* We cannot use covariance here and return TabularDataSupport
because this would fail with existing code that subclassed
TabularDataSupport and overrode Object clone(). It would not
override the new clone(). */
--- 660,673 ----
/* *** Commodity methods from java.lang.Object *** */
/**
! * Returns a clone of this {@code TabularDataSupport} instance:
! * the clone is obtained by calling {@code 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.
*/
/* We cannot use covariance here and return TabularDataSupport
because this would fail with existing code that subclassed
TabularDataSupport and overrode Object clone(). It would not
override the new clone(). */
*** 675,699 ****
}
}
/**
! * Compares the specified <var>obj</var> parameter with this <code>TabularDataSupport</code> instance for equality.
* <p>
! * Returns <tt>true</tt> if and only if all of the following statements are true:
* <ul>
* <li><var>obj</var> is non null,</li>
! * <li><var>obj</var> also implements the <code>TabularData</code> interface,</li>
* <li>their tabular types are equal</li>
* <li>their contents (ie all CompositeData values) are equal.</li>
* </ul>
! * This ensures that this <tt>equals</tt> method works properly for <var>obj</var> parameters which are
! * different implementations of the <code>TabularData</code> interface.
* <br>
! * @param obj the object to be compared for equality with this <code>TabularDataSupport</code> instance;
*
! * @return <code>true</code> if the specified object is equal to this <code>TabularDataSupport</code> instance.
*/
public boolean equals(Object obj) {
// if obj is null, return false
//
--- 682,706 ----
}
}
/**
! * Compares the specified <var>obj</var> parameter with this {@code TabularDataSupport} instance for equality.
* <p>
! * Returns {@code true} if and only if all of the following statements are true:
* <ul>
* <li><var>obj</var> is non null,</li>
! * <li><var>obj</var> also implements the {@code TabularData} interface,</li>
* <li>their tabular types are equal</li>
* <li>their contents (ie all CompositeData values) are equal.</li>
* </ul>
! * This ensures that this {@code equals} method works properly for <var>obj</var> parameters which are
! * different implementations of the {@code TabularData} interface.
* <br>
! * @param obj the object to be compared for equality with this {@code TabularDataSupport} instance;
*
! * @return {@code true} if the specified object is equal to this {@code TabularDataSupport} instance.
*/
public boolean equals(Object obj) {
// if obj is null, return false
//
*** 736,761 ****
//
return true;
}
/**
! * Returns the hash code value for this <code>TabularDataSupport</code> instance.
* <p>
! * The hash code of a <code>TabularDataSupport</code> instance is the sum of the hash codes
! * of all elements of information used in <code>equals</code> comparisons
* (ie: its <i>tabular type</i> and its content, where the content is defined as all the CompositeData values).
* <p>
! * This ensures that <code> t1.equals(t2) </code> implies that <code> t1.hashCode()==t2.hashCode() </code>
! * for any two <code>TabularDataSupport</code> instances <code>t1</code> and <code>t2</code>,
* as required by the general contract of the method
* {@link Object#hashCode() Object.hashCode()}.
* <p>
! * However, note that another instance of a class implementing the <code>TabularData</code> interface
! * may be equal to this <code>TabularDataSupport</code> instance as defined by {@link #equals},
* but may have a different hash code if it is calculated differently.
*
! * @return the hash code value for this <code>TabularDataSupport</code> instance
*/
public int hashCode() {
int result = 0;
--- 743,768 ----
//
return true;
}
/**
! * Returns the hash code value for this {@code TabularDataSupport} instance.
* <p>
! * The hash code of a {@code TabularDataSupport} instance is the sum of the hash codes
! * of all elements of information used in {@code equals} comparisons
* (ie: its <i>tabular type</i> and its content, where the content is defined as all the CompositeData values).
* <p>
! * This ensures that {@code t1.equals(t2)} implies that {@code t1.hashCode()==t2.hashCode()}
! * for any two {@code TabularDataSupport} instances {@code t1} and {@code t2},
* as required by the general contract of the method
* {@link Object#hashCode() Object.hashCode()}.
* <p>
! * However, note that another instance of a class implementing the {@code TabularData} interface
! * may be equal to this {@code TabularDataSupport} instance as defined by {@link #equals},
* but may have a different hash code if it is calculated differently.
*
! * @return the hash code value for this {@code TabularDataSupport} instance
*/
public int hashCode() {
int result = 0;
*** 766,783 ****
return result;
}
/**
! * Returns a string representation of this <code>TabularDataSupport</code> instance.
* <p>
! * The string representation consists of the name of this class (ie <code>javax.management.openmbean.TabularDataSupport</code>),
* 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
! * <tt>dataMap.</tt>{@link java.util.HashMap#toString() toString()}).
*
! * @return a string representation of this <code>TabularDataSupport</code> instance
*/
public String toString() {
return new StringBuilder()
.append(this.getClass().getName())
--- 773,791 ----
return result;
}
/**
! * Returns a string representation of this {@code TabularDataSupport} instance.
* <p>
! * The string representation consists of the name of this class
! * (ie {@code 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
! * {@code dataMap.}{@link java.util.HashMap#toString() toString()}).
*
! * @return a string representation of this {@code TabularDataSupport} instance
*/
public String toString() {
return new StringBuilder()
.append(this.getClass().getName())
*** 794,819 ****
/* *** TabularDataSupport internal utility methods *** */
/**
! * Returns the index for value, assuming value is valid for this <tt>TabularData</tt> instance
* (ie value is not null, and its composite type is equal to row type).
*
! * The index is a List, and not an array, so that an index.equals(otherIndex) call will actually compare contents,
* not just the objects references as is done for an array object.
*
! * The returned List is unmodifiable so that once a row has been put into the dataMap, its index cannot be modified,
! * for example by a user that would attempt to modify an index contained in the Set returned by keySet().
*/
private List<?> internalCalculateIndex(CompositeData value) {
return Collections.unmodifiableList(Arrays.asList(value.getAll(this.indexNamesArray)));
}
/**
! * Checks if the specified key is valid for this <tt>TabularData</tt> instance.
*
* @throws NullPointerException
* @throws InvalidOpenTypeException
*/
private void checkKeyType(Object[] key) {
--- 802,830 ----
/* *** TabularDataSupport internal utility methods *** */
/**
! * Returns the index for value, assuming value is valid for this {@code TabularData} instance
* (ie value is not null, and its composite type is equal to row type).
*
! * The index is a List, and not an array, so that an
! * index.equals(otherIndex) call will actually compare contents,
* not just the objects references as is done for an array object.
*
! * The returned List is unmodifiable so that once a row has been put
! * into the dataMap, its index cannot be modified,
! * for example by a user that would attempt to modify an
! * index contained in the Set returned by keySet().
*/
private List<?> internalCalculateIndex(CompositeData value) {
return Collections.unmodifiableList(Arrays.asList(value.getAll(this.indexNamesArray)));
}
/**
! * Checks if the specified key is valid for this {@code TabularData} instance.
*
* @throws NullPointerException
* @throws InvalidOpenTypeException
*/
private void checkKeyType(Object[] key) {
*** 846,856 ****
}
}
}
/**
! * Checks the specified value's type is valid for this <tt>TabularData</tt> instance
* (ie value is not null, and its composite type is equal to row type).
*
* @throws NullPointerException
* @throws InvalidOpenTypeException
*/
--- 857,867 ----
}
}
}
/**
! * Checks the specified value's type is valid for this {@code TabularData} instance
* (ie value is not null, and its composite type is equal to row type).
*
* @throws NullPointerException
* @throws InvalidOpenTypeException
*/
*** 870,880 ****
"this TabularData instance's row type ["+ tabularType.getRowType() +"].");
}
}
/**
! * Checks if the specified value can be put (ie added) in this <tt>TabularData</tt> instance
* (ie value is not null, its composite type is equal to row type, and its index is not already used),
* and returns the index calculated for this value.
*
* The index is a List, and not an array, so that an index.equals(otherIndex) call will actually compare contents,
* not just the objects references as is done for an array object.
--- 881,891 ----
"this TabularData instance's row type ["+ tabularType.getRowType() +"].");
}
}
/**
! * Checks if the specified value can be put (ie added) in this {@code TabularData} instance
* (ie value is not null, its composite type is equal to row type, and its index is not already used),
* and returns the index calculated for this value.
*
* The index is a List, and not an array, so that an index.equals(otherIndex) call will actually compare contents,
* not just the objects references as is done for an array object.
< prev index next >