Class FlagsAttributeImpl
- java.lang.Object
-
- org.apache.lucene.util.AttributeImpl
-
- org.apache.lucene.analysis.tokenattributes.FlagsAttributeImpl
-
- All Implemented Interfaces:
Serializable
,Cloneable
,FlagsAttribute
,Attribute
public class FlagsAttributeImpl extends AttributeImpl implements FlagsAttribute, Cloneable, Serializable
This attribute can be used to pass different flags down the tokenizer chain, eg from one TokenFilter to another one.- See Also:
- Serialized Form
- WARNING: This API is experimental and might change in incompatible ways in the next release.
- While we think this is here to stay, we may want to change it to be a long.
-
-
Field Summary
-
Fields inherited from class org.apache.lucene.util.AttributeImpl
enableBackwards
-
-
Constructor Summary
Constructors Constructor Description FlagsAttributeImpl()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
Clears the values in this AttributeImpl and resets it to its default value.void
copyTo(AttributeImpl target)
Copies the values from this Attribute into the passed-in target attribute.boolean
equals(Object other)
int
getFlags()
Get the bitset for any bits that have been set.int
hashCode()
void
setFlags(int flags)
-
Methods inherited from class org.apache.lucene.util.AttributeImpl
clone, reflectAsString, reflectWith, toString
-
-
-
-
Method Detail
-
getFlags
public int getFlags()
Get the bitset for any bits that have been set. This is completely distinct fromTypeAttribute.type()
, although they do share similar purposes. The flags can be used to encode information about the token for use by otherTokenFilter
s.- Specified by:
getFlags
in interfaceFlagsAttribute
- Returns:
- The bits
-
setFlags
public void setFlags(int flags)
- Specified by:
setFlags
in interfaceFlagsAttribute
- See Also:
getFlags()
-
clear
public void clear()
Description copied from class:AttributeImpl
Clears the values in this AttributeImpl and resets it to its default value. If this implementation implements more than one Attribute interface it clears all.- Specified by:
clear
in classAttributeImpl
-
copyTo
public void copyTo(AttributeImpl target)
Description copied from class:AttributeImpl
Copies the values from this Attribute into the passed-in target attribute. The target implementation must support all the Attributes this implementation supports.- Specified by:
copyTo
in classAttributeImpl
-
-