java.lang.Object
javax.management.openmbean.OpenType<T>
- Type Parameters:
T
- the Java type that instances described by this type must have. For example,SimpleType.INTEGER
is aSimpleType<Integer>
which is a subclass ofOpenType<Integer>
, meaning that an attribute, parameter, or return value that is described as aSimpleType.INTEGER
must have Java typeInteger
.
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
ArrayType
,CompositeType
,SimpleType
,TabularType
The
OpenType
class is the parent abstract class of all classes which describe the actual open type
of open data values.
An open type is defined by:
- the fully qualified Java class name of the open data values this type describes;
note that only a limited set of Java classes is allowed for open data values
(see
ALLOWED_CLASSNAMES_LIST
), - its name,
- its description.
- Since:
- 1.5
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String[]
Deprecated.List of the fully qualified names of the Java classes allowed for open data values. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract boolean
Compares the specifiedobj
parameter with this open type instance for equality.Returns the fully qualified Java class name of the open data values this open type describes.Returns the text description of thisOpenType
instance.Returns the name of thisOpenType
instance.abstract int
hashCode()
Returns a hash code value for the object.boolean
isArray()
Returnstrue
if the open data values this open type describes are arrays,false
otherwise.abstract boolean
Tests whether obj is a value for this open type.abstract String
toString()
Returns a string representation of this open type instance.
-
Field Details
-
ALLOWED_CLASSNAMES_LIST
List of the fully qualified names of the Java classes allowed for open data values. A multidimensional array of any one of these classes or their corresponding primitive types is also an allowed class for open data values.ALLOWED_CLASSNAMES_LIST = { "java.lang.Void", "java.lang.Boolean", "java.lang.Character", "java.lang.Byte", "java.lang.Short", "java.lang.Integer", "java.lang.Long", "java.lang.Float", "java.lang.Double", "java.lang.String", "java.math.BigDecimal", "java.math.BigInteger", "java.util.Date", "javax.management.ObjectName", CompositeData.class.getName(), TabularData.class.getName() } ;
-
ALLOWED_CLASSNAMES
Deprecated.UseALLOWED_CLASSNAMES_LIST
instead.
-
-
Constructor Details
-
OpenType
Constructs anOpenType
instance (actually a subclass instance asOpenType
is abstract), checking for the validity of the given parameters. The validity constraints are described below for each parameter.
- Parameters:
className
- The fully qualified Java class name of the open data values this open type describes. The valid Java class names allowed for open data values are listed inALLOWED_CLASSNAMES_LIST
. A multidimensional array of any one of these classes or their corresponding primitive types is also an allowed class, in which case the class name follows the rules defined by the methodgetName()
ofjava.lang.Class
. For example, a 3-dimensional array of Strings has for class name "[[[Ljava.lang.String;
" (without the quotes).
typeName
- The name given to the open type this instance represents; cannot be a null or empty string.
description
- The human readable description of the open type this instance represents; cannot be a null or empty string.
- Throws:
IllegalArgumentException
- if className, typeName or description is a null or empty string
OpenDataException
- if className is not one of the allowed Java class names for open data
-
-
Method Details
-
getClassName
Returns the fully qualified Java class name of the open data values this open type describes. The only possible Java class names for open data values are listed inALLOWED_CLASSNAMES_LIST
. A multidimensional array of any one of these classes or their corresponding primitive types is also an allowed class, in which case the class name follows the rules defined by the methodgetName()
ofjava.lang.Class
. For example, a 3-dimensional array of Strings has for class name "[[[Ljava.lang.String;
" (without the quotes), a 3-dimensional array of Integers has for class name "[[[Ljava.lang.Integer;
" (without the quotes), and a 3-dimensional array of int has for class name "[[[I
" (without the quotes)- Returns:
- the class name.
-
getTypeName
Returns the name of thisOpenType
instance.- Returns:
- the type name.
-
getDescription
Returns the text description of thisOpenType
instance.- Returns:
- the description.
-
isArray
public boolean isArray()Returnstrue
if the open data values this open type describes are arrays,false
otherwise.- Returns:
- true if this is an array type.
-
isValue
Tests whether obj is a value for this open type.- Parameters:
obj
- the object to be tested for validity.- Returns:
true
if obj is a value for this open type,false
otherwise.
-
equals
Compares the specifiedobj
parameter with this open type instance for equality. -
hashCode
public abstract int hashCode()Description copied from class:Object
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided byHashMap
.The general contract of
hashCode
is:- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
hashCode
method must consistently return the same integer, provided no information used inequals
comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equals
method, then calling thehashCode
method on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal
according to the
equals
method, then calling thehashCode
method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
-
toString
Returns a string representation of this open type instance.
-
ALLOWED_CLASSNAMES_LIST
instead.