Class PayloadAttributeImpl
java.lang.Object
org.apache.lucene.util.AttributeImpl
org.apache.lucene.analysis.tokenattributes.PayloadAttributeImpl
- All Implemented Interfaces:
Cloneable,PayloadAttribute,Attribute
Default implementation of
PayloadAttribute.-
Constructor Summary
ConstructorsConstructorDescriptionInitialize this attribute with no payload.PayloadAttributeImpl(BytesRef payload) Initialize this attribute with the given payload. -
Method Summary
Modifier and TypeMethodDescriptionvoidclear()Clears the values in this AttributeImpl and resets it to its default value.clone()In most cases the clone is, and should be, deep in order to be able to properly capture the state of all attributes.voidcopyTo(AttributeImpl target) Copies the values from this Attribute into the passed-in target attribute.booleanReturns this Token's payload.inthashCode()voidreflectWith(AttributeReflector reflector) This method is for introspection of attributes, it should simply add the key/values this attribute holds to the givenAttributeReflector.voidsetPayload(BytesRef payload) Sets this Token's payload.Methods inherited from class org.apache.lucene.util.AttributeImpl
end, reflectAsString
-
Constructor Details
-
PayloadAttributeImpl
public PayloadAttributeImpl()Initialize this attribute with no payload. -
PayloadAttributeImpl
Initialize this attribute with the given payload.
-
-
Method Details
-
getPayload
Description copied from interface:PayloadAttributeReturns this Token's payload.- Specified by:
getPayloadin interfacePayloadAttribute- See Also:
-
setPayload
Description copied from interface:PayloadAttributeSets this Token's payload.- Specified by:
setPayloadin interfacePayloadAttribute- See Also:
-
clear
public void clear()Description copied from class:AttributeImplClears 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:
clearin classAttributeImpl
-
clone
Description copied from class:AttributeImplIn most cases the clone is, and should be, deep in order to be able to properly capture the state of all attributes.- Overrides:
clonein classAttributeImpl
-
equals
-
hashCode
public int hashCode() -
copyTo
Description copied from class:AttributeImplCopies the values from this Attribute into the passed-in target attribute. The target implementation must support all the Attributes this implementation supports.- Specified by:
copyToin classAttributeImpl
-
reflectWith
Description copied from class:AttributeImplThis method is for introspection of attributes, it should simply add the key/values this attribute holds to the givenAttributeReflector.Implementations look like this (e.g. for a combined attribute implementation):
public void reflectWith(AttributeReflector reflector) { reflector.reflect(CharTermAttribute.class, "term", term()); reflector.reflect(PositionIncrementAttribute.class, "positionIncrement", getPositionIncrement()); }If you implement this method, make sure that for each invocation, the same set of
Attributeinterfaces and keys are passed toAttributeReflector.reflect(java.lang.Class<? extends org.apache.lucene.util.Attribute>, java.lang.String, java.lang.Object)in the same order, but possibly different values. So don't automatically exclude e.g.nullproperties!- Specified by:
reflectWithin classAttributeImpl- See Also:
-