[utilities COMMIT] in /java-support/trunk/src/main/java/net/shibboleth/utilities/java/support/annotation/constraint: ...

[noreply at shibboleth.net]

Author: scantor
Date: Mon Jun  3 15:36:18 2013
New Revision: 410

URL: http://svn.shibboleth.net/view/utilities?rev=410&view=rev
Log:
Improve descriptions.

Modified:
    java-support/trunk/src/main/java/net/shibboleth/utilities/java/support/annotation/constraint/NonnullElements.java
    java-support/trunk/src/main/java/net/shibboleth/utilities/java/support/annotation/constraint/NullableElements.java

Modified: java-support/trunk/src/main/java/net/shibboleth/utilities/java/support/annotation/constraint/NonnullElements.java
URL: http://svn.shibboleth.net/view/utilities/java-support/trunk/src/main/java/net/shibboleth/utilities/java/support/annotation/constraint/NonnullElements.java?rev=410&r1=409&r2=410&view=diff
==============================================================================
--- java-support/trunk/src/main/java/net/shibboleth/utilities/java/support/annotation/constraint/NonnullElements.java (original)
+++ java-support/trunk/src/main/java/net/shibboleth/utilities/java/support/annotation/constraint/NonnullElements.java Mon Jun  3 15:36:18 2013
@@ -21,7 +21,18 @@
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Target;
 
-/** Indicates that the annotated collection does not contain any null elements. */
+/**
+ * Indicates that the annotated collection cannot contain any null elements:
+ * 
+ * <ul>
+ * <li>Input collections as parameters MUST NOT contain any null elements.</li>
+ * <li>Collections returned by methods WILL NOT contain any null elements, and if mutable,
+ * callers MUST NOT add a null element.</li>
+ * </ul>
+ * 
+ * <p>Behavior is undefined if these constraints are violated. Some form of exception should be
+ * expected.</p>
+ */
 @Documented
 @Target({ElementType.FIELD, ElementType.LOCAL_VARIABLE, ElementType.METHOD, ElementType.PARAMETER})
 public @interface NonnullElements {

Modified: java-support/trunk/src/main/java/net/shibboleth/utilities/java/support/annotation/constraint/NullableElements.java
URL: http://svn.shibboleth.net/view/utilities/java-support/trunk/src/main/java/net/shibboleth/utilities/java/support/annotation/constraint/NullableElements.java?rev=410&r1=409&r2=410&view=diff
==============================================================================
--- java-support/trunk/src/main/java/net/shibboleth/utilities/java/support/annotation/constraint/NullableElements.java (original)
+++ java-support/trunk/src/main/java/net/shibboleth/utilities/java/support/annotation/constraint/NullableElements.java Mon Jun  3 15:36:18 2013
@@ -21,7 +21,10 @@
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Target;
 
-/** Indicates that the annotated collection may contain null elements. */
+/**
+ * Indicates that the annotated collection may contain null elements and, if mutable, null
+ * elements may be added to it safely.
+ */
 @Documented
 @Target({ElementType.FIELD, ElementType.LOCAL_VARIABLE, ElementType.METHOD, ElementType.PARAMETER})
 public @interface NullableElements {