/* * Copyright 2000-2008 Sun Microsystems, Inc. All Rights Reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Sun designates this * particular file as subject to the "Classpath" exception as provided * by Sun in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, * CA 95054 USA or visit www.sun.com if you need additional information or * have any questions. */ package javax.management.openmbean; // java import // import java.io.Serializable; import java.util.Arrays; import java.util.Collection; import java.util.Collections; import java.util.LinkedHashMap; import java.util.Map; import java.util.Set; import java.util.SortedMap; import java.util.TreeMap; // jmx import import java.util.TreeSet; // /** * The CompositeDataSupport class is the open data class which * implements the CompositeData interface. * * * @since 1.5 */ public class CompositeDataSupport implements CompositeData, Serializable { /* Serial version */ static final long serialVersionUID = 8003518976613702244L; /** * @serial Internal representation of the mapping of item names to their * respective values. * A {@link SortedMap} is used for faster retrieval of elements. */ private final SortedMap contents; /** * @serial The composite type of this composite data instance. */ private final CompositeType compositeType; /** *

Constructs a CompositeDataSupport instance with the specified * compositeType, whose item values * are specified by itemValues[], in the same order as in * itemNames[]. * As a CompositeType does not specify any order on its items, * the itemNames[] parameter is used * to specify the order in which the values are given in itemValues[]. * The items contained in this CompositeDataSupport instance are * internally stored in a TreeMap, * thus sorted in ascending lexicographic order of their names, for faster * retrieval of individual item values.

* *

The constructor checks that all the constraints listed below for each * parameter are satisfied, * and throws the appropriate exception if they are not.

* * @param compositeType the composite type of this composite * data instance; must not be null. * * @param itemNames itemNames must list, in any order, all the * item names defined in compositeType; the order in which the * names are listed, is used to match values in itemValues[]; must * not be null. * * @param itemValues the values of the items, listed in the same order as * their respective names in itemNames; each item value can be * null, but if it is non-null it must be a valid value for the open type * defined in compositeType for the corresponding item; must be of * the same size as itemNames; must not be null. * * @throws IllegalArgumentException compositeType is null, or * itemNames[] or itemValues[] is null, or one * of the elements in itemNames[] is a null or empty string, or * itemNames[] and itemValues[] are not of the same size. * * @throws OpenDataException itemNames[] or * itemValues[]'s size differs from the number of items defined in * compositeType, or one of the elements in itemNames[] * does not exist as an item name defined in compositeType, or one * of the elements in itemValues[] is not a valid value for the * corresponding item as defined in compositeType. */ public CompositeDataSupport( CompositeType compositeType, String[] itemNames, Object[] itemValues) throws OpenDataException { this(makeMap(itemNames, itemValues), compositeType); } private static SortedMap makeMap( String[] itemNames, Object[] itemValues) throws OpenDataException { if (itemNames == null || itemValues == null) throw new IllegalArgumentException("Null itemNames or itemValues"); if (itemNames.length != itemValues.length) { throw new IllegalArgumentException( "Different lengths: itemNames[" + itemNames.length + "], itemValues[" + itemValues.length + "]"); } SortedMap map = new TreeMap(); for (int i = 0; i < itemNames.length; i++) { String name = itemNames[i]; if (name == null || name.equals("")) throw new IllegalArgumentException("Null or empty item name"); if (map.containsKey(name)) throw new OpenDataException("Duplicate item name " + name); map.put(itemNames[i], itemValues[i]); } return map; } /** *

* Constructs a CompositeDataSupport instance with the specified compositeType, whose item names and corresponding values * are given by the mappings in the map items. * This constructor converts the keys to a string array and the values to an object array and calls * CompositeDataSupport(javax.management.openmbean.CompositeType, java.lang.String[], java.lang.Object[]). * * @param compositeType the composite type of this composite data instance; * must not be null. * @param items the mappings of all the item names to their values; * items must contain all the item names defined in compositeType; * must not be null. * * @throws IllegalArgumentException compositeType is null, or * items is null, or one of the keys in items is a null * or empty string. * @throws OpenDataException items' size differs from the * number of items defined in compositeType, or one of the * keys in items does not exist as an item name defined in * compositeType, or one of the values in items * is not a valid value for the corresponding item as defined in * compositeType. * @throws ArrayStoreException one or more keys in items is not of * the class java.lang.String. * * @see #toMap */ public CompositeDataSupport(CompositeType compositeType, Map items) throws OpenDataException { this(makeMap(items), compositeType); } private static SortedMap makeMap(Map items) { if (items == null) throw new IllegalArgumentException("Null items map"); if (items.containsKey(null) || items.containsKey("")) throw new IllegalArgumentException("Null or empty item name"); SortedMap map = new TreeMap(); for (Object key : items.keySet()) { if (!(key instanceof String)) { throw new ArrayStoreException("Item name is not string: " + key); // This can happen because of erasure. The particular // exception is a historical artifact - an implementation // detail that leaked into the API. } map.put((String) key, items.get(key)); } return map; } private CompositeDataSupport( SortedMap items, CompositeType compositeType) throws OpenDataException { // Check compositeType is not null // if (compositeType == null) { throw new IllegalArgumentException("Argument compositeType cannot be null."); } // item names defined in compositeType: Set namesFromType = compositeType.keySet(); Set namesFromItems = items.keySet(); // This is just a comparison, but we do it this way for a better // exception message. if (!namesFromType.equals(namesFromItems)) { Set extraFromType = new TreeSet(namesFromType); extraFromType.removeAll(namesFromItems); Set extraFromItems = new TreeSet(namesFromItems); extraFromItems.removeAll(namesFromType); if (!extraFromType.isEmpty() || !extraFromItems.isEmpty()) { throw new OpenDataException( "Item names do not match CompositeType: " + "names in items but not in CompositeType: " + extraFromItems + "; names in CompositeType but not in items: " + extraFromType); } } // Check each value, if not null, is of the open type defined for the // corresponding item for (String name : namesFromType) { Object value = items.get(name); if (value != null) { OpenType itemType = compositeType.getType(name); if (!itemType.isValue(value)) { throw new OpenDataException( "Argument value of wrong type for item " + name + ": value " + value + ", type " + itemType); } } } // Initialize internal fields: compositeType and contents // this.compositeType = compositeType; this.contents = items; } /** * Returns the composite type of this composite data instance. */ public CompositeType getCompositeType() { return compositeType; } /** * Returns the value of the item whose name is key. * * @throws IllegalArgumentException if key is a null or empty String. * * @throws InvalidKeyException if key is not an existing item name for * this CompositeData instance. */ public Object get(String key) { if ( (key == null) || (key.trim().equals("")) ) { throw new IllegalArgumentException("Argument key cannot be a null or empty String."); } if ( ! contents.containsKey(key.trim())) { throw new InvalidKeyException("Argument key=\""+ key.trim() +"\" is not an existing item name for this CompositeData instance."); } return contents.get(key.trim()); } /** * Returns an array of the values of the items whose names are specified by * keys, in the same order as keys. * * @throws IllegalArgumentException if an element in keys is a null * or empty String. * * @throws InvalidKeyException if an element in keys is not an existing * item name for this CompositeData instance. */ public Object[] getAll(String[] keys) { if ( (keys == null) || (keys.length == 0) ) { return new Object[0]; } Object[] results = new Object[keys.length]; for (int i=0; itrue if and only if this CompositeData instance contains * an item whose name is key. * If key is a null or empty String, this method simply returns false. */ public boolean containsKey(String key) { if ( (key == null) || (key.trim().equals("")) ) { return false; } return contents.containsKey(key); } /** * Returns true if and only if this CompositeData instance * contains an item * whose value is value. */ public boolean containsValue(Object value) { return contents.containsValue(value); } /** * Returns an unmodifiable Collection view of the item values contained in this * CompositeData instance. * The returned collection's iterator will return the values in the ascending * lexicographic order of the corresponding * item names. */ public Collection values() { return Collections.unmodifiableCollection(contents.values()); } /** *

Returns a Map representing the contents of the given CompositeData. * Each item in the CompositeData is represented by an entry in the map, * where the name and value of the item are the key and value of the entry. * The returned value is modifiable but modifications to it have no effect * on the original CompositeData.

* *

For example, if you have a CompositeData {@code cd1} and you want * to produce another CompositeData {@code cd2} which is the same except * that the value of its {@code id} item has been changed to 253, you * could write:

* * 
     * CompositeData cd1 = ...;
     * {@code Map} map = CompositeDataSupport.toMap(cd1);
     * assert(map.get("id") instanceof Integer);
     * map.put("id", 253);
     * CompositeData cd2 = {@link #CompositeDataSupport(CompositeType, Map)
     * new CompositeDataSupport}(cd1.getCompositeType(), map);
     *
* *

Logically, this method would be a method in the {@link CompositeData} * interface, but cannot be for compatibility reasons.

* * @param cd the CompositeData to convert to a Map. * * @return a Map that is a copy of the contents of {@code cd}. * * @throws IllegalArgumentException if {@code cd} is null. * * @see #CompositeDataSupport(CompositeType, Map) */ public static Map toMap(CompositeData cd) { if (cd == null) throw new IllegalArgumentException("Null argument"); // If we really wanted, we could check whether cd is a // CompositeDataSupport and return a copy of cd.contents if so, // but I don't think that would be substantially faster. Map map = new LinkedHashMap(); CompositeType ct = cd.getCompositeType(); for (String key : ct.keySet()) { Object value = cd.get(key); map.put(key, value); } return map; } /** * Compares the specified obj parameter with this * CompositeDataSupport instance for equality. *

* Returns true if and only if all of the following statements are true: *

    *
  • obj is non null,
    • *
  • obj also implements the CompositeData interface,
    • *
  • their composite types are equal
    • *
  • their contents, i.e. (name, value) pairs are equal. If a value contained in * the content is an array, the value comparison is done as if by calling * the {@link java.util.Arrays#deepEquals(Object[], Object[]) deepEquals} method * for arrays of object reference types or the appropriate overloading of * {@code Arrays.equals(e1,e2)} for arrays of primitive types
    • *
*

* This ensures that this equals method works properly for * obj parameters which are different implementations of the * CompositeData interface, with the restrictions mentioned in the * {@link java.util.Collection#equals(Object) equals} * method of the java.util.Collection interface. * * @param obj the object to be compared for equality with this * CompositeDataSupport instance. * @return true if the specified object is equal to this * CompositeDataSupport instance. */ @Override public boolean equals(Object obj) { if (this == obj) { return true; } // if obj is not a CompositeData, return false if (!(obj instanceof CompositeData)) { return false; } CompositeData other = (CompositeData) obj; // their compositeType should be equal if (!this.getCompositeType().equals(other.getCompositeType()) ) { return false; } if (contents.size() != other.values().size()) { return false; } for (Map.Entry entry : contents.entrySet()) { Object e1 = entry.getValue(); Object e2 = other.get(entry.getKey()); if (e1 == e2) continue; if (e1 == null) return false; boolean eq = e1.getClass().isArray() ? Arrays.deepEquals(new Object[] {e1}, new Object[] {e2}) : e1.equals(e2); if (!eq) return false; } // All tests for equality were successful // return true; } /** * Returns the hash code value for this CompositeDataSupport instance. *

* The hash code of a CompositeDataSupport instance is the sum of the hash codes * of all elements of information used in equals comparisons * (ie: its composite type and all the item values). *

* This ensures that t1.equals(t2) implies that t1.hashCode()==t2.hashCode() * for any two CompositeDataSupport instances t1 and t2, * as required by the general contract of the method * {@link Object#hashCode() Object.hashCode()}. *

* Each item value's hash code is added to the returned hash code. * If an item value is an array, * its hash code is obtained as if by calling the * {@link java.util.Arrays#deepHashCode(Object[]) deepHashCode} method * for arrays of object reference types or the appropriate overloading * of {@code Arrays.hashCode(e)} for arrays of primitive types. * * @return the hash code value for this CompositeDataSupport instance */ @Override public int hashCode() { int hashcode = compositeType.hashCode(); for (Object o : contents.values()) { if (o instanceof Object[]) hashcode += Arrays.deepHashCode((Object[]) o); else if (o instanceof byte[]) hashcode += Arrays.hashCode((byte[]) o); else if (o instanceof short[]) hashcode += Arrays.hashCode((short[]) o); else if (o instanceof int[]) hashcode += Arrays.hashCode((int[]) o); else if (o instanceof long[]) hashcode += Arrays.hashCode((long[]) o); else if (o instanceof char[]) hashcode += Arrays.hashCode((char[]) o); else if (o instanceof float[]) hashcode += Arrays.hashCode((float[]) o); else if (o instanceof double[]) hashcode += Arrays.hashCode((double[]) o); else if (o instanceof boolean[]) hashcode += Arrays.hashCode((boolean[]) o); else if (o != null) hashcode += o.hashCode(); } return hashcode; } /** * Returns a string representation of this CompositeDataSupport instance. *

* The string representation consists of the name of this class (ie javax.management.openmbean.CompositeDataSupport), * the string representation of the composite type of this instance, and the string representation of the contents * (ie list the itemName=itemValue mappings). * * @return a string representation of this CompositeDataSupport instance */ @Override public String toString() { return new StringBuilder() .append(this.getClass().getName()) .append("(compositeType=") .append(compositeType.toString()) .append(",contents=") .append(contentString()) .append(")") .toString(); } private String contentString() { StringBuilder sb = new StringBuilder("{"); String sep = ""; for (Map.Entry entry : contents.entrySet()) { sb.append(sep).append(entry.getKey()).append("="); String s = Arrays.deepToString(new Object[] {entry.getValue()}); sb.append(s.substring(1, s.length() - 1)); sep = ", "; } sb.append("}"); return sb.toString(); } }