ArrayTypepublic class ArrayType extends OpenType The ArrayType class is the open type class whose instances describe
all open data values which are n-dimensional arrays of open data values.
Examples of valid {@code ArrayType} instances are:
// 2-dimension array of java.lang.String
ArrayType a1 = new ArrayType(2, SimpleType.STRING);
// 1-dimension array of int
ArrayType a2 = new ArrayType(SimpleType.INTEGER, true);
// 1-dimension array of java.lang.Integer
ArrayType a3 = new ArrayType(SimpleType.INTEGER, false);
// 4-dimension array of int
ArrayType a4 = new ArrayType(3, a2);
// 4-dimension array of java.lang.Integer
ArrayType a5 = new ArrayType(3, a3);
// 1-dimension array of java.lang.String
ArrayType a6 = new ArrayType(SimpleType.STRING, false);
// 1-dimension array of long
ArrayType a7 = new ArrayType(SimpleType.LONG, true);
// 1-dimension array of java.lang.Integer
ArrayType a8 = ArrayType.getArrayType(SimpleType.INTEGER);
// 2-dimension array of java.lang.Integer
ArrayType a9 = ArrayType.getArrayType(a8);
// 2-dimension array of int
ArrayType a10 = ArrayType.getPrimitiveArrayType(int[][].class);
// 3-dimension array of int
ArrayType a11 = ArrayType.getArrayType(a10);
// 1-dimension array of float
ArrayType a12 = ArrayType.getPrimitiveArrayType(float[].class);
// 2-dimension array of float
ArrayType a13 = ArrayType.getArrayType(a12);
// 1-dimension array of javax.management.ObjectName
ArrayType a14 = ArrayType.getArrayType(SimpleType.OBJECTNAME);
// 2-dimension array of javax.management.ObjectName
ArrayType a15 = ArrayType.getArrayType(a14);
// 3-dimension array of java.lang.String
ArrayType a16 = new ArrayType(3, SimpleType.STRING);
// 1-dimension array of java.lang.String
ArrayType a17 = new ArrayType(1, SimpleType.STRING);
// 2-dimension array of java.lang.String
ArrayType a18 = new ArrayType(1, a17);
// 3-dimension array of java.lang.String
ArrayType a19 = new ArrayType(1, a18);
|
Fields Summary |
---|
static final long | serialVersionUID | private int | dimension | private OpenType | elementType | private boolean | primitiveArray | private transient Integer | myHashCode | private transient String | myToString | private static final int | PRIMITIVE_WRAPPER_NAME_INDEX | private static final int | PRIMITIVE_TYPE_NAME_INDEX | private static final int | PRIMITIVE_TYPE_KEY_INDEX | private static final int | PRIMITIVE_OPEN_TYPE_INDEX | private static final Object[] | PRIMITIVE_ARRAY_TYPES |
Constructors Summary |
---|
public ArrayType(int dimension, OpenType elementType)Constructs an ArrayType instance describing open data values which are
arrays with dimension dimension of elements whose open type is elementType.
When invoked on an ArrayType instance, the {@link OpenType#getClassName() getClassName} method
returns the class name of the array instances it describes (following the rules defined by the
{@link Class#getName() getName} method of java.lang.Class ), not the class name of the array elements
(which is returned by a call to getElementOpenType().getClassName()).
The internal field corresponding to the type name of this ArrayType instance is also set to
the class name of the array instances it describes.
In other words, the methods getClassName and getTypeName return the same string value.
The internal field corresponding to the description of this ArrayType instance is set to a string value
which follows the following template:
- if non-primitive array: <dimension>-dimension array of <element_class_name>
- if primitive array: <dimension>-dimension array of <primitive_type_of_the_element_class_name>
As an example, the following piece of code:
ArrayType t = new ArrayType(3, SimpleType.STRING);
System.out.println("array class name = " + t.getClassName());
System.out.println("element class name = " + t.getElementOpenType().getClassName());
System.out.println("array type name = " + t.getTypeName());
System.out.println("array type description = " + t.getDescription());
would produce the following output:
array class name = [[[Ljava.lang.String;
element class name = java.lang.String
array type name = [[[Ljava.lang.String;
array type description = 3-dimension array of java.lang.String
And the following piece of code which is equivalent to the one listed
above would also produce the same output:
ArrayType t1 = new ArrayType(1, SimpleType.STRING);
ArrayType t2 = new ArrayType(1, t1);
ArrayType t3 = new ArrayType(1, t2);
System.out.println("array class name = " + t3.getClassName());
System.out.println("element class name = " + t3.getElementOpenType().getClassName());
System.out.println("array type name = " + t3.getTypeName());
System.out.println("array type description = " + t3.getDescription());
// Check and construct state defined by parent.
// We can't use the package-private OpenType constructor because
// we don't know if the elementType parameter is sane.
super(buildArrayClassName(dimension, elementType),
buildArrayClassName(dimension, elementType),
buildArrayDescription(dimension, elementType));
// Check and construct state specific to ArrayType
//
if (elementType.isArray()) {
ArrayType at = (ArrayType) elementType;
this.dimension = at.getDimension() + dimension;
this.elementType = at.getElementOpenType();
this.primitiveArray = at.isPrimitiveArray();
} else {
this.dimension = dimension;
this.elementType = elementType;
this.primitiveArray = false;
}
| public ArrayType(SimpleType elementType, boolean primitiveArray)Constructs a unidimensional {@code ArrayType} instance for the
supplied {@code SimpleType}.
This constructor supports the creation of arrays of primitive
types when {@code primitiveArray} is {@code true}.
For primitive arrays the {@link #getElementOpenType()} method
returns the {@link SimpleType} corresponding to the wrapper
type of the primitive type of the array.
When invoked on an ArrayType instance, the {@link OpenType#getClassName() getClassName} method
returns the class name of the array instances it describes (following the rules defined by the
{@link Class#getName() getName} method of java.lang.Class ), not the class name of the array elements
(which is returned by a call to getElementOpenType().getClassName()).
The internal field corresponding to the type name of this ArrayType instance is also set to
the class name of the array instances it describes.
In other words, the methods getClassName and getTypeName return the same string value.
The internal field corresponding to the description of this ArrayType instance is set to a string value
which follows the following template:
- if non-primitive array: 1-dimension array of <element_class_name>
- if primitive array: 1-dimension array of <primitive_type_of_the_element_class_name>
As an example, the following piece of code:
ArrayType t = new ArrayType(SimpleType.INTEGER, true);
System.out.println("array class name = " + t.getClassName());
System.out.println("element class name = " + t.getElementOpenType().getClassName());
System.out.println("array type name = " + t.getTypeName());
System.out.println("array type description = " + t.getDescription());
would produce the following output:
array class name = [I
element class name = java.lang.Integer
array type name = [I
array type description = 1-dimension array of int
// Check and construct state defined by parent.
// We can call the package-private OpenType constructor because the
// set of SimpleTypes is fixed and SimpleType can't be subclassed.
super(buildArrayClassName(1, elementType, primitiveArray),
buildArrayClassName(1, elementType, primitiveArray),
buildArrayDescription(1, elementType, primitiveArray),
true);
// Check and construct state specific to ArrayType
//
this.dimension = 1;
this.elementType = elementType;
this.primitiveArray = primitiveArray;
| ArrayType(String className, String typeName, String description, int dimension, OpenType elementType, boolean primitiveArray)
super(className, typeName, description, true);
this.dimension = dimension;
this.elementType = elementType;
this.primitiveArray = primitiveArray;
|
Methods Summary |
---|
private static java.lang.String | buildArrayClassName(int dimension, javax.management.openmbean.OpenType elementType)
boolean isPrimitiveArray = false;
if (elementType.isArray()) {
isPrimitiveArray = ((ArrayType) elementType).isPrimitiveArray();
}
return buildArrayClassName(dimension, elementType, isPrimitiveArray);
| private static java.lang.String | buildArrayClassName(int dimension, javax.management.openmbean.OpenType elementType, boolean isPrimitiveArray)
if (dimension < 1) {
throw new IllegalArgumentException(
"Value of argument dimension must be greater than 0");
}
StringBuilder result = new StringBuilder();
String elementClassName = elementType.getClassName();
// Add N (= dimension) additional '[' characters to the existing array
for (int i = 1; i <= dimension; i++) {
result.append('[");
}
if (elementType.isArray()) {
result.append(elementClassName);
} else {
if (isPrimitiveArray) {
final String key = getPrimitiveTypeKey(elementClassName);
// Ideally we should throw an IllegalArgumentException here,
// but for compatibility reasons we throw an OpenDataException.
// (used to be thrown by OpenType() constructor).
//
if (key == null)
throw new OpenDataException("Element type is not primitive: "
+ elementClassName);
result.append(key);
} else {
result.append("L");
result.append(elementClassName);
result.append(';");
}
}
return result.toString();
| private static java.lang.String | buildArrayDescription(int dimension, javax.management.openmbean.OpenType elementType)
boolean isPrimitiveArray = false;
if (elementType.isArray()) {
isPrimitiveArray = ((ArrayType) elementType).isPrimitiveArray();
}
return buildArrayDescription(dimension, elementType, isPrimitiveArray);
| private static java.lang.String | buildArrayDescription(int dimension, javax.management.openmbean.OpenType elementType, boolean isPrimitiveArray)
if (elementType.isArray()) {
ArrayType at = (ArrayType) elementType;
dimension += at.getDimension();
elementType = at.getElementOpenType();
isPrimitiveArray = at.isPrimitiveArray();
}
StringBuilder result =
new StringBuilder(dimension + "-dimension array of ");
final String elementClassName = elementType.getClassName();
if (isPrimitiveArray) {
// Convert from wrapper type to primitive type
final String primitiveType =
getPrimitiveTypeName(elementClassName);
// Ideally we should throw an IllegalArgumentException here,
// but for compatibility reasons we throw an OpenDataException.
// (used to be thrown by OpenType() constructor).
//
if (primitiveType == null)
throw new OpenDataException("Element is not a primitive type: "+
elementClassName);
result.append(primitiveType);
} else {
result.append(elementClassName);
}
return result.toString();
| private boolean | checkElementsType(java.lang.Object[] x_dim_Array, int dim)Returns true if and only if all elements contained in the array argument x_dim_Array of dimension dim
are valid values (ie either null or of the right openType)
for the element open type specified by this ArrayType instance.
This method's implementation uses recursion to go down the dimensions of the array argument.
// if the elements of x_dim_Array are themselves array: go down recursively....
if ( dim > 1 ) {
for (int i=0; i<x_dim_Array.length; i++) {
if ( ! checkElementsType((Object[])x_dim_Array[i], dim-1) ) {
return false;
}
}
return true;
}
// ...else, for a non-empty array, each element must be a valid value: either null or of the right openType
else {
for (int i=0; i<x_dim_Array.length; i++) {
if ( (x_dim_Array[i] != null) && (! this.getElementOpenType().isValue(x_dim_Array[i])) ) {
return false;
}
}
return true;
}
| private javax.management.openmbean.ArrayType | convertFromPrimitiveToWrapperTypes()
String cn = getClassName();
String tn = getTypeName();
String d = getDescription();
for (Object[] typeDescr : PRIMITIVE_ARRAY_TYPES) {
if (cn.indexOf((String) typeDescr[PRIMITIVE_TYPE_KEY_INDEX]) != -1) {
cn = cn.replaceFirst(
(String) typeDescr[PRIMITIVE_TYPE_KEY_INDEX],
"L" + typeDescr[PRIMITIVE_WRAPPER_NAME_INDEX] + ";");
tn = tn.replaceFirst(
(String) typeDescr[PRIMITIVE_TYPE_KEY_INDEX],
"L" + typeDescr[PRIMITIVE_WRAPPER_NAME_INDEX] + ";");
d = d.replaceFirst(
(String) typeDescr[PRIMITIVE_TYPE_NAME_INDEX],
(String) typeDescr[PRIMITIVE_WRAPPER_NAME_INDEX]);
break;
}
}
return new ArrayType(cn, tn, d,
dimension, elementType, primitiveArray);
| private javax.management.openmbean.ArrayType | convertFromWrapperToPrimitiveTypes()
String cn = getClassName();
String tn = getTypeName();
String d = getDescription();
for (Object[] typeDescr : PRIMITIVE_ARRAY_TYPES) {
if (cn.indexOf((String)typeDescr[PRIMITIVE_WRAPPER_NAME_INDEX]) != -1) {
cn = cn.replaceFirst(
"L" + typeDescr[PRIMITIVE_WRAPPER_NAME_INDEX] + ";",
(String) typeDescr[PRIMITIVE_TYPE_KEY_INDEX]);
tn = tn.replaceFirst(
"L" + typeDescr[PRIMITIVE_WRAPPER_NAME_INDEX] + ";",
(String) typeDescr[PRIMITIVE_TYPE_KEY_INDEX]);
d = d.replaceFirst(
(String) typeDescr[PRIMITIVE_WRAPPER_NAME_INDEX],
(String) typeDescr[PRIMITIVE_TYPE_NAME_INDEX]);
break;
}
}
return new ArrayType(cn, tn, d,
dimension, elementType, primitiveArray);
| public boolean | equals(java.lang.Object obj)Compares the specified obj parameter with this
ArrayType instance for equality.
Two ArrayType instances are equal if and only if they
describe array instances which have the same dimension, elements'
open type and primitive array flag.
// if obj is null, return false
//
if (obj == null) {
return false;
}
// if obj is not an ArrayType, return false
//
if (!(obj instanceof ArrayType))
return false;
ArrayType other = (ArrayType) obj;
// if other's dimension is different than this instance's, return false
//
if (this.dimension != other.dimension) {
return false;
}
// Test if other's elementType field is the same as for this instance
//
if (!this.elementType.equals(other.elementType)) {
return false;
}
// Test if other's primitiveArray flag is the same as for this instance
//
return this.primitiveArray == other.primitiveArray;
| public static javax.management.openmbean.ArrayType | getArrayType(javax.management.openmbean.OpenType elementType)Create an {@code ArrayType} instance in a type-safe manner.
Multidimensional arrays can be built up by calling this method as many
times as necessary.
Calling this method twice with the same parameters may return the same
object or two equal but not identical objects.
As an example, the following piece of code:
ArrayType t1 = ArrayType.getArrayType(SimpleType.STRING);
ArrayType t2 = ArrayType.getArrayType(t1);
ArrayType t3 = ArrayType.getArrayType(t2);
System.out.println("array class name = " + t3.getClassName());
System.out.println("element class name = " + t3.getElementOpenType().getClassName());
System.out.println("array type name = " + t3.getTypeName());
System.out.println("array type description = " + t3.getDescription());
would produce the following output:
array class name = [[[Ljava.lang.String;
element class name = java.lang.String
array type name = [[[Ljava.lang.String;
array type description = 3-dimension array of java.lang.String
return new ArrayType<E[]>(1, elementType);
| public int | getDimension()Returns the dimension of arrays described by this ArrayType instance.
return dimension;
| public javax.management.openmbean.OpenType | getElementOpenType()Returns the open type of element values contained in the arrays described by this ArrayType instance.
return elementType;
| public static javax.management.openmbean.ArrayType | getPrimitiveArrayType(java.lang.Class arrayClass)Create an {@code ArrayType} instance in a type-safe manner.
Calling this method twice with the same parameters may return the
same object or two equal but not identical objects.
As an example, the following piece of code:
ArrayType t = ArrayType.getPrimitiveArrayType(int[][][].class);
System.out.println("array class name = " + t.getClassName());
System.out.println("element class name = " + t.getElementOpenType().getClassName());
System.out.println("array type name = " + t.getTypeName());
System.out.println("array type description = " + t.getDescription());
would produce the following output:
array class name = [[[I
element class name = java.lang.Integer
array type name = [[[I
array type description = 3-dimension array of int
// Check if the supplied parameter is an array
//
if (!arrayClass.isArray()) {
throw new IllegalArgumentException("arrayClass must be an array");
}
// Calculate array dimension and component type name
//
int n = 1;
Class<?> componentType = arrayClass.getComponentType();
while (componentType.isArray()) {
n++;
componentType = componentType.getComponentType();
}
String componentTypeName = componentType.getName();
// Check if the array's component type is a primitive type
//
if (!componentType.isPrimitive()) {
throw new IllegalArgumentException(
"component type of the array must be a primitive type");
}
// Map component type name to corresponding SimpleType
//
final SimpleType<?> simpleType =
getPrimitiveOpenType(componentTypeName);
// Build primitive array
//
try {
ArrayType at = new ArrayType(simpleType, true);
if (n > 1)
at = new ArrayType<T>(n - 1, at);
return at;
} catch (OpenDataException e) {
throw new IllegalArgumentException(e); // should not happen
}
| static javax.management.openmbean.SimpleType | getPrimitiveOpenType(java.lang.String primitiveTypeName)Return the primitive open type corresponding to the given primitive type.
e.g. SimpleType.BOOLEAN for "boolean", SimpleType.CHARACTER for
"char", etc...
for (Object[] typeDescr : PRIMITIVE_ARRAY_TYPES) {
if (primitiveTypeName.equals(typeDescr[PRIMITIVE_TYPE_NAME_INDEX]))
return (SimpleType<?>)typeDescr[PRIMITIVE_OPEN_TYPE_INDEX];
}
return null;
| static java.lang.String | getPrimitiveTypeKey(java.lang.String elementClassName)Return the key used to identify the element type in
arrays - e.g. "Z" for boolean, "C" for char etc...
for (Object[] typeDescr : PRIMITIVE_ARRAY_TYPES) {
if (elementClassName.equals(typeDescr[PRIMITIVE_WRAPPER_NAME_INDEX]))
return (String)typeDescr[PRIMITIVE_TYPE_KEY_INDEX];
}
return null;
| static java.lang.String | getPrimitiveTypeName(java.lang.String elementClassName)Return the primitive type name corresponding to the given wrapper class.
e.g. "boolean" for "Boolean", "char" for "Character" etc...
for (Object[] typeDescr : PRIMITIVE_ARRAY_TYPES) {
if (elementClassName.equals(typeDescr[PRIMITIVE_WRAPPER_NAME_INDEX]))
return (String)typeDescr[PRIMITIVE_TYPE_NAME_INDEX];
}
return null;
| public int | hashCode()Returns the hash code value for this ArrayType instance.
The hash code of an ArrayType instance is the sum of the
hash codes of all the elements of information used in equals
comparisons (i.e. dimension, elements' open type and primitive array flag).
The hashcode for a primitive value is the hashcode of the corresponding boxed
object (e.g. the hashcode for true is Boolean.TRUE.hashCode()).
This ensures that t1.equals(t2) implies that
t1.hashCode()==t2.hashCode() for any two
ArrayType instances t1 and t2 ,
as required by the general contract of the method
{@link Object#hashCode() Object.hashCode()}.
As ArrayType instances are immutable, the hash
code for this instance is calculated once, on the first call
to hashCode , and then the same value is returned
for subsequent calls.
// Calculate the hash code value if it has not yet been done (ie 1st call to hashCode())
//
if (myHashCode == null) {
int value = 0;
value += dimension;
value += elementType.hashCode();
value += Boolean.valueOf(primitiveArray).hashCode();
myHashCode = new Integer(value);
}
// return always the same hash code for this instance (immutable)
//
return myHashCode.intValue();
| boolean | isAssignableFrom(javax.management.openmbean.OpenType ot)
if (!(ot instanceof ArrayType))
return false;
ArrayType at = (ArrayType) ot;
return (at.getDimension() == getDimension() &&
at.isPrimitiveArray() == isPrimitiveArray() &&
at.getElementOpenType().isAssignableFrom(getElementOpenType()));
| public boolean | isPrimitiveArray()Returns true if the open data values this open
type describes are primitive arrays, false otherwise.
return primitiveArray;
| static boolean | isPrimitiveContentType(java.lang.String primitiveKey)
for (Object[] typeDescr : PRIMITIVE_ARRAY_TYPES) {
if (typeDescr[PRIMITIVE_TYPE_KEY_INDEX].equals(primitiveKey)) {
return true;
}
}
return false;
| public boolean | isValue(java.lang.Object obj)Tests whether obj is a value for this ArrayType
instance.
This method returns true if and only if obj
is not null, obj is an array and any one of the following
is true:
- if this
ArrayType instance describes an array of
SimpleType elements or their corresponding primitive types,
obj's class name is the same as the className field defined
for this ArrayType instance (i.e. the class name returned
by the {@link OpenType#getClassName() getClassName} method, which
includes the dimension information),
- if this
ArrayType instance describes an array of
classes implementing the {@code TabularData} interface or the
{@code CompositeData} interface, obj is assignable to
such a declared array, and each element contained in obj
is either null or a valid value for the element's open type specified
by this ArrayType instance.
// if obj is null, return false
//
if (obj == null) {
return false;
}
Class objClass = obj.getClass();
String objClassName = objClass.getName();
// if obj is not an array, return false
//
if ( ! objClass.isArray() ) {
return false;
}
// Test if obj's class name is the same as for the array values that this instance describes
// (this is fine if elements are of simple types, which are final classes)
//
if ( this.getClassName().equals(objClassName) ) {
return true;
}
// In case this ArrayType instance describes an array of classes implementing the TabularData or CompositeData interface,
// we first check for the assignability of obj to such an array of TabularData or CompositeData,
// which ensures that:
// . obj is of the the same dimension as this ArrayType instance,
// . it is declared as an array of elements which are either all TabularData or all CompositeData.
//
// If the assignment check is positive,
// then we have to check that each element in obj is of the same TabularType or CompositeType
// as the one described by this ArrayType instance.
//
// [About assignment check, note that the call below returns true: ]
// [Class.forName("[Lpackage.CompositeData;").isAssignableFrom(Class.forName("[Lpackage.CompositeDataImpl;)")); ]
//
if ( (this.elementType.getClassName().equals(TabularData.class.getName())) ||
(this.elementType.getClassName().equals(CompositeData.class.getName())) ) {
boolean isTabular =
(elementType.getClassName().equals(TabularData.class.getName()));
int[] dims = new int[getDimension()];
Class<?> elementClass = isTabular ? TabularData.class : CompositeData.class;
Class<?> targetClass = Array.newInstance(elementClass, dims).getClass();
// assignment check: return false if negative
if ( ! targetClass.isAssignableFrom(objClass) ) {
return false;
}
// check that all elements in obj are valid values for this ArrayType
if ( ! checkElementsType( (Object[]) obj, this.dimension) ) { // we know obj's dimension is this.dimension
return false;
}
return true;
}
// if previous tests did not return, then obj is not a value for this ArrayType instance
return false;
| private java.lang.Object | readResolve()Replace/resolve the object read from the stream before it is returned
to the caller.
if (primitiveArray) {
return convertFromWrapperToPrimitiveTypes();
} else {
return this;
}
| public java.lang.String | toString()Returns a string representation of this ArrayType instance.
The string representation consists of the name of this class (i.e.
javax.management.openmbean.ArrayType ), the type name,
the dimension, the elements' open type and the primitive array flag
defined for this instance.
As ArrayType instances are immutable, the
string representation for this instance is calculated
once, on the first call to toString , and
then the same value is returned for subsequent calls.
// Calculate the string representation if it has not yet been done (ie 1st call to toString())
//
if (myToString == null) {
myToString = getClass().getName() +
"(name=" + getTypeName() +
",dimension=" + dimension +
",elementType=" + elementType +
",primitiveArray=" + primitiveArray + ")";
}
// return always the same string representation for this instance (immutable)
//
return myToString;
| private java.lang.Object | writeReplace()Nominate a replacement for this object in the stream before the object
is written.
if (primitiveArray) {
return convertFromPrimitiveToWrapperTypes();
} else {
return this;
}
|
|