Author: mbenson
Date: Fri Sep 11 17:03:40 2009
New Revision: 813924
URL: http://svn.apache.org/viewvc?rev=813924&view=rev
Log:
javadoc
Modified:
commons/proper/collections/branches/collections_jdk5_branch/src/java/org/apache/commons/collections/IndexedCollection.java
Modified:
commons/proper/collections/branches/collections_jdk5_branch/src/java/org/apache/commons/collections/IndexedCollection.java
URL:
http://svn.apache.org/viewvc/commons/proper/collections/branches/collections_jdk5_branch/src/java/org/apache/commons/collections/IndexedCollection.java?rev=813924&r1=813923&r2=813924&view=diff
==============================================================================
---
commons/proper/collections/branches/collections_jdk5_branch/src/java/org/apache/commons/collections/IndexedCollection.java
(original)
+++
commons/proper/collections/branches/collections_jdk5_branch/src/java/org/apache/commons/collections/IndexedCollection.java
Fri Sep 11 17:03:40 2009
@@ -16,7 +16,7 @@
* If modification to the decorated {...@link Collection} is unavoidable, then
a
* call to {...@link #reindex()} will update the index to the current contents
of
* the {...@link Collection}.
- *
+ *
* @param K the type of object in the index.
* @param C the type of object in the collection.
* @author Stephen Kestle
@@ -31,7 +31,7 @@
/**
* Create an {...@link IndexedCollection} for a unique index.
- *
+ *
* @param <K> the index object type.
* @param <C> the collection type.
* @param coll the decorated {...@link Collection}.
@@ -54,7 +54,7 @@
/**
* Create a {...@link IndexedCollection} for a unique index.
- *
+ *
* @param coll the decorated {...@link Collection}.
* @param keyTransformer the {...@link Transformer} for generating index
keys.
* @return the created {...@link IndexedCollection}.
@@ -100,7 +100,7 @@
/**
* Provides checking for adding the index.
- *
+ *
* @param object the object to index.
*/
private void addIndex(C object) {
@@ -110,6 +110,11 @@
}
}
+ /**
+ * Get the element associated with the given key.
+ * @param key to look up
+ * @return element found
+ */
public C get(K key) {
return index.get(key);
}
