Interface KeywordAttribute
- 
- 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 awareTokenStreams can decide to modify a token based on the return value ofisKeyword()if the token is modified. Stemming filters for instance can use this attribute to conditionally skip a term ifisKeyword()returnstrue. 
- 
- 
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleanisKeyword()Returnstrueif the current token is a keyword, otherwisefalsevoidsetKeyword(boolean isKeyword)Marks the current token as keyword if set totrue. 
 - 
 
- 
- 
Method Detail
- 
isKeyword
boolean isKeyword()
Returnstrueif the current token is a keyword, otherwisefalse- Returns:
 trueif the current token is a keyword, otherwisefalse- See Also:
 setKeyword(boolean)
 
- 
setKeyword
void setKeyword(boolean isKeyword)
Marks the current token as keyword if set totrue.- Parameters:
 isKeyword-trueif the current token is a keyword, otherwisefalse.- See Also:
 isKeyword()
 
 - 
 
 -