core/org.gnit.lucenekmp.util/AttributeSource

AttributeSource

An AttributeSource contains a list of different AttributeImpls, and methods to add and get them. There can only be a single instance of an attribute in the same AttributeSource instance. This is ensured by passing in the actual type of the Attribute (Class) to the .addAttribute, which then checks if an instance of that type is already present. If yes, it returns the instance, otherwise it creates a new instance and returns it.

Inheritors

TokenStream

Constructors

AttributeSource

constructor()

An AttributeSource using the default attribute factory .

constructor(input: AttributeSource)

An AttributeSource that uses the same attributes as the supplied one.

constructor(factory: AttributeFactory)

An AttributeSource using the supplied AttributeFactory for creating new [ ] instances.

Types

Companion

object Companion

State

class State : Cloneable<AttributeSource.State>

This class holds the state of an AttributeSource.

Properties

attributeClassesIterator

val attributeClassesIterator: Iterator<Any>

attributeFactory

val attributeFactory: AttributeFactory

attributeImplsIterator

val attributeImplsIterator: Iterator<AttributeImpl>

Functions

addAttribute

fun <T : Attribute> addAttribute(attClass: KClass<T>): T

The caller must pass in a Class value. This method first checks if an instance of that class is already in this AttributeSource and returns it. Otherwise a new instance is created, added to this AttributeSource and returned.

addAttributeImpl

fun addAttributeImpl(att: AttributeImpl)

Expert: Adds a custom AttributeImpl instance with one or more Attribute interfaces.

captureState

fun captureState(): AttributeSource.State?

Captures the state of all Attributes. The return value can be passed to .restoreState to restore the state of this or another AttributeSource.

clearAttributes

fun clearAttributes()

Resets all Attributes in this AttributeSource by calling AttributeImpl.clear on each Attribute implementation.

cloneAttributes

fun cloneAttributes(): AttributeSource

Performs a clone of all AttributeImpl instances returned in a new AttributeSource instance. This method can be used to e.g. create another TokenStream with exactly the same attributes (using .AttributeSource). You can also use it as a (non-performant) replacement for .captureState, if you need to look into / modify the captured state.

copyTo

fun copyTo(target: AttributeSource)

Copies the contents of this AttributeSource to the given target AttributeSource. The given instance has to provide all Attributes this instance contains. The actual attribute implementations must be identical in both AttributeSource instances; ideally both AttributeSource instances should use the same [ ]. You can use this method as a replacement for .restoreState, if you use .cloneAttributes instead of .captureState.

endAttributes

fun endAttributes()

Resets all Attributes in this AttributeSource by calling AttributeImpl.end on each Attribute implementation.

equals

open operator override fun equals(obj: Any?): Boolean

getAttribute

fun <T : Attribute> getAttribute(attClass: KClass<T>): T?

Returns the instance of the passed in Attribute contained in this AttributeSource

hasAttribute

fun hasAttribute(attClass: KClass<out Attribute>): Boolean

The caller must pass in a Class value. Returns true, iff this AttributeSource contains the passed-in Attribute.

hasAttributes

fun hasAttributes(): Boolean

Returns true, iff this AttributeSource has any attributes

hashCode

open override fun hashCode(): Int

reflectAsString

fun reflectAsString(prependAttClass: Boolean): String

This method returns the current attribute values as a string in the following format by calling the .reflectWith method:

reflectWith

fun reflectWith(reflector: AttributeReflector)

This method is for introspection of attributes, it should simply add the key/values this AttributeSource holds to the given AttributeReflector.

removeAllAttributes

fun removeAllAttributes()

Removes all attributes and their implementations from this AttributeSource.

restoreState

fun restoreState(state: AttributeSource.State?)

Restores this state by copying the values of all attribute implementations that this state contains into the attributes implementations of the targetStream. The targetStream must contain a corresponding instance for each argument contained in this state (e.g. it is not possible to restore the state of an AttributeSource containing a TermAttribute into a AttributeSource using a Token instance as implementation).

toString

open override fun toString(): String

Returns a string consisting of the class's simple name, the hex representation of the identity hash code, and the current reflection of all attributes.