You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ch...@apache.org on 2017/07/11 17:55:46 UTC
[61/77] [abbrv] commons-collections git commit: javadoc
javadoc
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/collections/branches/collections_jdk5_branch@813924 13f79535-47bb-0310-9956-ffa450edef68
Project: http://git-wip-us.apache.org/repos/asf/commons-collections/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-collections/commit/df940e08
Tree: http://git-wip-us.apache.org/repos/asf/commons-collections/tree/df940e08
Diff: http://git-wip-us.apache.org/repos/asf/commons-collections/diff/df940e08
Branch: refs/heads/collections_jdk5_branch
Commit: df940e08fb179603eec565bc12a3c22d48bac23d
Parents: a68a932
Author: Matthew Jason Benson <mb...@apache.org>
Authored: Fri Sep 11 17:03:40 2009 +0000
Committer: Matthew Jason Benson <mb...@apache.org>
Committed: Fri Sep 11 17:03:40 2009 +0000
----------------------------------------------------------------------
.../apache/commons/collections/IndexedCollection.java | 13 +++++++++----
1 file changed, 9 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-collections/blob/df940e08/src/java/org/apache/commons/collections/IndexedCollection.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/commons/collections/IndexedCollection.java b/src/java/org/apache/commons/collections/IndexedCollection.java
index 92d8bd7..0b8b2f7 100644
--- a/src/java/org/apache/commons/collections/IndexedCollection.java
+++ b/src/java/org/apache/commons/collections/IndexedCollection.java
@@ -16,7 +16,7 @@ import org.apache.commons.collections.collection.AbstractCollectionDecorator;
* 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 @@ public class IndexedCollection<K, C> extends AbstractCollectionDecorator<C> {
/**
* 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 @@ public class IndexedCollection<K, C> extends AbstractCollectionDecorator<C> {
/**
* 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 @@ public class IndexedCollection<K, C> extends AbstractCollectionDecorator<C> {
/**
* Provides checking for adding the index.
- *
+ *
* @param object the object to index.
*/
private void addIndex(C object) {
@@ -110,6 +110,11 @@ public class IndexedCollection<K, C> extends AbstractCollectionDecorator<C> {
}
}
+ /**
+ * 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);
}