File	Doc	Category	Size	Date	Package
TabularType.java	API Doc	Java SE 6 API	12815	Tue Jun 10 00:26:16 BST 2008	javax.management.openmbean

TabularType

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

Fields Summary
static final long	serialVersionUID
private CompositeType	rowType
private List	indexNames
private transient Integer	myHashCode
private transient String	myToString

Constructors Summary

public TabularType(String typeName, String description, CompositeType rowType, String[] indexNames) Constructs a TabularType instance, checking for the validity of the given parameters. The validity constraints are described below for each parameter. The Java class name of tabular data values this tabular type represents (ie the class name returned by the {@link OpenType#getClassName() getClassName} method) is set to the string value returned by TabularData.class.getName(). param typeName The name given to the tabular type this instance represents; cannot be a null or empty string.   param description The human readable description of the tabular type this instance represents; cannot be a null or empty string.   param rowType The type of the row elements of tabular data values described by this tabular type instance; cannot be null.   param indexNames The names of the items the values of which are used to uniquely index each row element in the tabular data values described by this tabular type instance; cannot be null or empty. Each element should be an item name defined in rowType (no null or empty string allowed). It is important to note that the order of the item names in indexNames is used by the methods {@link TabularData#get(java.lang.Object[]) get} and {@link TabularData#remove(java.lang.Object[]) remove} of class TabularData to match their array of values parameter to items.   throws IllegalArgumentException if rowType is null, or indexNames is a null or empty array, or an element in indexNames is a null or empty string, or typeName or description is a null or empty string.   throws OpenDataException if an element's value of indexNames is not an item name defined in rowType. // need only be calculated once. /* *** Constructor *** */ // Check and initialize state defined by parent. // super(TabularData.class.getName(), typeName, description, false); // Check rowType is not null // if (rowType == null) { throw new IllegalArgumentException("Argument rowType cannot be null."); } // Check indexNames is neither null nor empty and does not contain any null element or empty string // checkForNullElement(indexNames, "indexNames"); checkForEmptyString(indexNames, "indexNames"); // Check all indexNames values are valid item names for rowType // for (int i=0; i<indexNames.length; i++) { if ( ! rowType.containsKey(indexNames[i]) ) { throw new OpenDataException("Argument's element value indexNames["+ i +"]=\""+ indexNames[i] + "\" is not a valid item name for rowType."); } } // initialize rowType // this.rowType = rowType; // initialize indexNames (copy content so that subsequent // modifs to the array referenced by the indexNames parameter // have no impact) // List<String> tmpList = new ArrayList<String>(indexNames.length + 1); for (int i=0; i<indexNames.length; i++) { tmpList.add(indexNames[i]); } this.indexNames = Collections.unmodifiableList(tmpList);

Methods Summary
private static void	checkForEmptyString(java.lang.String[] arg, java.lang.String argName) Checks that String[] does not contain any empty (or blank characters only) string. for (int i=0; i<arg.length; i++) { if (arg[i].trim().equals("")) { throw new IllegalArgumentException("Argument's element "+ argName +"["+ i +"] cannot be an empty string."); } }
private static void	checkForNullElement(java.lang.Object[] arg, java.lang.String argName) Checks that Object[] arg is neither null nor empty (ie length==0) and that it does not contain any null element. if ( (arg == null) || (arg.length == 0) ) { throw new IllegalArgumentException("Argument "+ argName +"[] cannot be null or empty."); } for (int i=0; i<arg.length; i++) { if (arg[i] == null) { throw new IllegalArgumentException("Argument's element "+ argName +"["+ i +"] cannot be null."); } }
public boolean	equals(java.lang.Object obj) Compares the specified obj parameter with this TabularType instance for equality. Two TabularType instances are equal if and only if all of the following statements are true: their type names are equal their row types are equal they use the same index names, in the same order   param obj the object to be compared for equality with this TabularType instance; if obj is null, equals returns false. return true if the specified object is equal to this TabularType instance. // if obj is null, return false // if (obj == null) { return false; } // if obj is not a TabularType, return false // TabularType other; try { other = (TabularType) obj; } catch (ClassCastException e) { return false; } // Now, really test for equality between this TabularType instance and the other: // // their names should be equal if ( ! this.getTypeName().equals(other.getTypeName()) ) { return false; } // their row types should be equal if ( ! this.rowType.equals(other.rowType) ) { return false; } // their index names should be equal and in the same order (ensured by List.equals()) if ( ! this.indexNames.equals(other.indexNames) ) { return false; } // All tests for equality were successfull // return true;
public java.util.List	getIndexNames() Returns, in the same order as was given to this instance's constructor, an unmodifiable List of the names of the items the values of which are used to uniquely index each row element of tabular data values described by this TabularType instance. return a List of String representing the names of the index items. return indexNames;
public javax.management.openmbean.CompositeType	getRowType() Returns the type of the row elements of tabular data values described by this TabularType instance. return the type of each row. return rowType;
public int	hashCode() Returns the hash code value for this TabularType instance. The hash code of a TabularType instance is the sum of the hash codes of all elements of information used in equals comparisons (ie: name, row type, index names). This ensures that t1.equals(t2) implies that t1.hashCode()==t2.hashCode() for any two TabularType instances t1 and t2, as required by the general contract of the method {@link Object#hashCode() Object.hashCode()}. As TabularType 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. return the hash code value for this TabularType instance // Calculate the hash code value if it has not yet been done (ie 1st call to hashCode()) // if (myHashCode == null) { int value = 0; value += this.getTypeName().hashCode(); value += this.rowType.hashCode(); for (Iterator k = indexNames.iterator(); k.hasNext(); ) { value += k.next().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 TabularType)) return false; TabularType tt = (TabularType) ot; if (!getTypeName().equals(tt.getTypeName()) || !getIndexNames().equals(tt.getIndexNames())) return false; return getRowType().isAssignableFrom(tt.getRowType());
public boolean	isValue(java.lang.Object obj) Tests whether obj is a value which could be described by this TabularType instance. If obj is null or is not an instance of javax.management.openmbean.TabularData, isValue returns false. If obj is an instance of javax.management.openmbean.TabularData, say {@code td}, the result is true if this {@code TabularType} is assignable from {@link TabularData#getTabularType() td.getTabularType()}, as defined in {@link CompositeType#isValue CompositeType.isValue}. param obj the value whose open type is to be tested for compatibility with this TabularType instance. return true if obj is a value for this tabular type, false otherwise. // if obj is null or not a TabularData, return false // if (!(obj instanceof TabularData)) return false; // if obj is not a TabularData, return false // TabularData value = (TabularData) obj; TabularType valueType = value.getTabularType(); return isAssignableFrom(valueType);
public java.lang.String	toString() Returns a string representation of this TabularType instance. The string representation consists of the name of this class (ie javax.management.openmbean.TabularType), the type name for this instance, the row type string representation of this instance, and the index names of this instance. As TabularType 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. return a string representation of this TabularType instance // Calculate the string representation if it has not yet been done (ie 1st call to toString()) // if (myToString == null) { StringBuffer result = new StringBuffer() .append(this.getClass().getName()) .append("(name=") .append(getTypeName()) .append(",rowType=") .append(rowType.toString()) .append(",indexNames=("); int i=0; Iterator k = indexNames.iterator(); while( k.hasNext() ) { if (i > 0) result.append(","); result.append(k.next().toString()); i++; } result.append("))"); myToString = result.toString(); } // return always the same string representation for this instance (immutable) // return myToString;