[tmapi-commit] SF.net SVN: tmapi:[105] trunk/src/main/java/org/tmapi/core/Topic.java

[<lh...@us...>]

Revision: 105
          http://tmapi.svn.sourceforge.net/tmapi/?rev=105&view=rev
Author:   lheuer
Date:     2009-05-08 14:43:04 +0000 (Fri, 08 May 2009)

Log Message:
-----------
Fixed JavaDoc: Scope parameter is never null, an empty collection may represent the UCS, never null

Modified Paths:
--------------
    trunk/src/main/java/org/tmapi/core/Topic.java

Modified: trunk/src/main/java/org/tmapi/core/Topic.java
===================================================================
--- trunk/src/main/java/org/tmapi/core/Topic.java	2009-03-27 10:32:43 UTC (rev 104)
+++ trunk/src/main/java/org/tmapi/core/Topic.java	2009-05-08 14:43:04 UTC (rev 105)
@@ -171,8 +171,8 @@
      *
      * @param type The name type; MUST NOT be <tt>null</tt>.
      * @param value The string value of the name; MUST NOT be <tt>null</tt>.
-     * @param scope A collection of themes or <tt>null</tt> if the name should
-     *              be in the unconstrained scope.
+     * @param scope A collection of themes. The collection may be empty if the name 
+     *              should be in the unconstrained scope.
      * @return The newly created {@link Name}.
      * @throws ModelConstraintException If either the <tt>type</tt>, the 
      *              <tt>value</tt>, or <tt>scope</tt> is <tt>null</tt>.
@@ -208,8 +208,8 @@
      * </p>
      * 
      * @param value The string value of the name; MUST NOT be <tt>null</tt>.
-     * @param scope A collection of themes or <tt>null</tt> if the name should
-     *              be in the unconstrained scope.
+     * @param scope A collection of themes. The collection may be empty if the name 
+     *              should be in the unconstrained scope.
      * @return The newly created {@link Name}.
      * @throws ModelConstraintException If either the <tt>value</tt>, or 
      *              <tt>scope</tt> is <tt>null</tt>.
@@ -278,7 +278,7 @@
      * 
      * @param type The occurrence type; MUST NOT be <tt>null</tt>.
      * @param value The string value of the occurrence.
-     * @param scope A collection of themes or <tt>null</tt> if the occurrence 
+     * @param scope A collection of themes. The collection may be empty if the occurrence 
      *              should be in the unconstrained scope.
      * @return The newly created {@link Occurrence}.
      * @throws ModelConstraintException If either the <tt>type</tt>, the 
@@ -317,7 +317,7 @@
      * 
      * @param type The occurrence type; MUST NOT be <tt>null</tt>.
      * @param value A locator which represents an IRI.
-     * @param scope A collection of themes or <tt>null</tt> if the occurrence 
+     * @param scope A collection of themes. The collection may be empty if the occurrence 
      *              should be in the unconstrained scope.
      * @return The newly created {@link Occurrence}.
      * @throws ModelConstraintException If either the <tt>type</tt>, the 
@@ -359,7 +359,7 @@
      * @param type The occurrence type; MUST NOT be <tt>null</tt>.
      * @param value A lexical string representation of the value.
      * @param datatype A locator indicating the datatype of the <tt>value</tt>.
-     * @param scope A collection of themes or <tt>null</tt> if the occurrence 
+     * @param scope A collection of themes. The collection may be empty if the occurrence 
      *              should be in the unconstrained scope.
      * @return The newly created {@link Occurrence}.
      * @throws ModelConstraintException If either the <tt>type</tt>, the 


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.