core/org.gnit.lucenekmp.analysis.tokenattributes/CharTermAttributeImpl

CharTermAttributeImpl

open class CharTermAttributeImpl : AttributeImpl, CharTermAttribute, TermToBytesRefAttribute

Default implementation of CharTermAttribute.

Inheritors

PackedTokenAttributeImpl

Constructors

CharTermAttributeImpl

constructor()

Types

Companion

object Companion

Properties

bytesRef

open override val bytesRef: BytesRef

Retrieve this attribute's BytesRef. The bytes are updated from the current term. The implementation may return a new instance or keep the previous one.

length

open override val length: Int

Functions

append

open override fun append(c: Char): CharTermAttribute

open override fun append(csq: CharSequence?): CharTermAttribute

open override fun append(csq: CharSequence?, start: Int, end: Int): CharTermAttribute

open override fun append(s: String): CharTermAttribute

Appends the specified String to this character sequence.

open override fun append(s: StringBuilder): CharTermAttribute

Appends the specified StringBuilder to this character sequence.

open override fun append(ta: CharTermAttribute): CharTermAttribute

Appends the contents of the other CharTermAttribute to this character sequence.

buffer

open override fun buffer(): CharArray

Returns the internal termBuffer character array which you can then directly alter. If the array is too small for your token, use .resizeBuffer to increase it. After altering the buffer be sure to call .setLength to record the number of valid characters that were placed into the termBuffer.

clear

open override fun clear()

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.

clone

open override fun clone(): CharTermAttributeImpl

In most cases the clone is, and should be, deep in order to be able to properly capture the state of all attributes.

codePointAt

fun CharSequence.codePointAt(index: Int): Int

Returns the Unicode code point at the specified index of this CharSequence.

codePointSequence

fun CharSequence.codePointSequence(): Sequence<Int>

Returns a stream of code point values from this sequence. Any surrogate pairs encountered in the sequence are combined as if by {@linkplain Character#toCodePoint Character.toCodePoint} and the result is passed to the stream. Any other code units, including ordinary BMP characters, unpaired surrogates, and undefined code units, are zero-extended to {@code int} values which are then passed to the stream.

copyBuffer

open override fun copyBuffer(buffer: CharArray, offset: Int, length: Int)

Copies the contents of buffer, starting at offset for length characters, into the termBuffer array.

copyTo

open override fun copyTo(target: AttributeImpl)

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

end

open fun end()

Clears the values in this AttributeImpl and resets it to its value at the end of the field. If this implementation implements more than one Attribute interface it clears all.

equals

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

get

open operator override fun get(index: Int): Char

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

open override fun reflectWith(reflector: AttributeReflector)

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

resizeBuffer

open override fun resizeBuffer(newSize: Int): CharArray

Grows the termBuffer to at least size newSize, preserving the existing content.

setEmpty

open override fun setEmpty(): CharTermAttribute?

Sets the length of the termBuffer to zero. Use this method before appending contents using the Appendable interface.

setLength

open override fun setLength(length: Int): CharTermAttribute

Set number of valid characters (length of the term) in the termBuffer array. Use this to truncate the termBuffer or to synchronize with external manipulation of the termBuffer. Note: to grow the size of the array, use .resizeBuffer first.

subSequence

open override fun subSequence(start: Int, end: Int): CharSequence

toString

open override fun toString(): String

Returns solely the term text as specified by the CharSequence interface.