core/org.gnit.lucenekmp.jdkport/CharBuffer

CharBuffer

class CharBuffer : CharSequence, Appendable, Comparable<CharBuffer>

port of java.nio.CharBuffer

A very simple, mutable (or optionally read-only) character buffer.

This class mimics basic behaviors of a CharBuffer:

Relative get() and put() operations that update the current position.
Absolute get/put via helper methods.
Bulk get/put.
Slicing, duplicating, compacting, and creating a read-only view.
Implements CharSequence (the sequence being the “remaining” characters, i.e. from the current position up to the limit) and Appendable.

Types

object Companion

Properties

val capacity: Int

open override val length: Int

var position: Int

Functions

open override fun append(c: Char): Appendable

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

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

fun array(): CharArray

fun arrayOffset(): Int

asReadOnlyBuffer

fun asReadOnlyBuffer(): CharBuffer

Returns a read-only view of this buffer.

fun clear(): CharBuffer

Clears the buffer: position ← 0, limit ← capacity, mark undefined.

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.

fun compact(): CharBuffer

Compacts the buffer by moving the remaining characters to the beginning.

open operator override fun compareTo(other: CharBuffer): Int

Lexicographically compares the remaining characters of this buffer to another buffer's remaining characters.

fun duplicate(): CharBuffer

Duplicates the buffer, sharing the underlying array and preserving the state.

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

fun flip(): CharBuffer

Flips the buffer: limit ← current position, position ← 0, mark undefined.

fun get(): Char

Relative get: reads the char at current position and increments position.

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

fun get(dst: CharArray, dstOffset: Int, length: Int): CharBuffer

Reads length characters into dst starting at dstOffset, advancing the buffer’s position.

fun getAbsolute(index: Int): Char

Absolute get: returns the char at the given index (0 ≤ index < limit) without changing position.

fun hasArray(): Boolean

open override fun hashCode(): Int

fun hasRemaining(): Boolean

Tells whether there are any elements between the current position and the limit.

fun isReadOnly(): Boolean

fun mark(): CharBuffer

Sets the mark at the current position. After this call, calling reset() will return the position to here.

fun position(): Int

fun put(c: Char): CharBuffer

Relative put: writes the char at current position and increments position.

fun put(src: String): CharBuffer

fun put(src: CharBuffer): CharBuffer

fun put(src: String, start: Int, end: Int): CharBuffer

Relative bulk put method (optional operation).

fun put(src: CharArray, srcOffset: Int, length: Int): CharBuffer

Writes length characters from src (starting at srcOffset) into this buffer, advancing the position.

fun putAbsolute(index: Int, c: Char): CharBuffer

Absolute put: writes the char at the given index (0 ≤ index < limit) without changing position.

fun putBuffer(pos: Int, src: CharBuffer, srcPos: Int, n: Int)

fun remaining(): Int

Returns the number of characters between position and limit.

fun reset(): CharBuffer

Resets the position to the last mark. Throws IllegalStateException if no mark has been set.

fun slice(): CharBuffer

Slices the buffer, creating a new buffer that shares the underlying array and represents the remaining characters (from current position to limit).

open override fun subSequence(startIndex: Int, endIndex: Int): CharSequence

open override fun toString(): String