Skip navigation links
org.apache.lucene.analysis

Class TeeTokenFilter

    • Method Detail

      • next

        public Token next(Token reusableToken)
                   throws java.io.IOException
        Deprecated. 
        Description copied from class: TokenStream
        Returns the next token in the stream, or null at EOS. When possible, the input Token should be used as the returned Token (this gives fastest tokenization performance), but this is not required and a new Token may be returned. Callers may re-use a single Token instance for successive calls to this method.

        This implicitly defines a "contract" between consumers (callers of this method) and producers (implementations of this method that are the source for tokens):

        • A consumer must fully consume the previously returned Token before calling this method again.
        • A producer must call Token.clear() before setting the fields in it and returning it
        Also, the producer must make no assumptions about a Token after it has been returned: the caller may arbitrarily change it. If the producer needs to hold onto the Token for subsequent calls, it must clone() it before storing it. Note that a TokenFilter is considered a consumer.
        Overrides:
        next in class TokenStream
        Parameters:
        reusableToken - a Token that may or may not be used to return; this parameter should never be null (the callee is not required to check for null before using it, but it is a good idea to assert that it is not null.)
        Returns:
        next Token in the stream or null if end-of-stream was hit
        Throws:
        java.io.IOException

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