Package gnu.lists

Interface CharSeq

All Superinterfaces:

BoundedHashable, java.lang.CharSequence, java.util.Collection<Char>, Consumable, java.lang.Iterable<Char>, java.util.List<Char>, Sequence<Char>

All Known Implementing Classes:

CharBuffer, FString

public interface CharSeq
extends java.lang.CharSequence, Sequence<Char>, Consumable

A sequence where each element is a character (Unicode code point).

Field Summary

Fields inherited from interface gnu.lists.Sequence

ATTRIBUTE_VALUE, BOOLEAN_VALUE, CDATA_VALUE, CHAR_VALUE, COMMENT_VALUE, DOCUMENT_VALUE, DOUBLE_VALUE, ELEMENT_VALUE, EOF_VALUE, eofValue, FLOAT_VALUE, INT_S16_VALUE, INT_S32_VALUE, INT_S64_VALUE, INT_S8_VALUE, INT_U16_VALUE, INT_U32_VALUE, INT_U64_VALUE, INT_U8_VALUE, OBJECT_VALUE, PRIM_VALUE, PROCESSING_INSTRUCTION_VALUE, TEXT_BYTE_VALUE

Method Summary

Modifier and Type	Method	Description
char	charAt(int index)	The index is in terms of code units.
void	getChars(int srcBegin, int srcEnd, char[] dst, int dstBegin)	Copy characters into a destination buffer.
boolean	isEmpty()	True is this sequence contains no elements.
int	length()	Get length of string, in code units (not characters).
void	setCharacterAt(int index, int ch)
void	setCharAt(int index, char ch)
java.lang.String	toString()
void	writeTo(int start, int count, java.lang.Appendable dest)	Append a specified subsequence to an Appendable.
void	writeTo(java.lang.Appendable dest)

Methods inherited from interface gnu.kawa.util.BoundedHashable

boundedHash

Methods inherited from interface java.lang.CharSequence

chars, codePoints, subSequence

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface gnu.lists.Consumable

consume

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, sort, spliterator, subList, toArray, toArray

Methods inherited from interface gnu.lists.Sequence

elements, fill, get, getInt, set, size

Method Detail

length

int length()

Get length of string, in code units (not characters). In contract, size() returns the number of 16-bit code points.

Specified by:

length in interface java.lang.CharSequence

charAt

char charAt(int index)

The index is in terms of code units.

Specified by:

charAt in interface java.lang.CharSequence

getChars

void getChars(int srcBegin,
              int srcEnd,
              char[] dst,
              int dstBegin)

Copy characters into a destination buffer. Same interface as java.lang.String's getChars.

Parameters:

srcBegin - source start position, in 16-bit code units.

srcEnd - source end position, in 16-bit code units.

dst - destination

dstBegin - index (in code units) in dst array

setCharAt

void setCharAt(int index,
               char ch)

setCharacterAt

void setCharacterAt(int index,
                    int ch)

writeTo

void writeTo(int start,
             int count,
             java.lang.Appendable dest)
      throws java.io.IOException

Append a specified subsequence to an Appendable. An allowable implementation is: dest.append(this, start, start+count). Hence implementors of Appendable should avoid calling writeTo - though they can call getChars.

Throws:

java.io.IOException

writeTo

void writeTo(java.lang.Appendable dest)
      throws java.io.IOException

Throws:

java.io.IOException

toString

java.lang.String toString()

Specified by:

toString in interface java.lang.CharSequence

Overrides:

toString in class java.lang.Object

isEmpty

boolean isEmpty()

Description copied from interface: Sequence

True is this sequence contains no elements.

Specified by:

isEmpty in interface java.util.Collection<Char>

Specified by:

isEmpty in interface java.util.List<Char>

Specified by:

isEmpty in interface Sequence<Char>