-
- All Known Implementing Classes:
- TabularDataSupport
public interface TabularData
The TabularData interface specifies the behavior of a specific type of complex open data objects which represent tabular data structures.- Since:
- 1.5
-
-
Method Summary
Methods Modifier and Type Method and Description 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 CompositeData values (ie rows) from this TabularData instance.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
equals(Object obj)
Compares the specified obj parameter with thisTabularData
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
getTabularType()
Returns the tabular type describing this TabularData instance.int
hashCode()
Returns the hash code value for thisTabularData
instance.boolean
isEmpty()
Returns true if the number of CompositeData values (ie the number of rows) contained in this TabularData instance is zero.Set<?>
keySet()
Returns a set view of the keys (ie the index values) of theCompositeData
values (ie the rows) contained in thisTabularData
instance.void
put(CompositeData value)
Adds value to this TabularData instance.void
putAll(CompositeData[] values)
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
size()
Returns the number of CompositeData values (ie the number of rows) contained in this TabularData instance.String
toString()
Returns a string representation of thisTabularData
instance.Collection<?>
values()
Returns a collection view of theCompositeData
values (ie the rows) contained in thisTabularData
instance.
-
-
-
Method Detail
-
getTabularType
TabularType getTabularType()
Returns the tabular type describing this TabularData instance.- Returns:
- the tabular type.
-
calculateIndex
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.
- Throws:
NullPointerException
- if value is nullInvalidOpenTypeException
- if value does not conform to this TabularData instance's row type definition.
-
size
int size()
Returns the number of CompositeData values (ie the number of rows) contained in this TabularData instance.- Returns:
- the number of values contained.
-
isEmpty
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.
-
containsKey
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
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.
-
get
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.
- Throws:
NullPointerException
- if the key is nullInvalidKeyException
- if the key does not conform to this TabularData instance's * TabularType definition
-
put
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().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.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.- Throws:
NullPointerException
- if value is nullInvalidOpenTypeException
- if value does not conform to this TabularData instance's row type definition.KeyAlreadyExistsException
- if the index for value, calculated according to this TabularData instance's TabularType definition already maps to an existing value in the underlying HashMap.
-
remove
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.
- Throws:
NullPointerException
- if the key is nullInvalidKeyException
- if the key does not conform to this TabularData instance's TabularType definition
-
putAll
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 input
, 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.- Throws:
NullPointerException
- if an element of values is nullInvalidOpenTypeException
- if an element of values does not conform to this TabularData instance's row type definitionKeyAlreadyExistsException
- if the index for an element of values, calculated according to this TabularData instance's TabularType definition already maps to an existing value in this instance, or two elements of values have the same index.
-
clear
void clear()
Removes all CompositeData values (ie rows) from this TabularData instance.
-
keySet
Set<?> keySet()
Returns a set view of the keys (ie the index values) of theCompositeData
values (ie the rows) contained in thisTabularData
instance. The returnedSet
is aSet<List<?>>
but is declared as aSet<?>
for compatibility reasons. The returned set can be used to iterate over the keys.- Returns:
- a set view (
Set<List<?>>
) of the index values used in thisTabularData
instance.
-
values
Collection<?> values()
Returns a collection view of theCompositeData
values (ie the rows) contained in thisTabularData
instance. The returnedCollection
is aCollection<CompositeData>
but is declared as aCollection<?>
for compatibility reasons. The returned collection can be used to iterate over the values.- Returns:
- a collection view (
Collection<CompositeData>
) of the rows contained in thisTabularData
instance.
-
equals
boolean equals(Object obj)
Compares the specified obj parameter with thisTabularData
instance for equality.Returns true if and only if all of the following statements are true:
- obj is non null,
- obj also implements the
TabularData
interface, - their row types are equal
- their contents (ie index to value mappings) are equal
TabularData
interface.
- Overrides:
equals
in classObject
- Parameters:
obj
- the object to be compared for equality with thisTabularData
instance;- Returns:
true
if the specified object is equal to thisTabularData
instance.- See Also:
Object.hashCode()
,HashMap
-
hashCode
int hashCode()
Returns the hash code value for thisTabularData
instance.The hash code of a
TabularData
instance is the sum of the hash codes of all elements of information used inequals
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 thatt1.hashCode()==t2.hashCode()
for any twoTabularDataSupport
instancest1
andt2
, as required by the general contract of the methodObject.hashCode()
.- Overrides:
hashCode
in classObject
- Returns:
- the hash code value for this
TabularDataSupport
instance - See Also:
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
21/11/2024 21:27:53 Cette version de la page est en cache (à la date du 21/11/2024 21:27:53) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 01/09/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/management/openmbean/tabulardata.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.