Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| JavaTM 2 Platform Standard Ed. 5.0
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:
  1.5
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()` Returns a hash code value for the object.
`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.

  Overrides:
    `equals` in class `Object`
  Parameters:
    `obj` - the object to compare to.
  Returns:
    true if this object and `obj` are equal.
  See Also:
    `Object.hashCode()`, `Hashtable`

### 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 hashtables such as those provided by `java.util.Hashtable`.

  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 in `equals` 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(Object)` method, then calling the `hashCode` 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 `Object.equals(java.lang.Object)` method, then calling the `hashCode` 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 hashtables.

  As much as is reasonably practical, the hashCode method defined by class `Object` does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

  Overrides:
    `hashCode` in class `Object`
  Returns:
    a hash code value for this object.
  See Also:
    `Object.equals(java.lang.Object)`, `Hashtable`

### toString

    public abstract String toString()

  Returns a string representation of this open type instance.

  Overrides:
    `toString` in class `Object`
  Returns:
    the string representation.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| JavaTM 2 Platform Standard Ed. 5.0
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.