SingleTokenTokenStream (Lucene 2.9.4 API)

java.lang.Object
- org.apache.lucene.util.AttributeSource
- - org.apache.lucene.analysis.TokenStream
  - - org.apache.lucene.analysis.miscellaneous.SingleTokenTokenStream

public class SingleTokenTokenStream
extends org.apache.lucene.analysis.TokenStream

A TokenStream containing a single token.

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource
  org.apache.lucene.util.AttributeSource.AttributeFactory, org.apache.lucene.util.AttributeSource.State

Constructor Summary

Constructors
Constructor and Description

SingleTokenTokenStream(org.apache.lucene.analysis.Token token)

Constructors
Constructor and Description
`SingleTokenTokenStream(org.apache.lucene.analysis.Token token)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`org.apache.lucene.analysis.Token`	`getToken()`
`boolean`	`incrementToken()`
`org.apache.lucene.analysis.Token`	`next()` Deprecated. Will be removed in Lucene 3.0. This method is final, as it should not be overridden. Delegates to the backwards compatibility layer.
`org.apache.lucene.analysis.Token`	`next(org.apache.lucene.analysis.Token reusableToken)` Deprecated. Will be removed in Lucene 3.0. This method is final, as it should not be overridden. Delegates to the backwards compatibility layer.
`void`	`reset()`
`void`	`setToken(org.apache.lucene.analysis.Token token)`

Methods inherited from class org.apache.lucene.analysis.TokenStream
close, end, getOnlyUseNewAPI, setOnlyUseNewAPI

Methods inherited from class org.apache.lucene.util.AttributeSource
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, restoreState, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SingleTokenTokenStream
```
public SingleTokenTokenStream(org.apache.lucene.analysis.Token token)
```
- Method Detail
  - incrementToken
```
public final boolean incrementToken()
                             throws java.io.IOException
```
    Overrides:
    
    incrementToken in class org.apache.lucene.analysis.TokenStream
    
    Throws:
    
    java.io.IOException
  - next
```
public final org.apache.lucene.analysis.Token next(org.apache.lucene.analysis.Token reusableToken)
                                            throws java.io.IOException
```
    Deprecated. Will be removed in Lucene 3.0. This method is final, as it should not be overridden. Delegates to the backwards compatibility layer.
    
    Overrides:
    
    next in class org.apache.lucene.analysis.TokenStream
    
    Throws:
    
    java.io.IOException
  - next
```
public final org.apache.lucene.analysis.Token next()
                                            throws java.io.IOException
```
    Deprecated. Will be removed in Lucene 3.0. This method is final, as it should not be overridden. Delegates to the backwards compatibility layer.
    
    Overrides:
    
    next in class org.apache.lucene.analysis.TokenStream
    
    Throws:
    
    java.io.IOException
  - reset
```
public void reset()
           throws java.io.IOException
```
    Overrides:
    
    reset in class org.apache.lucene.analysis.TokenStream
    
    Throws:
    
    java.io.IOException
  - getToken
```
public org.apache.lucene.analysis.Token getToken()
```
  - setToken
```
public void setToken(org.apache.lucene.analysis.Token token)
```

Class SingleTokenTokenStream

Nested Class Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

SingleTokenTokenStream

Method Detail

incrementToken

next

next

reset

getToken

setToken