[java-metadata-aggregator COMMIT] /trunk/aggregator-pipeline/src/main/java/net/shibboleth/metadata/ItemId.java

[noreply at shibboleth.net]

Author: iay
Date: Fri Nov 29 06:59:30 2013
New Revision: 300

URL: http://svn.shibboleth.net/view/java-metadata-aggregator?rev=300&view=rev
Log:
Clarify the nature of ItemId in Javadoc.

Modified:
    trunk/aggregator-pipeline/src/main/java/net/shibboleth/metadata/ItemId.java

Modified: trunk/aggregator-pipeline/src/main/java/net/shibboleth/metadata/ItemId.java
URL: http://svn.shibboleth.net/view/java-metadata-aggregator/trunk/aggregator-pipeline/src/main/java/net/shibboleth/metadata/ItemId.java?rev=300&r1=299&r2=300&view=diff
==============================================================================
--- trunk/aggregator-pipeline/src/main/java/net/shibboleth/metadata/ItemId.java (original)
+++ trunk/aggregator-pipeline/src/main/java/net/shibboleth/metadata/ItemId.java Fri Nov 29 06:59:30 2013
@@ -26,7 +26,13 @@
 
 import com.google.common.base.Objects;
 
-/** Carries a unique identifier for the data carried by an Item. */
+/**
+ * Carries a unique identifier for the data carried by an {@link net.shibboleth.metadata.Item}.
+ * 
+ * An {@link net.shibboleth.metadata.Item} may have more than one {@link ItemId}, but should not
+ * have the same {@link ItemId} as any other {@link net.shibboleth.metadata.Item} in a given
+ * context.
+ */
 @ThreadSafe
 public class ItemId implements ItemMetadata, Comparable<ItemId> {