org.apache.lucene.document

## Class StringField

- java.lang.Object
- - org.apache.lucene.document.Field
  - - org.apache.lucene.document.StringField

- All Implemented Interfaces:
    IndexableField

      public final class StringField
      extends Field

  A field that is indexed but not tokenized: the entire String value is indexed as a single token. For example this might be used for a 'country' field or an 'id' field. If you also need to sort on this field, separately add a `SortedDocValuesField` to your document.

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from class org.apache.lucene.document.Field

      `Field.Store`

  - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static FieldType` | `TYPE_NOT_STORED` Indexed, not tokenized, omits norms, indexes DOCS_ONLY, not stored.
    `static FieldType` | `TYPE_STORED` Indexed, not tokenized, omits norms, indexes DOCS_ONLY, stored

    - ### Fields inherited from class org.apache.lucene.document.Field

      `fieldsData, name, tokenStream, type`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `StringField(String name, BytesRef value, Field.Store stored)` Creates a new binary StringField, indexing the provided binary (BytesRef) value as a single token.
    `StringField(String name, String value, Field.Store stored)` Creates a new textual StringField, indexing the provided String value as a single token.

  - ### Method Summary

    - ### Methods inherited from class org.apache.lucene.document.Field

      `binaryValue, fieldType, getCharSequenceValue, name, numericValue, readerValue, setBytesValue, setBytesValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setReaderValue, setShortValue, setStringValue, setTokenStream, stringValue, tokenStream, tokenStreamValue, toString`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Field Detail

    - #### TYPE_NOT_STORED

          public static final FieldType TYPE_NOT_STORED

      Indexed, not tokenized, omits norms, indexes DOCS_ONLY, not stored.

    - #### TYPE_STORED

          public static final FieldType TYPE_STORED

      Indexed, not tokenized, omits norms, indexes DOCS_ONLY, stored

  - ### Constructor Detail

    - #### StringField

          public StringField(String name,
                             String value,
                             Field.Store stored)

      Creates a new textual StringField, indexing the provided String value as a single token.
      Parameters:
        `name` - field name
        `value` - String value
        `stored` - Store.YES if the content should also be stored
      Throws:
        `IllegalArgumentException` - if the field name or value is null.

    - #### StringField

          public StringField(String name,
                             BytesRef value,
                             Field.Store stored)

      Creates a new binary StringField, indexing the provided binary (BytesRef) value as a single token.
      Parameters:
        `name` - field name
        `value` - BytesRef value. The provided value is not cloned so you must not change it until the document(s) holding it have been indexed.
        `stored` - Store.YES if the content should also be stored
      Throws:
        `IllegalArgumentException` - if the field name or value is null.

Copyright © 2000-2022 Apache Software Foundation. All Rights Reserved.