Class PayloadAttribute

Default implementation of IPayloadAttribute.

Inheritance
object
Attribute
PayloadAttribute
Inherited Members
Namespace: Lucene.Net.Analysis.TokenAttributes
Assembly: Lucene.Net.dll
Syntax
public class PayloadAttribute : Attribute, IPayloadAttribute, IAttribute

Constructors

PayloadAttribute()

Initialize this attribute with no payload.

Declaration
public PayloadAttribute()

PayloadAttribute(BytesRef)

Initialize this attribute with the given payload.

Declaration
public PayloadAttribute(BytesRef payload)
Parameters
Type Name Description
BytesRef payload

Properties

Payload

Gets or Sets this Token's payload.

Declaration
public virtual BytesRef Payload { get; set; }
Property Value
Type Description
BytesRef

Methods

Clear()

Clears the values in this Attribute and resets it to its default value. If this implementation implements more than one Attribute interface it clears all.

Declaration
public override void Clear()
Overrides

Clone()

Shallow clone. Subclasses must override this if they need to clone any members deeply,

Declaration
public override object Clone()
Returns
Type Description
object
Overrides

CopyTo(IAttribute)

Copies the values from this Attribute into the passed-in target attribute. The target implementation must support all the IAttributes this implementation supports.

Declaration
public override void CopyTo(IAttribute target)
Parameters
Type Name Description
IAttribute target
Overrides

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration
public override bool Equals(object other)
Parameters
Type Name Description
object other
Returns
Type Description
bool

true if the specified object is equal to the current object; otherwise, false.
Overrides

GetHashCode()

Serves as the default hash function.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code for the current object.
Overrides

Implements