Module org.apache.lucene.core
Package org.apache.lucene.document

Class Field.BinaryTokenStream

java.lang.Object
org.apache.lucene.util.AttributeSource
org.apache.lucene.analysis.TokenStream
org.apache.lucene.document.Field.BinaryTokenStream
All Implemented Interfaces:
Closeable, AutoCloseable
Enclosing class:
Field
private static final class Field.BinaryTokenStream extends TokenStream

  • Field Details

  • Constructor Details

    • BinaryTokenStream

      BinaryTokenStream()
      Creates a new TokenStream that returns a BytesRef as single token.

      Warning: Does not initialize the value, you must call setValue(BytesRef) afterwards!

  • Method Details

    • setValue

      public void setValue(BytesRef value)

    • incrementToken

      public boolean incrementToken()
      Description copied from class: TokenStream
      Consumers (i.e., IndexWriter) use this method to advance the stream to the next token. Implementing classes must implement this method and update the appropriate AttributeImpls with the attributes of the next token.

      The producer must make no assumptions about the attributes after the method has been returned: the caller may arbitrarily change it. If the producer needs to preserve the state for subsequent calls, it can use AttributeSource.captureState() to create a copy of the current attribute state.

      This method is called for every token of a document, so an efficient implementation is crucial for good performance. To avoid calls to AttributeSource.addAttribute(Class) and AttributeSource.getAttribute(Class), references to all AttributeImpls that this stream uses should be retrieved during instantiation.

      To ensure that filters and consumers know which attributes are available, the attributes must be added during instantiation. Filters and consumers are not required to check for availability of attributes in TokenStream.incrementToken().

      Specified by:
      incrementToken in class TokenStream
      Returns:
      false for end of stream; true otherwise

    • reset

      public void reset()
      Description copied from class: TokenStream
      This method is called by a consumer before it begins consumption using TokenStream.incrementToken().

      Resets this stream to a clean state. Stateful implementations must implement this method so that they can be reused, just as if they had been created fresh.

      If you override this method, always call super.reset(), otherwise some internal state will not be correctly reset (e.g., Tokenizer will throw IllegalStateException on further usage).

      Overrides:
      reset in class TokenStream

    • close

      public void close()
      Description copied from class: TokenStream
      Releases resources associated with this stream.

      If you override this method, always call super.close(), otherwise some internal state will not be correctly reset (e.g., Tokenizer will throw IllegalStateException on reuse).

      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Overrides:
      close in class TokenStream