KeywordAttribute (Lucene 3.6.2 API)

All Superinterfaces:

Attribute

All Known Implementing Classes:

KeywordAttributeImpl
```
public interface KeywordAttribute
extends Attribute
```
This attribute can be used to mark a token as a keyword. Keyword aware TokenStreams can decide to modify a token based on the return value of isKeyword() if the token is modified. Stemming filters for instance can use this attribute to conditionally skip a term if isKeyword() returns true.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`isKeyword()`	Returns `true` iff the current token is a keyword, otherwise `false`/
`void`	`setKeyword(boolean isKeyword)`	Marks the current token as keyword iff set to `true`.

- Method Detail
  - isKeyword
```
boolean isKeyword()
```
    Returns true iff the current token is a keyword, otherwise false/
    
    Returns:
    
    true iff the current token is a keyword, otherwise false/
  - setKeyword
```
void setKeyword(boolean isKeyword)
```
    Marks the current token as keyword iff set to true.
    
    Parameters:
    
    isKeyword - true iff the current token is a keyword, otherwise false.