OpenType (Java 2 Platform Ent. Ed. v1.4) - Java Platform, Enterprise Edition v1.4 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

Java^TM 2 Platform
Ent. Ed. v1.4

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.management.openmbean
Class OpenType

java.lang.Object
  javax.management.openmbean.OpenType

All Implemented Interfaces:: Serializable

Direct Known Subclasses:: ArrayType, CompositeType, SimpleType, TabularType

public abstract class OpenType
extends Object
implements Serializable

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),
its name,
its description.

Since:: JMX 1.1
Version:: 3.16 02/10/01
Author:: Sun Microsystems, Inc.
See Also:: Serialized Form

Field Summary

static String[] ALLOWED_CLASSNAMES
          List of the fully qualified names of the Java classes allowed for open data values.

Constructor Summary

protected OpenType(String className, String typeName, String description)
          Constructs an OpenType instance (actually a subclass instance as OpenType is abstract), checking for the validity of the given parameters.

Method Summary

abstract boolean equals(Object obj)
          Compares the specified obj parameter with this open type instance for equality.

String getClassName()
          Returns the fully qualified Java class name of the open data values this open type describes.

String getDescription()
          Returns the text description of this OpenType instance.

String getTypeName()
          Returns the name of this OpenType instance.

abstract int hashCode()


boolean isArray()
          Returns true if the open data values this open type describes are arrays, false otherwise.

abstract boolean isValue(Object obj)
          Tests whether obj is a value for this open type.

abstract String toString()
          Returns a string representation of this open type instance.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALLOWED_CLASSNAMES

public static final String[] ALLOWED_CLASSNAMES

List of the fully qualified names of the Java classes allowed for open data values. A multidimensional array of any one of these classes is also an allowed for open data values.

ALLOWED_CLASSNAMES = { 
        "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() } ;

Constructor Detail

OpenType

protected OpenType(String className,
                   String typeName,
                   String description)
            throws OpenDataException

Constructs an OpenType instance (actually a subclass instance as OpenType 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 in ALLOWED_CLASSNAMES. A multidimensional array of any one of these classes is also an allowed class, in which case the class name follows the rules defined by the method getName of java.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 Detail

getClassName

public String 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 in ALLOWED_CLASSNAMES. A multidimensional array of any one of these classes is also an allowed class, in which case the class name follows the rules defined by the method getName of java.lang.Class. For example, a 3-dimensional array of Strings has for class name "[[[Ljava.lang.String;" (without the quotes).

Returns:: the class name.

getTypeName

public String getTypeName()

Returns the name of this OpenType instance.

Returns:: the type name.

getDescription

public String getDescription()

Returns the text description of this OpenType instance.

Returns:: the description.

isArray

public boolean isArray()

Returns true if the open data values this open type describes are arrays, false otherwise.

Returns:: true if this is an array type.

isValue

public abstract boolean isValue(Object obj)

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

public abstract boolean equals(Object obj)

Compares the specified obj parameter with this open type instance for equality.

Parameters:: obj - the object to compare to.
Returns:: true if this object and obj are equal.

hashCode

public abstract int hashCode()

toString

public abstract String toString()

Returns a string representation of this open type instance.

Returns:: the string representation.