Javadoc syntax fixes
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/collections/trunk@1436026 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Sebastian Bazley
parent
aed4c18c13
commit
2c82062b7c
|
|
@ -20,7 +20,7 @@ import java.util.Collection;
|
|||
import java.util.Set;
|
||||
|
||||
/**
|
||||
* The "read" subset of the {@link Map} interface.
|
||||
* The "read" subset of the {@link java.util.Map} interface.
|
||||
*
|
||||
* @since 4.0
|
||||
* @version $Id$
|
||||
|
|
@ -30,47 +30,47 @@ import java.util.Set;
|
|||
public interface Get<K, V> {
|
||||
|
||||
/**
|
||||
* @see Map#containsKey(Object)
|
||||
* @see java.util.Map#containsKey(Object)
|
||||
*/
|
||||
public boolean containsKey(Object key);
|
||||
|
||||
/**
|
||||
* @see Map#containsValue(Object)
|
||||
* @see java.util.Map#containsValue(Object)
|
||||
*/
|
||||
public boolean containsValue(Object value);
|
||||
|
||||
/**
|
||||
* @see Map#entrySet()
|
||||
* @see java.util.Map#entrySet()
|
||||
*/
|
||||
public Set<java.util.Map.Entry<K, V>> entrySet();
|
||||
|
||||
/**
|
||||
* @see Map#get(Object)
|
||||
* @see java.util.Map#get(Object)
|
||||
*/
|
||||
public V get(Object key);
|
||||
|
||||
/**
|
||||
* @see Map#remove(Object)
|
||||
* @see java.util.Map#remove(Object)
|
||||
*/
|
||||
public V remove(Object key);
|
||||
|
||||
/**
|
||||
* @see Map#isEmpty()
|
||||
* @see java.util.Map#isEmpty()
|
||||
*/
|
||||
public boolean isEmpty();
|
||||
|
||||
/**
|
||||
* @see Map#keySet()
|
||||
* @see java.util.Map#keySet()
|
||||
*/
|
||||
public Set<K> keySet();
|
||||
|
||||
/**
|
||||
* @see Map#size()
|
||||
* @see java.util.Map#size()
|
||||
*/
|
||||
public int size();
|
||||
|
||||
/**
|
||||
* @see Map#values()
|
||||
* @see java.util.Map#values()
|
||||
*/
|
||||
public Collection<V> values();
|
||||
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@
|
|||
package org.apache.commons.collections;
|
||||
|
||||
/**
|
||||
* The "read" subset of the {@link Map} interface.
|
||||
* The "read" subset of the {@link java.util.Map} interface.
|
||||
*
|
||||
* @since 4.0
|
||||
* @version $Id$
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ package org.apache.commons.collections;
|
|||
import java.util.Iterator;
|
||||
|
||||
/**
|
||||
* Defines an iterator that operates over an ordered container. Subset of {@link ListIterator}.
|
||||
* Defines an iterator that operates over an ordered container. Subset of {@link java.util.ListIterator}.
|
||||
* <p>
|
||||
* This iterator allows both forward and reverse iteration through the container.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -98,18 +98,18 @@ public interface Trie<K, V> extends SortedMap<K, V> {
|
|||
* value is closest in an XOR metric to the given key. After the closest
|
||||
* entry is found, the {@link Trie} will call select on that entry and continue
|
||||
* calling select for each entry (traversing in order of XOR closeness,
|
||||
* NOT lexicographically) until the cursor returns {@link Decision#EXIT}.
|
||||
* NOT lexicographically) until the cursor returns {@link Cursor.Decision#EXIT}.
|
||||
* <p>
|
||||
* The cursor can return {@link Decision#CONTINUE} to continue traversing.
|
||||
* The cursor can return {@link Cursor.Decision#CONTINUE} to continue traversing.
|
||||
* <p>
|
||||
* {@link Decision#REMOVE_AND_EXIT} is used to remove the current element
|
||||
* {@link Cursor.Decision#REMOVE_AND_EXIT} is used to remove the current element
|
||||
* and stop traversing.
|
||||
* <p>
|
||||
* Note: The {@link Decision#REMOVE} operation is not supported.
|
||||
* Note: The {@link Cursor.Decision#REMOVE} operation is not supported.
|
||||
*
|
||||
* @param key the key to use in the search
|
||||
* @param cursor the cursor used throughout the search
|
||||
* @return the entry the cursor returned {@link Decision#EXIT} on, or null
|
||||
* @return the entry the cursor returned {@link Cursor.Decision#EXIT} on, or null
|
||||
* if it continued till the end
|
||||
*/
|
||||
public Map.Entry<K,V> select(K key, Cursor<? super K, ? super V> cursor);
|
||||
|
|
@ -118,16 +118,16 @@ public interface Trie<K, V> extends SortedMap<K, V> {
|
|||
* Traverses the {@link Trie} in lexicographical order.
|
||||
* {@link Cursor#select(java.util.Map.Entry)} will be called on each entry.
|
||||
* <p>
|
||||
* The traversal will stop when the cursor returns {@link Decision#EXIT},
|
||||
* {@link Decision#CONTINUE} is used to continue traversing and
|
||||
* {@link Decision#REMOVE} is used to remove the element that was selected
|
||||
* The traversal will stop when the cursor returns {@link Cursor.Decision#EXIT},
|
||||
* {@link Cursor.Decision#CONTINUE} is used to continue traversing and
|
||||
* {@link Cursor.Decision#REMOVE} is used to remove the element that was selected
|
||||
* and continue traversing.
|
||||
* <p>
|
||||
* {@link Decision#REMOVE_AND_EXIT} is used to remove the current element
|
||||
* {@link Cursor.Decision#REMOVE_AND_EXIT} is used to remove the current element
|
||||
* and stop traversing.
|
||||
*
|
||||
* @param cursor the cursor used while traversing the {@link Trie}
|
||||
* @return the entry the cursor returned {@link Decision#EXIT} on, or null
|
||||
* @return the entry the cursor returned {@link Cursor.Decision#EXIT} on, or null
|
||||
* if it continued till the end
|
||||
*/
|
||||
public Map.Entry<K,V> traverse(Cursor<? super K, ? super V> cursor);
|
||||
|
|
@ -216,17 +216,17 @@ public interface Trie<K, V> extends SortedMap<K, V> {
|
|||
public SortedMap<K, V> getPrefixedByBits(K key, int offsetInBits, int lengthInBits);
|
||||
|
||||
/**
|
||||
* A {@link Cursor} can be used to traverse a {@link Trie}, visit each node
|
||||
* A {@link Trie.Cursor} can be used to traverse a {@link Trie}, visit each node
|
||||
* step by step and make {@link Decision}s on each step how to continue with
|
||||
* traversing the {@link Trie}.
|
||||
*/
|
||||
public interface Cursor<K, V> {
|
||||
|
||||
/**
|
||||
* The {@link Decision} tells the {@link Cursor} what to do on each step
|
||||
* The {@link Decision} tells the {@link Trie.Cursor} what to do on each step
|
||||
* while traversing the {@link Trie}.
|
||||
*
|
||||
* NOTE: Not all operations that work with a {@link Cursor} support all
|
||||
* NOTE: Not all operations that work with a {@link Trie.Cursor} support all
|
||||
* {@link Decision} types
|
||||
*/
|
||||
public static enum Decision {
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ public class TrieUtils {
|
|||
/**
|
||||
* Returns a synchronized instance of a {@link Trie}
|
||||
*
|
||||
* @see Collections#synchronizedMap(Map)
|
||||
* @see java.util.Collections#synchronizedMap(java.util.Map)
|
||||
*/
|
||||
public static <K, V> Trie<K, V> synchronizedTrie(final Trie<K, V> trie) {
|
||||
return SynchronizedTrie.synchronizedTrie(trie);
|
||||
|
|
@ -44,7 +44,7 @@ public class TrieUtils {
|
|||
/**
|
||||
* Returns an unmodifiable instance of a {@link Trie}
|
||||
*
|
||||
* @see Collections#unmodifiableMap(Map)
|
||||
* @see java.util.Collections#unmodifiableMap(java.util.Map)
|
||||
*/
|
||||
public static <K, V> Trie<K, V> unmodifiableTrie(final Trie<K, V> trie) {
|
||||
return UnmodifiableTrie.unmodifiableTrie(trie);
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ import org.apache.commons.collections.SortedBag;
|
|||
* Order will be maintained among the bag members and can be viewed through the
|
||||
* iterator.
|
||||
* <p>
|
||||
* A {@link Bag} stores each object in the collection together with a count
|
||||
* A {@link org.apache.commons.collections.Bag Bag} stores each object in the collection together with a count
|
||||
* of occurrences. Extra methods on the interface allow multiple copies of an
|
||||
* object to be added or removed at once. It is important to read the interface
|
||||
* javadoc carefully as several methods violate the {@link Collection}
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ import java.util.Comparator;
|
|||
* objects.
|
||||
* <p>
|
||||
* This Comparator is useful, for example, for enforcing the natural order in
|
||||
* custom implementations of {@link SortedSet} and {@link SortedMap}.
|
||||
* custom implementations of {@link java.util.SortedSet SortedSet} and {@link java.util.SortedMap SortedMap}.
|
||||
* <p>
|
||||
* Note: In the 2.0 and 2.1 releases of Commons Collections, this class would
|
||||
* throw a {@link ClassCastException} if either of the arguments to
|
||||
|
|
|
|||
|
|
@ -41,9 +41,9 @@ import java.util.List;
|
|||
* <a href="http://www.cis.upenn.edu/~bcpierce/courses/dd/papers/diff.ps">
|
||||
* An O(ND) Difference Algorithm and Its Variations</a>. This algorithm produces
|
||||
* the shortest possible
|
||||
* {@link org.apache.commons.collections.list.difference.EditScript edit script}
|
||||
* {@link EditScript edit script}
|
||||
* containing all the
|
||||
* {@link org.apache.commons.collections.list.difference.EditCommand commands}
|
||||
* {@link EditCommand commands}
|
||||
* needed to transform the first sequence into the second one.
|
||||
*
|
||||
* @see EditScript
|
||||
|
|
|
|||
|
|
@ -28,7 +28,8 @@ import org.apache.commons.collections.ResettableListIterator;
|
|||
/**
|
||||
* Converts an {@link Iterator} into a {@link ResettableListIterator}.
|
||||
* For plain <code>Iterator</code>s this is accomplished by caching the returned
|
||||
* elements. This class can also be used to simply add {@link ResettableIterator}
|
||||
* elements. This class can also be used to simply add
|
||||
* {@link org.apache.commons.collections.ResettableIterator ResettableIterator}
|
||||
* functionality to a given {@link ListIterator}.
|
||||
* <p>
|
||||
* The <code>ListIterator</code> interface has additional useful methods
|
||||
|
|
|
|||
|
|
@ -21,8 +21,8 @@ import java.util.Map;
|
|||
import org.apache.commons.collections.KeyValue;
|
||||
|
||||
/**
|
||||
* A restricted implementation of {@link Map.Entry} that prevents
|
||||
* the {@link Map.Entry} contract from being broken.
|
||||
* A restricted implementation of {@link java.util.Map.Entry Map.Entry} that prevents
|
||||
* the {@link java.util.Map.Entry Map.Entry} contract from being broken.
|
||||
*
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
|
|
|
|||
|
|
@ -65,7 +65,8 @@ public class PassiveExpiringMap<K, V>
|
|||
implements Serializable {
|
||||
|
||||
/**
|
||||
* A {@link ExpirationPolicy} that returns a expiration time that is a
|
||||
* A {@link org.apache.commons.collections.map.PassiveExpiringMap.ExpirationPolicy ExpirationPolicy}
|
||||
* that returns a expiration time that is a
|
||||
* constant about of time in the future from the current time.
|
||||
*
|
||||
* @param <K> the type of the keys in the map
|
||||
|
|
@ -306,8 +307,8 @@ public class PassiveExpiringMap<K, V>
|
|||
* expire. A zero value results in entries that ALWAYS expire.
|
||||
* @param timeUnit the unit of time for the <code>timeToLive</code>
|
||||
* parameter, must not be null.
|
||||
* @throws IllegalArgumentException if the time unit is null.
|
||||
* @param map the map to decorate, must not be null.
|
||||
* @throws IllegalArgumentException if the time unit is null.
|
||||
* @throws IllegalArgumentException if the map is null.
|
||||
*/
|
||||
public PassiveExpiringMap(final long timeToLive, final TimeUnit timeUnit, final Map<K, V> map) {
|
||||
|
|
|
|||
|
|
@ -140,11 +140,13 @@ public class CompositeSet<E> extends CompositeCollection<E> implements Set<E> {
|
|||
}
|
||||
|
||||
/**
|
||||
* This can receive either a {@link CompositeCollection#CollectionMutator} or a
|
||||
* {@link CompositeSet#SetMutator}. If a {@link CompositeCollection#CollectionMutator}
|
||||
* This can receive either a {@link org.apache.commons.collections.collection.CompositeCollection.CollectionMutator CompositeCollection.CollectionMutator} or a
|
||||
* {@link CompositeSet.SetMutator}.
|
||||
* If a {@link org.apache.commons.collections.collection.CompositeCollection.CollectionMutator CompositeCollection.CollectionMutator}
|
||||
* is used than conflicts when adding composited sets will throw IllegalArgumentException.
|
||||
*
|
||||
* @param mutator the {@link CollectionMutator} to use for this composite
|
||||
* @param mutator the {@link org.apache.commons.collections.collection.CompositeCollection.CollectionMutator CompositeCollection.CollectionMutator}
|
||||
* to use for this composite
|
||||
*/
|
||||
@Override
|
||||
public void setMutator(final CollectionMutator<E> mutator) {
|
||||
|
|
|
|||
|
|
@ -49,14 +49,14 @@ import org.apache.commons.collections.map.LinkedMap;
|
|||
* much of the usefulness of having parameterized types.
|
||||
* <p>
|
||||
* On the downside, this class is not drop-in compatible with {@link java.util.Map}
|
||||
* but is intended to be worked with either directly or by {@link Put} and {@link Get}
|
||||
* but is intended to be worked with either directly or by {@link Put} and {@link org.apache.commons.collections.Get Get}
|
||||
* generalizations.
|
||||
*
|
||||
* @since 4.0
|
||||
* @version $Id$
|
||||
*
|
||||
* @see SplitMapUtils#readableMap(Get)
|
||||
* @see SplitMapUtils#writableMap(Put)
|
||||
* @see org.apache.commons.collections.SplitMapUtils#readableMap(Get)
|
||||
* @see org.apache.commons.collections.SplitMapUtils#writableMap(Put)
|
||||
*/
|
||||
public class TransformedMap<J, K, U, V> extends AbstractIterableGetMapDecorator<K, V>
|
||||
implements Put<J, U>, Serializable {
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ import java.io.Serializable;
|
|||
import java.util.Comparator;
|
||||
|
||||
/**
|
||||
* Defines the interface to analyze {@link Trie} keys on a bit level.
|
||||
* Defines the interface to analyze {@link org.apache.commons.collections.Trie Trie} keys on a bit level.
|
||||
* {@link KeyAnalyzer}'s methods return the length of the key in bits,
|
||||
* whether or not a bit is set, and bits per element in the key.
|
||||
* <p>
|
||||
|
|
|
|||
|
|
@ -140,7 +140,7 @@ public class PatriciaTrie<K, V> extends PatriciaTrieBase<K, V> implements Trie<K
|
|||
* {@inheritDoc}
|
||||
*
|
||||
* The view that this returns is optimized to have a very efficient
|
||||
* {@link Iterator}. The {@link SortedMap#firstEntry()},
|
||||
* {@link Iterator}. The {@link SortedMap#firstKey()},
|
||||
* {@link SortedMap#lastKey()} & {@link Map#size()} methods must
|
||||
* iterate over all possible values in order to determine the results.
|
||||
* This information is cached until the PATRICIA {@link Trie} changes.
|
||||
|
|
|
|||
|
|
@ -64,16 +64,13 @@ abstract class PatriciaTrieBase<K, V> extends AbstractTrie<K, V> {
|
|||
*/
|
||||
transient int modCount = 0;
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public PatriciaTrieBase(final KeyAnalyzer<? super K> keyAnalyzer) {
|
||||
super(keyAnalyzer);
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs a new {@link Trie} using the given {@link KeyAnalyzer}
|
||||
* and initializes the {@link Trie} with the values from the
|
||||
* Constructs a new {@link org.apache.commons.collections.Trie Trie} using the given {@link KeyAnalyzer}
|
||||
* and initializes the {@link org.apache.commons.collections.Trie Trie} with the values from the
|
||||
* provided {@link Map}.
|
||||
*/
|
||||
public PatriciaTrieBase(final KeyAnalyzer<? super K> keyAnalyzer,
|
||||
|
|
|
|||
Loading…
Reference in New Issue