Javadoc fixes.
This commit is contained in:
@@ -40,7 +40,7 @@
|
||||
CDDB cddb = new CDDB();
|
||||
cddb.connect("www.freedb.org");
|
||||
CDDB.Entry[] entries = cddb.query(discid, frameOffsets, length);
|
||||
for (int i = 0; i < entries.length; i++) {
|
||||
for (int i = 0; i < entries.length; i++) {
|
||||
CDDB.Detail detail = cddb.read(entries[i].category,
|
||||
entries[i].discid);
|
||||
// do your thang now...
|
||||
|
||||
@@ -10,14 +10,14 @@ import java.util.Collection;
|
||||
import java.util.Iterator;
|
||||
|
||||
/**
|
||||
* A base class for {@link IntSet} implementations.<p>
|
||||
* A base class for {@link IntSet} implementations.
|
||||
*
|
||||
* All you really need to do is implement <tt>interable</tt>, but you'll almost certainly want
|
||||
* to implement <tt>size</tt> and <tt>contains</tt> for enhanced performance.<p>
|
||||
* All you really need to do is implement {@code interable}, but you'll almost certainly want
|
||||
* to implement {@code size} and {@code contains} for enhanced performance.
|
||||
*
|
||||
* To implement a modifiable IntSet, the programmer must additionally override this class's
|
||||
* <tt>add</tt> and <tt>remove</tt> methods, which will otherwise throw an
|
||||
* <tt>UnsupportedOperationException</tt>.<p>
|
||||
* {@code add} {@code remove} methods, which will otherwise throw an
|
||||
* {@code UnsupportedOperationException}.
|
||||
*/
|
||||
public abstract class AbstractIntSet extends AbstractSet<Integer>
|
||||
implements IntSet
|
||||
@@ -27,7 +27,7 @@ public abstract class AbstractIntSet extends AbstractSet<Integer>
|
||||
*
|
||||
* @param values elements to be added to this set.
|
||||
*
|
||||
* @return <tt>true</tt> if this set did not already contain all of the specified elements.
|
||||
* @return {@code true} if this set did not already contain all of the specified elements.
|
||||
*/
|
||||
public boolean add (int[] values)
|
||||
{
|
||||
@@ -45,7 +45,7 @@ public abstract class AbstractIntSet extends AbstractSet<Integer>
|
||||
*
|
||||
* @param values elements to be removed from the set.
|
||||
*
|
||||
* @return <tt>true</tt> if this set contained any of the specified elements (which will have
|
||||
* @return {@code true} if this set contained any of the specified elements (which will have
|
||||
* been removed).
|
||||
*/
|
||||
public boolean remove (int[] values)
|
||||
|
||||
@@ -363,7 +363,7 @@ public class ArrayUtil
|
||||
* to the specified Comparable key. Note that the array elements can implement
|
||||
* {@link Comparable} and the key can be of the same type, or the key can be a completely
|
||||
* different class that can compare the element type.
|
||||
* <b>All comparisons will be called as <tt>key.compareTo(element)</tt></b>.
|
||||
* <b>All comparisons will be called as {@code key.compareTo(element)}</b>.
|
||||
*
|
||||
* @param array the array to be searched.
|
||||
* @param offset the index of the first element in the array to be considered.
|
||||
|
||||
@@ -482,7 +482,7 @@ public class HashIntMap<V> extends AbstractMap<Integer,V>
|
||||
}
|
||||
|
||||
/**
|
||||
* Reconstitute the <tt>HashIntMap</tt> instance from a stream (i.e.,
|
||||
* Reconstitute the {@code HashIntMap} instance from a stream (i.e.,
|
||||
* deserialize it).
|
||||
*/
|
||||
private void readObject (ObjectInputStream s)
|
||||
|
||||
@@ -409,7 +409,7 @@ public class IntIntMap
|
||||
}
|
||||
|
||||
/**
|
||||
* Reconstitute the <tt>IntIntMap</tt> instance from a stream (i.e.,
|
||||
* Reconstitute the {@code IntIntMap} instance from a stream (i.e.,
|
||||
* deserialize it).
|
||||
*/
|
||||
private void readObject (ObjectInputStream s)
|
||||
|
||||
@@ -32,24 +32,24 @@ public interface IntMap<V> extends Map<Integer,V>
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if this map contains a mapping for the
|
||||
* Returns {@code true} if this map contains a mapping for the
|
||||
* specified key.
|
||||
*
|
||||
* @param key key whose presence in this map is to be tested.
|
||||
*
|
||||
* @return <tt>true</tt> if this map contains a mapping for the
|
||||
* @return {@code true} if this map contains a mapping for the
|
||||
* specified key.
|
||||
*/
|
||||
public boolean containsKey (int key);
|
||||
|
||||
/**
|
||||
* Returns the value to which this map maps the specified key. Returns
|
||||
* <tt>null</tt> if the map contains no mapping for this key.
|
||||
* {@code null} if the map contains no mapping for this key.
|
||||
*
|
||||
* @param key key whose associated value is to be returned.
|
||||
*
|
||||
* @return the value to which this map maps the specified key, or
|
||||
* <tt>null</tt> if the map contains no mapping for this key.
|
||||
* {@code null} if the map contains no mapping for this key.
|
||||
*/
|
||||
public V get (int key);
|
||||
|
||||
@@ -62,7 +62,7 @@ public interface IntMap<V> extends Map<Integer,V>
|
||||
* @param value value to be associated with the specified key.
|
||||
*
|
||||
* @return previous value associated with specified key, or
|
||||
* <tt>null</tt> if there was no mapping for key.
|
||||
* {@code null} if there was no mapping for key.
|
||||
*/
|
||||
public V put (int key, V value);
|
||||
|
||||
@@ -72,7 +72,7 @@ public interface IntMap<V> extends Map<Integer,V>
|
||||
* @param key key whose mapping is to be removed from the map.
|
||||
*
|
||||
* @return previous value associated with specified key, or
|
||||
* <tt>null</tt> if there was no mapping for key.
|
||||
* {@code null} if there was no mapping for key.
|
||||
*/
|
||||
public V remove (int key);
|
||||
|
||||
|
||||
@@ -17,11 +17,11 @@ import java.util.Set;
|
||||
public interface IntSet extends Set<Integer>, Interable
|
||||
{
|
||||
/**
|
||||
* Returns <tt>true</tt> if this set contains the specified element.
|
||||
* Returns {@code true} if this set contains the specified element.
|
||||
*
|
||||
* @param value element whose presence in this set is to be tested.
|
||||
*
|
||||
* @return <tt>true</tt> if this set contains the specified element.
|
||||
* @return {@code true} if this set contains the specified element.
|
||||
*/
|
||||
public boolean contains (int value);
|
||||
|
||||
@@ -29,23 +29,23 @@ public interface IntSet extends Set<Integer>, Interable
|
||||
* Adds the specified element to this set if it is not already present
|
||||
* (optional operation). If this set already contains the specified
|
||||
* element, the call leaves this set unchanged and returns
|
||||
* <tt>false</tt>. In combination with the restriction on
|
||||
* {@code false}. In combination with the restriction on
|
||||
* constructors, this ensures that sets never contain duplicate
|
||||
* elements.
|
||||
*
|
||||
* @param value element to be added to this set.
|
||||
*
|
||||
* @return <tt>true</tt> if this set did not already contain the
|
||||
* @return {@code true} if this set did not already contain the
|
||||
* specified element.
|
||||
*
|
||||
* @throws UnsupportedOperationException if the <tt>add</tt> method is
|
||||
* @throws UnsupportedOperationException if the {@code add} method is
|
||||
* not supported by this set.
|
||||
*/
|
||||
public boolean add (int value);
|
||||
|
||||
/**
|
||||
* Removes the specified element from this set if it is present
|
||||
* (optional operation). Returns <tt>true</tt> if the set contained
|
||||
* (optional operation). Returns {@code true} if the set contained
|
||||
* the specified element (or equivalently, if the set changed as a
|
||||
* result of the call). (The set will not contain the specified
|
||||
* element once the call returns.)
|
||||
@@ -54,7 +54,7 @@ public interface IntSet extends Set<Integer>, Interable
|
||||
*
|
||||
* @return true if the set contained the specified element.
|
||||
*
|
||||
* @throws UnsupportedOperationException if the <tt>remove</tt> method
|
||||
* @throws UnsupportedOperationException if the {@code remove} method
|
||||
* is not supported by this set.
|
||||
*/
|
||||
public boolean remove (int value);
|
||||
@@ -66,7 +66,7 @@ public interface IntSet extends Set<Integer>, Interable
|
||||
|
||||
/**
|
||||
* Returns an array containing all of the elements in this set. Obeys
|
||||
* the general contract of the <tt>Collection.toArray</tt> method.
|
||||
* the general contract of the {@code Collection.toArray} method.
|
||||
*
|
||||
* @return an array containing all of the elements in this set.
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user