lucene-java-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mikemcc...@apache.org
Subject svn commit: r637844 - /lucene/java/trunk/src/java/org/apache/lucene/document/Document.java
Date Mon, 17 Mar 2008 11:31:47 GMT
Author: mikemccand
Date: Mon Mar 17 04:31:46 2008
New Revision: 637844

URL: http://svn.apache.org/viewvc?rev=637844&view=rev
Log:
LUCENE-1233: correct javadocs

Modified:
    lucene/java/trunk/src/java/org/apache/lucene/document/Document.java

Modified: lucene/java/trunk/src/java/org/apache/lucene/document/Document.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/document/Document.java?rev=637844&r1=637843&r2=637844&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/document/Document.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/document/Document.java Mon Mar 17 04:31:46
2008
@@ -197,6 +197,8 @@
   /**
    * Returns an array of {@link Field}s with the given name.
    * Do not use with lazy loaded fields.
+   * This method returns an empty array when there are no
+   * matching fields.  It never returns null.
    *
    * @param name the name of the field
    * @return a <code>Field[]</code> array
@@ -221,9 +223,11 @@
 
    /**
    * Returns an array of {@link Fieldable}s with the given name.
+   * This method returns an empty array when there are no
+   * matching fields.  It never returns null.
    *
    * @param name the name of the field
-   * @return a <code>Fieldable[]</code> array or <code>null</code>
+   * @return a <code>Fieldable[]</code> array
    */
    public Fieldable[] getFieldables(String name) {
      List result = new ArrayList();
@@ -245,9 +249,10 @@
 
   /**
    * Returns an array of values of the field specified as the method parameter.
-   *
+   * This method returns an empty array when there are no
+   * matching fields.  It never returns null.
    * @param name the name of the field
-   * @return a <code>String[]</code> of field values or <code>null</code>
+   * @return a <code>String[]</code> of field values
    */
   public final String[] getValues(String name) {
     List result = new ArrayList();
@@ -267,10 +272,12 @@
 
   /**
   * Returns an array of byte arrays for of the fields that have the name specified
-  * as the method parameter.
+  * as the method parameter.  This method returns an empty
+  * array when there are no matching fields.  It never
+  * returns null.
   *
   * @param name the name of the field
-  * @return a  <code>byte[][]</code> of binary field values or <code>null</code>
+  * @return a <code>byte[][]</code> of binary field values
   */
   public final byte[][] getBinaryValues(String name) {
     List result = new ArrayList();



Mime
View raw message