Class IString

java.lang.Object

gnu.lists.AbstractSequence<Char>

gnu.lists.IString

All Implemented Interfaces:

BoundedHashable, Array<Char>, AVector<Char>, Consumable, Sequence<Char>, Externalizable, Serializable, CharSequence, Comparable<IString>, Iterable<Char>, Collection<Char>, List<Char>, RandomAccess, SequencedCollection<Char>

Direct Known Subclasses:

IString.SubString

public class IString
extends AbstractSequence<Char>
implements CharSequence, Externalizable, Comparable<IString>, AVector<Char>, RandomAccess, Consumable

A string implementation with contant-time codepoint indexing. Suitable for SRFI-135 or SRFI-140.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	IString.SubString

Field Summary

Fields inherited from class AbstractSequence

noInts

Fields inherited from interface 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

Constructor Summary

Constructors

Constructor	Description
IString(String str)

Method Summary

Modifier and Type	Method	Description
char	charAt(int i)	To implement CharSequence
int	compareTo(IString other)
void	consume(Consumer out)
int	effectiveIndex(int index)
boolean	equals(Object other)
byte[]	getBytes(String charsetName)
Char	getRaw(int index)	Given an "effective index", return element as object.
int	hashCode()
int	indexByCodePoints(int index)	used for string-ref
int	length()
int	lengthByCodePoints()
int	offsetByCodePoints(int i)	Map character offset to char offset.
void	readExternal(ObjectInput in)
int	size()	See java.util.List.
IString	subSequence(int from, int to)	Substring using offsets in code-units (16-bit chars).
char[]	toCharArray()
String	toString()
static IString	valueOf(CharSequence str)
static IString	valueOf(CharSequence str, int start, int count)
void	writeExternal(ObjectOutput out)

Methods inherited from class AbstractSequence

add, add, addAll, addAll, addPos, asImmutable, badRank, boundedHash, checkCanWrite, checkRank, clear, compare, compare, compare, consume, consumeNext, consumePosRange, contains, containsAll, copyPos, createPos, createRelativePos, effectiveIndex, effectiveIndex, effectiveIndex, effectiveIndex, elements, endPos, equals, fill, fill, fillPosRange, firstAttributePos, firstChildPos, firstChildPos, fromEndIndex, get, get, get, get, get, getAttribute, getAttributeLength, getBooleanRaw, getByteRaw, getCharRaw, getContainingSequenceSize, getDoubleRaw, getElementKind, getFloatRaw, getIndexDifference, getInt, getInt, getInt, getInt, getInt, getIntRaw, getIterator, getIterator, getIteratorAtPos, getLongRaw, getLowBound, getNextKind, getNextTypeName, getNextTypeObject, getPosNext, getPosPrevious, getRowMajor, getShortRaw, getSize, getSize, gotoAttributesStart, gotoChildrenStart, gotoParent, hasNext, hasPrevious, indexOf, isAfterPos, isEmpty, iterator, lastIndexOf, listIterator, listIterator, nextIndex, nextIndex, nextMatching, nextPos, parentPos, previousPos, rank, releasePos, remove, remove, removeAll, removePos, removePosRange, retainAll, set, set, setAt, setBuffer, setPosNext, setPosPrevious, setRaw, stableCompare, startPos, subList, subSequence, subSequencePos, toArray, toArray, toString, unsupported, unsupportedException

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Array

asImmutable, effectiveIndex, effectiveIndex, effectiveIndex, effectiveIndex, get, get, get, get, get, getBooleanRaw, getByteRaw, getCharRaw, getDoubleRaw, getElementKind, getFloatRaw, getInt, getInt, getInt, getInt, getInt, getIntRaw, getLongRaw, getLowBound, getRowMajor, getShortRaw, getSize, getSize, isEmpty, rank, set, setRaw

Methods inherited from interface BoundedHashable

boundedHash

Methods inherited from interface CharSequence

chars, codePoints, getChars, isEmpty

Methods inherited from interface Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface Iterable

forEach

Methods inherited from interface List

add, add, addAll, addAll, addFirst, addLast, clear, contains, containsAll, getFirst, getLast, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeFirst, removeLast, replaceAll, retainAll, reversed, sort, spliterator, subList, toArray, toArray

Methods inherited from interface Sequence

elements, fill, get, getInt, isEmpty, set

Constructor Details

IString

public IString(String str)

Method Details

valueOf

public static IString valueOf(CharSequence str)

valueOf

public static IString valueOf(CharSequence str,
 int start,
 int count)

effectiveIndex

public int effectiveIndex(int index)

Specified by:

effectiveIndex in interface Array<Char>

Overrides:

effectiveIndex in class AbstractSequence<Char>

getRaw

public Char getRaw(int index)

Description copied from interface: Array

Given an "effective index", return element as object.

Specified by:

getRaw in interface Array<Char>

Overrides:

getRaw in class AbstractSequence<Char>

indexByCodePoints

public int indexByCodePoints(int index)

used for string-ref

offsetByCodePoints

public int offsetByCodePoints(int i)

Map character offset to char offset. Caller is responsible for checking that i >=0 && i <= cplength.

lengthByCodePoints

public int lengthByCodePoints()

size

public int size()

Description copied from interface: Sequence

See java.util.List.

Specified by:

size in interface Collection<Char>

Specified by:

size in interface List<Char>

Specified by:

size in interface Sequence<Char>

Overrides:

size in class AbstractSequence<Char>

charAt

public char charAt(int i)

To implement CharSequence

Specified by:

charAt in interface CharSequence

toString

public String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class AbstractSequence<Char>

length

public int length()

Specified by:

length in interface CharSequence

subSequence

public IString subSequence(int from,
 int to)

Substring using offsets in code-units (16-bit chars).

Specified by:

subSequence in interface CharSequence

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

toCharArray

public char[] toCharArray()

getBytes

public byte[] getBytes(String charsetName)
                throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

consume

public void consume(Consumer out)

Specified by:

consume in interface Consumable

Overrides:

consume in class AbstractSequence<Char>

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<Char>

Specified by:

hashCode in interface List<Char>

Overrides:

hashCode in class AbstractSequence<Char>

equals

public boolean equals(Object other)

Specified by:

equals in interface Collection<Char>

Specified by:

equals in interface List<Char>

Overrides:

equals in class AbstractSequence<Char>

compareTo

public int compareTo(IString other)

Specified by:

compareTo in interface Comparable<IString>