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

LUCENE-3312: Fix incorrect JavaDocs 

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/branches/lucene3312@1379207 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Uwe Schindler 2012-08-30 22:58:33 +00:00
parent 50d2639308
commit 9e19c17094
1 changed files with 20 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
lucene/core/src/java/org/apache/lucene/document/StoredField.java
View File

@ -38,11 +38,10 @@ public class StoredField extends Field {
} }
/** /**
* Create a stored-only field with the given binary value. * Expert: allows you to customize the {@link
* <p>NOTE: the provided byte[] is not copied so be sure * FieldType}.
* not to change it until you're done with this field.
* @param name field name * @param name field name
* @param value byte array pointing to binary content (not copied) * @param type custom {@link FieldType} for this field
* @throws IllegalArgumentException if the field name is null. * @throws IllegalArgumentException if the field name is null.
*/ */
protected StoredField(String name, FieldType type) { protected StoredField(String name, FieldType type) {
@ -55,7 +54,7 @@ public class StoredField extends Field {
* <p>NOTE: the provided byte[] is not copied so be sure * <p>NOTE: the provided byte[] is not copied so be sure
* not to change it until you're done with this field. * not to change it until you're done with this field.
* @param name field name * @param name field name
* @param value byte array pointing to binary content (not copied) * @param bytes byte array pointing to binary content (not copied)
* @param type custom {@link FieldType} for this field * @param type custom {@link FieldType} for this field
* @throws IllegalArgumentException if the field name is null. * @throws IllegalArgumentException if the field name is null.
*/ */
@ -63,6 +62,14 @@ public class StoredField extends Field {
super(name, bytes, type); super(name, bytes, type);
} }
/**
* Create a stored-only field with the given binary value.
* <p>NOTE: the provided byte[] is not copied so be sure
* not to change it until you're done with this field.
* @param name field name
* @param value byte array pointing to binary content (not copied)
* @throws IllegalArgumentException if the field name is null.
*/
public StoredField(String name, byte[] value) { public StoredField(String name, byte[] value) {
super(name, value, TYPE); super(name, value, TYPE);
} }
@ -103,6 +110,14 @@ public class StoredField extends Field {
super(name, value, TYPE); super(name, value, TYPE);
} }
/**
* Expert: allows you to customize the {@link
* FieldType}.
* @param name field name
* @param value string value
* @param type custom {@link FieldType} for this field
* @throws IllegalArgumentException if the field name or value is null.
*/
public StoredField(String name, String value, FieldType type) { public StoredField(String name, String value, FieldType type) {
super(name, value, type); super(name, value, type);
} }