Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

LUCENE-1233: correct javadocs 

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@637844 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael McCandless 2008-03-17 11:31:46 +00:00
parent c975851ab5
commit a7e55a2a79
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/java/org/apache/lucene/document/Document.java
View File

@ -197,6 +197,8 @@ public final class Document implements java.io.Serializable {
/** /**
* Returns an array of {@link Field}s with the given name. * Returns an array of {@link Field}s with the given name.
* Do not use with lazy loaded fields. * 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 * @param name the name of the field
* @return a <code>Field[]</code> array * @return a <code>Field[]</code> array
@ -221,9 +223,11 @@ public final class Document implements java.io.Serializable {
/** /**
* Returns an array of {@link Fieldable}s with the given name. * 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 * @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) { public Fieldable[] getFieldables(String name) {
List result = new ArrayList(); List result = new ArrayList();
@ -245,9 +249,10 @@ public final class Document implements java.io.Serializable {
/** /**
* Returns an array of values of the field specified as the method parameter. * 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 * @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) { public final String[] getValues(String name) {
List result = new ArrayList(); List result = new ArrayList();
@ -267,10 +272,12 @@ public final class Document implements java.io.Serializable {
/** /**
* Returns an array of byte arrays for of the fields that have the name specified * 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 * @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) { public final byte[][] getBinaryValues(String name) {
List result = new ArrayList(); List result = new ArrayList();