Class StoredField

java.lang.Object
org.apache.lucene.document.Field
org.apache.lucene.document.StoredField
All Implemented Interfaces:
IndexableField

public final class StoredField extends Field
A field whose value is stored so that IndexSearcher.doc(int) and IndexReader.document(int, org.apache.lucene.index.StoredFieldVisitor) will return the field and its value.
  • Field Details

    • TYPE

      public static final FieldType TYPE
      Type for a stored-only field.
  • Constructor Details

    • StoredField

      public StoredField(String name, byte[] value)
      Create a stored-only field with the given binary value.

      NOTE: the provided byte[] is not copied so be sure not to change it until you're done with this field.

      Parameters:
      name - field name
      value - byte array pointing to binary content (not copied)
      Throws:
      IllegalArgumentException - if the field name is null.
    • StoredField

      public StoredField(String name, byte[] value, int offset, int length)
      Create a stored-only field with the given binary value.

      NOTE: the provided byte[] is not copied so be sure not to change it until you're done with this field.

      Parameters:
      name - field name
      value - byte array pointing to binary content (not copied)
      offset - starting position of the byte array
      length - valid length of the byte array
      Throws:
      IllegalArgumentException - if the field name is null.
    • StoredField

      public StoredField(String name, BytesRef value)
      Create a stored-only field with the given binary value.

      NOTE: the provided BytesRef is not copied so be sure not to change it until you're done with this field.

      Parameters:
      name - field name
      value - BytesRef pointing to binary content (not copied)
      Throws:
      IllegalArgumentException - if the field name is null.
    • StoredField

      public StoredField(String name, String value)
      Create a stored-only field with the given string value.
      Parameters:
      name - field name
      value - string value
      Throws:
      IllegalArgumentException - if the field name or value is null.
    • StoredField

      public StoredField(String name, int value)
      Create a stored-only field with the given integer value.
      Parameters:
      name - field name
      value - integer value
      Throws:
      IllegalArgumentException - if the field name is null.
    • StoredField

      public StoredField(String name, float value)
      Create a stored-only field with the given float value.
      Parameters:
      name - field name
      value - float value
      Throws:
      IllegalArgumentException - if the field name is null.
    • StoredField

      public StoredField(String name, long value)
      Create a stored-only field with the given long value.
      Parameters:
      name - field name
      value - long value
      Throws:
      IllegalArgumentException - if the field name is null.
    • StoredField

      public StoredField(String name, double value)
      Create a stored-only field with the given double value.
      Parameters:
      name - field name
      value - double value
      Throws:
      IllegalArgumentException - if the field name is null.