javax.management.openmbean
Interface OpenMBeanParameterInfo
- OpenMBeanAttributeInfo
- OpenMBeanAttributeInfoSupport, OpenMBeanParameterInfoSupport
Describes the parameters of a constructor or operation associated
with an open management bean. This interface includes those methods
specified by
MBeanParameterInfo, so
implementations should extend this class.
boolean | equals(Object obj)- Compares this parameter with the supplied object.
|
Object | getDefaultValue()- Returns the default value of this parameter, or
null
if there is no default value.
|
String | getDescription()- Returns a description of this parameter.
|
Set | getLegalValues()- Returns a
Set enumerating the legal values
of this parameter, or null if no such limited
set exists for this parameter.
|
Comparable | getMaxValue()- Returns the maximum value of this parameter, or
null
if there is no maximum.
|
Comparable | getMinValue()- Returns the minimum value of this parameter, or
null
if there is no minimum.
|
String | getName()- Returns the name of this parameter.
|
OpenType | getOpenType()- Returns the open type instance which represents the type of this
parameter.
|
boolean | hasDefaultValue()- Returns true if this parameter has a default value.
|
boolean | hasLegalValues()- Returns true if there is a set of legal values for this
parameter.
|
boolean | hasMaxValue()- Returns true if there is a maximum value for this parameter.
|
boolean | hasMinValue()- Returns true if there is a minimum value for this parameter.
|
int | hashCode()- Returns the hashcode of the parameter information as the sum of
the hashcodes of the name, open type, default value, maximum
value, minimum value and the set of legal values.
|
boolean | isValue(Object obj)- Returns true if the specified object is a valid value for
this parameter.
|
String | toString()- Returns a textual representation of this instance.
|
equals
public boolean equals(Object obj)
Compares this parameter with the supplied object. This returns
true iff the object is an instance of
OpenMBeanParameterInfo
with an equal name and open type and the same default, minimum,
maximum and legal values.
- equals in interface Object
obj - the object to compare.
- true if the object is a
OpenMBeanParameterInfo
instance,
name.equals(object.getName()),
openType.equals(object.getOpenType()),
defaultValue.equals(object.getDefaultValue()),
minValue.equals(object.getMinValue()),
maxValue.equals(object.getMaxValue()),
and legalValues.equals(object.getLegalValues()).
getDefaultValue
public Object getDefaultValue()
Returns the default value of this parameter, or null
if there is no default value.
- the default value of the parameter, or
null
if there is no default.
getDescription
public String getDescription()
Returns a description of this parameter.
- a human-readable description.
getLegalValues
public Set getLegalValues()
Returns a
Set enumerating the legal values
of this parameter, or
null if no such limited
set exists for this parameter.
- a set of legal values, or
null if no such
set exists.
getMaxValue
public Comparable getMaxValue()
Returns the maximum value of this parameter, or null
if there is no maximum.
- the maximum value, or
null if none exists.
getMinValue
public Comparable getMinValue()
Returns the minimum value of this parameter, or null
if there is no minimum.
- the minimum value, or
null if none exists.
getName
public String getName()
Returns the name of this parameter.
- the name of the parameter.
getOpenType
public OpenType getOpenType()
Returns the open type instance which represents the type of this
parameter.
- the open type of this parameter.
hasDefaultValue
public boolean hasDefaultValue()
Returns true if this parameter has a default value.
- true if this parameter has a default.
hasLegalValues
public boolean hasLegalValues()
Returns true if there is a set of legal values for this
parameter.
- true if a set of legal values exists for this
parameter.
hasMaxValue
public boolean hasMaxValue()
Returns true if there is a maximum value for this parameter.
- true if a maximum value exists for this parameter.
hasMinValue
public boolean hasMinValue()
Returns true if there is a minimum value for this parameter.
- true if a minimum value exists for this parameter.
hashCode
public int hashCode()
Returns the hashcode of the parameter information as the sum of
the hashcodes of the name, open type, default value, maximum
value, minimum value and the set of legal values.
- hashCode in interface Object
- the hashcode of the parameter information.
isValue
public boolean isValue(Object obj)
Returns true if the specified object is a valid value for
this parameter.
obj - the object to test.
- true if
obj is a valid value for this
parameter.
toString
public String toString()
Returns a textual representation of this instance. This
is constructed using the class name
(javax.management.openmbean.OpenMBeanParameterInfo)
along with the name, open type, default, minimum, maximum
and legal values of the parameter.
- toString in interface Object
- a @link{java.lang.String} instance representing
the instance in textual form.
OpenMBeanParameterInfo.java -- Open typed info about a parameter.
Copyright (C) 2006 Free Software Foundation, Inc.
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module. An independent module is a module which is not derived from
or based on this library. If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so. If you do not wish to do so, delete this
exception statement from your version.