-
- All Known Subinterfaces:
- OpenMBeanAttributeInfo
- All Known Implementing Classes:
- OpenMBeanAttributeInfoSupport, OpenMBeanParameterInfoSupport
public interface OpenMBeanParameterInfo
Describes a parameter used in one or more operations or constructors of an open MBean.
This interface declares the same methods as the class
MBeanParameterInfo
. A class implementing this interface (typicallyOpenMBeanParameterInfoSupport
) should extendMBeanParameterInfo
.- Since:
- 1.5
-
-
Method Summary
Methods Modifier and Type Method and Description boolean
equals(Object obj)
Compares the specified obj parameter with thisOpenMBeanParameterInfo
instance for equality.Object
getDefaultValue()
Returns the default value for this parameter, if it has one, or null otherwise.String
getDescription()
Returns a human readable description of the parameter described by this OpenMBeanParameterInfo instance.Set<?>
getLegalValues()
Returns the set of legal values for this parameter, if it has one, or null otherwise.Comparable<?>
getMaxValue()
Returns the maximal value for this parameter, if it has one, or null otherwise.Comparable<?>
getMinValue()
Returns the minimal value for this parameter, if it has one, or null otherwise.String
getName()
Returns the name of the parameter described by this OpenMBeanParameterInfo instance.OpenType<?>
getOpenType()
Returns the open type of the values of the parameter described by this OpenMBeanParameterInfo instance.boolean
hasDefaultValue()
Returns true if this parameter has a specified default value, or false otherwise.int
hashCode()
Returns the hash code value for thisOpenMBeanParameterInfo
instance.boolean
hasLegalValues()
Returns true if this parameter has a specified set of legal values, or false otherwise.boolean
hasMaxValue()
Returns true if this parameter has a specified maximal value, or false otherwise.boolean
hasMinValue()
Returns true if this parameter has a specified minimal value, or false otherwise.boolean
isValue(Object obj)
Tests whether obj is a valid value for the parameter described by thisOpenMBeanParameterInfo
instance.String
toString()
Returns a string representation of thisOpenMBeanParameterInfo
instance.
-
-
-
Method Detail
-
getDescription
String getDescription()
Returns a human readable description of the parameter described by this OpenMBeanParameterInfo instance.- Returns:
- the description.
-
getName
String getName()
Returns the name of the parameter described by this OpenMBeanParameterInfo instance.- Returns:
- the name.
-
getOpenType
OpenType<?> getOpenType()
Returns the open type of the values of the parameter described by this OpenMBeanParameterInfo instance.- Returns:
- the open type.
-
getDefaultValue
Object getDefaultValue()
Returns the default value for this parameter, if it has one, or null otherwise.- Returns:
- the default value.
-
getLegalValues
Set<?> getLegalValues()
Returns the set of legal values for this parameter, if it has one, or null otherwise.- Returns:
- the set of legal values.
-
getMinValue
Comparable<?> getMinValue()
Returns the minimal value for this parameter, if it has one, or null otherwise.- Returns:
- the minimum value.
-
getMaxValue
Comparable<?> getMaxValue()
Returns the maximal value for this parameter, if it has one, or null otherwise.- Returns:
- the maximum value.
-
hasDefaultValue
boolean hasDefaultValue()
Returns true if this parameter has a specified default value, or false otherwise.- Returns:
- true if there is a default value.
-
hasLegalValues
boolean hasLegalValues()
Returns true if this parameter has a specified set of legal values, or false otherwise.- Returns:
- true if there is a set of legal values.
-
hasMinValue
boolean hasMinValue()
Returns true if this parameter has a specified minimal value, or false otherwise.- Returns:
- true if there is a minimum value.
-
hasMaxValue
boolean hasMaxValue()
Returns true if this parameter has a specified maximal value, or false otherwise.- Returns:
- true if there is a maximum value.
-
isValue
boolean isValue(Object obj)
Tests whether obj is a valid value for the parameter described by thisOpenMBeanParameterInfo
instance.- Parameters:
obj
- the object to be tested.- Returns:
true
if obj is a valid value for the parameter described by thisOpenMBeanParameterInfo
instance,false
otherwise.
-
equals
boolean equals(Object obj)
Compares the specified obj parameter with thisOpenMBeanParameterInfo
instance for equality.Returns true if and only if all of the following statements are true:
- obj is non null,
- obj also implements the
OpenMBeanParameterInfo
interface, - their names are equal
- their open types are equal
- their default, min, max and legal values are equal.
OpenMBeanParameterInfo
interface.
- Overrides:
equals
in classObject
- Parameters:
obj
- the object to be compared for equality with thisOpenMBeanParameterInfo
instance;- Returns:
true
if the specified object is equal to thisOpenMBeanParameterInfo
instance.- See Also:
Object.hashCode()
,HashMap
-
hashCode
int hashCode()
Returns the hash code value for thisOpenMBeanParameterInfo
instance.The hash code of an
OpenMBeanParameterInfo
instance is the sum of the hash codes of all elements of information used inequals
comparisons (ie: its name, its open type, and its default, min, max and legal values).This ensures that
t1.equals(t2)
implies thatt1.hashCode()==t2.hashCode()
for any twoOpenMBeanParameterInfo
instancest1
andt2
, as required by the general contract of the methodObject.hashCode()
.- Overrides:
hashCode
in classObject
- Returns:
- the hash code value for this
OpenMBeanParameterInfo
instance - See Also:
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
-
toString
String toString()
Returns a string representation of thisOpenMBeanParameterInfo
instance.The string representation consists of the name of this class (ie
javax.management.openmbean.OpenMBeanParameterInfo
), the string representation of the name and open type of the described parameter, and the string representation of its default, min, max and legal values.
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-javax/management/openmbean/openmbeanparameterinfo.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.