org.apache.lucene.analysis
Class CannedTokenStream

java.lang.Object
  org.apache.lucene.util.AttributeSource
      org.apache.lucene.analysis.TokenStream
          org.apache.lucene.analysis.CannedTokenStream

All Implemented Interfaces:

Closeable

public final class CannedTokenStream
extends TokenStream

TokenStream from a canned list of Tokens.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource

AttributeSource.AttributeFactory, AttributeSource.State

Constructor Summary

CannedTokenStream(int finalPosInc, int finalOffset, Token... tokens)
If you want trailing holes, pass a non-zero finalPosInc.

CannedTokenStream(Token... tokens)

Method Summary

void	end()
boolean	incrementToken()

Methods inherited from class org.apache.lucene.analysis.TokenStream

close, reset

Methods inherited from class org.apache.lucene.util.AttributeSource

addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, restoreState, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CannedTokenStream

public CannedTokenStream(Token... tokens)

CannedTokenStream

public CannedTokenStream(int finalPosInc,
                         int finalOffset,
                         Token... tokens)

If you want trailing holes, pass a non-zero finalPosInc.

Method Detail

end

public void end()
         throws IOException

Overrides:

end in class TokenStream

Throws:

IOException

incrementToken

public boolean incrementToken()

Specified by:

incrementToken in class TokenStream