management/openmbean/TabularData.java

40  * The {@code TabularData} interface specifies the behavior of a specific type of complex <i>open data</i> objects
45 public interface TabularData /*extends Map*/ {
48     /* *** TabularData specific information methods *** */
53      * {@code TabularData} instance.
61      * Calculates the index that would be used in this {@code TabularData} instance to refer to the specified
64      * but does not check if the calculated index is already used to refer to a value in this {@code TabularData} instance.
67      *                                    {@code TabularData} instance is to be calculated;
71      * @return the index that the specified <var>value</var> would have in this {@code TabularData} instance.
75      * @throws InvalidOpenTypeException   if <var>value</var> does not conform to this {@code TabularData} instance's
87      * number of rows) contained in this {@code TabularData}
97      * {@code TabularData} instance is zero.
99      * @return true if this {@code TabularData} is empty.
104      * Returns {@code true} if and only if this {@code TabularData} instance contains a {@code CompositeData} value
106      * this {@code TabularData} instance's {@code TabularType} definition, this method simply returns {@code false}.
108      * @param  key  the index value whose presence in this {@code TabularData} instance is to be tested.
110      * @return  {@code true} if this {@code TabularData} indexes a row value with the specified key.
115      * Returns {@code true} if and only if this {@code TabularData} instance contains the specified
117      * this {@code TabularData} instance's row type definition, this method simply returns {@code false}.
119      * @param  value  the row value whose presence in this {@code TabularData} instance is to be tested.
121      * @return  {@code true} if this {@code TabularData} instance contains the specified row value.
128      * to <var>key</var>, in this {@code TabularData} instance.
137      * conform to this {@code TabularData} instance's *
149      * Adds <var>value</var> to this {@code TabularData} instance.
154      * value in this {@code TabularData} instance whose index is the
157      * to this {@code TabularData} instance's {@code TabularType}
161      * @param  value                      the composite data value to be added as a new row to this {@code TabularData} instance;
166      * @throws InvalidOpenTypeException   if <var>value</var> does not conform to this {@code TabularData} instance's
169      *                                    this {@code TabularData} instance's {@code TabularType} definition
175      * Removes the {@code CompositeData} value whose index is <var>key</var> from this {@code TabularData} instance,
178      * @param  key  the index of the value to get in this {@code TabularData} instance;
179      *              must be valid with this {@code TabularData} instance's row type definition;
186      * @throws InvalidKeyException   if the <var>key</var> does not conform to this {@code TabularData} instance's
198      * Add all the elements in <var>values</var> to this {@code TabularData} instance.
200      * or if any two elements in <var>values</var> have the same index calculated according to this {@code TabularData}
202      * and no element of <var>values</var> is added,  thus leaving this {@code TabularData} instance unchanged.
204      * @param  values  the array of composite data values to be added as new rows to this {@code TabularData} instance;
209      *                                    this {@code TabularData} instance's row type definition
211      *                                    this {@code TabularData} instance's {@code TabularType} definition
218      * Removes all {@code CompositeData} values (ie rows) from this {@code TabularData} instance.
231      * {@code TabularData} instance. The returned {@code Set} is a
237      * used in this {@code TabularData} instance.
243      * (ie the rows) contained in this {@code TabularData} instance.
249      * of the rows contained in this {@code TabularData} instance.
260      * Compares the specified <var>obj</var> parameter with this {@code TabularData} instance for equality.
265      * <li><var>obj</var> also implements the {@code TabularData} interface,</li>
270      * different implementations of the {@code TabularData} interface.
272      * @param  obj  the object to be compared for equality with this {@code TabularData} instance;
274      * @return  {@code true} if the specified object is equal to this {@code TabularData} instance.
279      * Returns the hash code value for this {@code TabularData} instance.
281      * The hash code of a {@code TabularData} instance is the sum of the hash codes
295      * Returns a string representation of this {@code TabularData} instance.
300      * @return  a string representation of this {@code TabularData} instance