jdk/src/java.management/share/classes/javax/management/openmbean/CompositeData.java
changeset 32034 05676cfd40b5
parent 25859 3317bb8137f4
--- a/jdk/src/java.management/share/classes/javax/management/openmbean/CompositeData.java	Thu Aug 06 13:20:13 2015 +0300
+++ b/jdk/src/java.management/share/classes/javax/management/openmbean/CompositeData.java	Thu Aug 06 13:59:10 2015 +0300
@@ -36,7 +36,8 @@
 
 
 /**
- * The <tt>CompositeData</tt> interface specifies the behavior of a specific type of complex <i>open data</i> objects
+ * The {@code CompositeData} interface specifies
+ * the behavior of a specific type of complex <i>open data</i> objects
  * which represent <i>composite data</i> structures.
  *
  *
@@ -53,55 +54,60 @@
     public CompositeType getCompositeType();
 
     /**
-     * Returns the value of the item whose name is <tt>key</tt>.
+     * Returns the value of the item whose name is {@code key}.
      *
      * @param key the name of the item.
      *
      * @return the value associated with this key.
      *
-     * @throws IllegalArgumentException  if <tt>key</tt> is a null or empty String.
+     * @throws IllegalArgumentException  if {@code key} is a null or empty String.
      *
-     * @throws InvalidKeyException  if <tt>key</tt> is not an existing item name for this <tt>CompositeData</tt> instance.
+     * @throws InvalidKeyException  if {@code key} is not an
+     *         existing item name for this {@code CompositeData} instance.
      */
     public Object get(String key) ;
 
     /**
-     * Returns an array of the values of the items whose names are specified by <tt>keys</tt>, in the same order as <tt>keys</tt>.
+     * Returns an array of the values of the items whose names
+     * are specified by {@code keys}, in the same order as {@code keys}.
      *
      * @param keys the names of the items.
      *
      * @return the values corresponding to the keys.
      *
-     * @throws IllegalArgumentException  if an element in <tt>keys</tt> is a null or empty String.
+     * @throws IllegalArgumentException  if an element in {@code keys} is a null or empty String.
      *
-     * @throws InvalidKeyException  if an element in <tt>keys</tt> is not an existing item name for this <tt>CompositeData</tt> instance.
+     * @throws InvalidKeyException  if an element in {@code keys}
+     *         is not an existing item name for this {@code CompositeData} instance.
      */
     public Object[] getAll(String[] keys) ;
 
     /**
-     * Returns <tt>true</tt> if and only if this <tt>CompositeData</tt> instance contains
-     * an item whose name is <tt>key</tt>.
-     * If <tt>key</tt> is a null or empty String, this method simply returns false.
+     * Returns {@code true} if and only if this {@code CompositeData} instance contains
+     * an item whose name is {@code key}.
+     * If {@code key} is a null or empty String, this method simply returns false.
      *
      * @param key the key to be tested.
      *
-     * @return true if this <tt>CompositeData</tt> contains the key.
+     * @return true if this {@code CompositeData} contains the key.
      */
     public boolean containsKey(String key) ;
 
     /**
-     * Returns <tt>true</tt> if and only if this <tt>CompositeData</tt> instance contains an item
-     * whose value is <tt>value</tt>.
+     * Returns {@code true} if and only if this {@code CompositeData} instance contains an item
+     * whose value is {@code value}.
      *
      * @param value the value to be tested.
      *
-     * @return true if this <tt>CompositeData</tt> contains the value.
+     * @return true if this {@code CompositeData} contains the value.
      */
     public boolean containsValue(Object value) ;
 
     /**
-     * Returns an unmodifiable Collection view of the item values contained in this <tt>CompositeData</tt> instance.
-     * The returned collection's iterator will return the values in the ascending lexicographic order of the corresponding
+     * Returns an unmodifiable Collection view of the item values
+     * contained in this {@code CompositeData} instance.
+     * The returned collection's iterator will return the values
+     * in the ascending lexicographic order of the corresponding
      * item names.
      *
      * @return the values.
@@ -110,12 +116,12 @@
 
     /**
      * Compares the specified <var>obj</var> parameter with this
-     * <code>CompositeData</code> instance for equality.
+     * {@code CompositeData} instance for equality.
      * <p>
-     * Returns <tt>true</tt> if and only if all of the following statements are true:
+     * Returns {@code true} if and only if all of the following statements are true:
      * <ul>
      * <li><var>obj</var> is non null,</li>
-     * <li><var>obj</var> also implements the <code>CompositeData</code> interface,</li>
+     * <li><var>obj</var> also implements the {@code CompositeData} interface,</li>
      * <li>their composite types are equal</li>
      * <li>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
@@ -124,28 +130,28 @@
      * {@code Arrays.equals(e1,e2)} for arrays of primitive types</li>
      * </ul>
      * <p>
-     * This ensures that this <tt>equals</tt> method works properly for
+     * This ensures that this {@code equals} method works properly for
      * <var>obj</var> parameters which are different implementations of the
-     * <code>CompositeData</code> interface, with the restrictions mentioned in the
+     * {@code CompositeData} interface, with the restrictions mentioned in the
      * {@link java.util.Collection#equals(Object) equals}
-     * method of the <tt>java.util.Collection</tt> interface.
+     * method of the {@code java.util.Collection} interface.
      *
      * @param  obj  the object to be compared for equality with this
-     * <code>CompositeData</code> instance.
-     * @return  <code>true</code> if the specified object is equal to this
-     * <code>CompositeData</code> instance.
+     * {@code CompositeData} instance.
+     * @return  {@code true} if the specified object is equal to this
+     * {@code CompositeData} instance.
      */
     public boolean equals(Object obj) ;
 
     /**
-     * Returns the hash code value for this <code>CompositeData</code> instance.
+     * Returns the hash code value for this {@code CompositeData} instance.
      * <p>
-     * The hash code of a <code>CompositeData</code> instance is the sum of the hash codes
-     * of all elements of information used in <code>equals</code> comparisons
+     * The hash code of a {@code CompositeData} instance is the sum of the hash codes
+     * of all elements of information used in {@code equals} comparisons
      * (ie: its <i>composite type</i> and all the item values).
      * <p>
-     * This ensures that <code> t1.equals(t2) </code> implies that <code> t1.hashCode()==t2.hashCode() </code>
-     * for any two <code>CompositeData</code> instances <code>t1</code> and <code>t2</code>,
+     * This ensures that {@code t1.equals(t2)} implies that {@code t1.hashCode()==t2.hashCode()}
+     * for any two {@code CompositeData} instances {@code t1} and {@code t2},
      * as required by the general contract of the method
      * {@link Object#hashCode() Object.hashCode()}.
      * <p>
@@ -156,18 +162,19 @@
      * 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 <code>CompositeData</code> instance
+     * @return the hash code value for this {@code CompositeData} instance
      */
     public int hashCode() ;
 
     /**
-     * Returns a string representation of this <code>CompositeData</code> instance.
+     * Returns a string representation of this {@code CompositeData} instance.
      * <p>
      * The string representation consists of the name of the implementing class,
-     * the string representation of the composite type of this instance, and the string representation of the contents
+     * 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 <code>CompositeData</code> instance
+     * @return  a string representation of this {@code CompositeData} instance
      */
     public String toString() ;