[tmapi-commit] SF.net SVN: tmapi:[167] trunk/src/main/java/org/tmapi/index/ TypeInstanceIndex.java

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

Revision: 167
          http://tmapi.svn.sourceforge.net/tmapi/?rev=167&view=rev
Author:   lheuer
Date:     2010-03-05 20:32:27 +0000 (Fri, 05 Mar 2010)

Log Message:
-----------
Fixed docs, reported by Jan  Schreiber

Modified Paths:
--------------
    trunk/src/main/java/org/tmapi/index/TypeInstanceIndex.java

Modified: trunk/src/main/java/org/tmapi/index/TypeInstanceIndex.java
===================================================================
--- trunk/src/main/java/org/tmapi/index/TypeInstanceIndex.java	2010-03-02 23:56:30 UTC (rev 166)
+++ trunk/src/main/java/org/tmapi/index/TypeInstanceIndex.java	2010-03-05 20:32:27 UTC (rev 167)
@@ -39,7 +39,8 @@
 public interface TypeInstanceIndex extends Index {
 
     /**
-     * Returns the topics which are an instance of the specified <tt>type</tt>.
+     * Returns the topics which are an instance of the specified <tt>type</tt> or
+     * all topics which have no type (iff {@code type} is {@code null).
      * <p>
      * Note: Implementations may return only those topics whose <tt>types</tt>
      * property contains the type and may ignore 
@@ -50,7 +51,7 @@
      * </p>
      * The return value may be empty but must never be <tt>null</tt>.
      * 
-     * @param type The type of the {@link Topic}s to be returned.
+     * @param type The type of the {@link Topic}s to be returned or {@code null} to return all untyped topics.
      * @return An unmodifiable collection of {@link Topic}s.
      */
     public Collection<Topic> getTopics(Topic type);


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