T
- the Java type that instances described by this type must have. For example, SimpleType.INTEGER
is a SimpleType<Integer>
which is a subclass of OpenType<Integer>
, meaning that an attribute, parameter, or return value that is described as a SimpleType.INTEGER
must have Java type Integer
.public abstract class OpenType<T> 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:
ALLOWED_CLASSNAMES_LIST
),public static final List<String> 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() } ;
@Deprecated public static final String[] ALLOWED_CLASSNAMES
Deprecated. Use ALLOWED_CLASSNAMES_LIST
instead.
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.
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_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 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. 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 datapublic 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_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 method getName()
of java.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)
public String getTypeName()
Returns the name of this OpenType
instance.
public String getDescription()
Returns the text description of this OpenType
instance.
public boolean isArray()
Returns true
if the open data values this open type describes are arrays, false
otherwise.
public abstract boolean isValue(Object obj)
Tests whether obj is a value for this open type.
obj
- the object to be tested for validity.true
if obj is a value for this open type, false
otherwise.public abstract boolean equals(Object obj)
Compares the specified obj
parameter with this open type instance for equality.
equals
in class Object
obj
- the object to compare to.obj
are equal.Object.hashCode()
, HashMap
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 by HashMap
.
The general contract of hashCode
is:
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. equals(Object)
method, then calling the hashCode
method on each of the two objects must produce the same integer result. 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 hash tables. 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 Java™ programming language.)
hashCode
in class Object
Object.equals(java.lang.Object)
, System.identityHashCode(java.lang.Object)
public abstract String toString()
Returns a string representation of this open type instance.
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.