gnu.lists

Class FString

java.lang.Object

gnu.lists.AbstractSequence<E>

gnu.lists.SimpleVector<E>

gnu.lists.AbstractCharVector<Char>

gnu.lists.FString

All Implemented Interfaces:

BoundedHashable, Array<Char>, AVector<Char>, CharSeq, Consumable, Sequence<Char>, java.io.Externalizable, java.io.Serializable, java.lang.Appendable, java.lang.CharSequence, java.lang.Comparable, java.lang.Iterable<Char>, java.util.Collection<Char>, java.util.List<Char>, java.util.RandomAccess

Direct Known Subclasses:

CharBuffer, SwtCharBuffer

public class FString
extends AbstractCharVector<Char>
implements java.lang.Appendable, CharSeq, Consumable

Simple adjustable-length vector whose elements are 32-bit code points Used for the Scheme string type. This isn't a regular SimpleVector because character indexing isn't a simple lookup. "Sub-range mode" is not used (at least not for Kawa Scheme): if you need an immutable sub-string, use an IString (or java.lang.String).

See Also:

Serialized Form

Field Summary

Fields inherited from class gnu.lists.AbstractCharVector

data, empty

Fields inherited from class gnu.lists.SimpleVector

COPY_ON_WRITE, GAP_FLAG, info, MAX_GAP_SIZE, READ_ONLY_FLAG, SHARED_FLAG, SUBRANGE_FLAG, VERY_SIMPLE_FLAG

Fields inherited from class gnu.lists.AbstractSequence

noInts

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

Constructor Summary

Constructors

Constructor and Description
FString()
FString(char[] values) Create an FString from a char[].
FString(char[] buffer, int offset, int length) This constructor makes a copy.
FString(java.lang.CharSequence seq)
FString(java.lang.CharSequence seq, int offset, int length) Copy a substring of a CharSequence.
FString(int num)
FString(int num, int value)

Method Summary

Modifier and Type	Method and Description
boolean	addAll(java.lang.CharSequence s)
void	addAllStrings(java.lang.Object[] args, int startIndex) Append arguments to this FString.
static FString	alloc(int sz) Create a empty string, but with a given initial buffer size.
FString	append(char c)
FString	append(java.lang.CharSequence csq)
FString	append(java.lang.CharSequence csq, int start, int end)
FString	append(java.lang.Object obj)
FString	appendCharacter(int c) Append a Unicode code point.
int	characterAt(int index)
void	consumePosRange(int iposStart, int iposEnd, Consumer out)
FString	copy(int start, int end)
int	createPos(int index, boolean isAfter) Generate a position at a given index.
int	createRelativePos(int pos, int delta, boolean isAfter)
int	effectiveIndex(int index)
boolean	equals(java.lang.Object obj) Must override, since we override hashCode.
Char	get(int index) See java.util.List.
int	getElementKind()
Char	getRaw(int index) Given an "effective index", return element as object.
java.lang.String	getTag() This is convenience hack for printing "uniform vectors" (srfi 4).
int	indexOf(int ch, int fromChar)
void	insert(int where, int ch, boolean beforeMarkers)
void	insert(int where, java.lang.String str, boolean beforeMarkers)
void	insertRepeated(int where, int value, int count)
int	lastIndexOf(int ch, int fromChar)
protected FString	newInstance(int newLength)
protected int	nextIndex(int ipos) Get the offset from the beginning corresponding to a position cookie.
FString	prepend(java.lang.CharSequence str, int start, int end)
FString	prepend(java.lang.Object obj)
FString	prependCharacter(int c)
void	replace(java.lang.CharSequence src, int srcStart, int srcEnd, int dstStart, int dstEnd) Replace a substring of this string with another.
void	replace(int where, char[] chars, int start, int count)
void	replace(int where, java.lang.String string)
Char	set(int index, Char value) See java.util.List.
void	setCharacterAt(int index, int ch)
void	setCharAt(int index, char ch)
void	setCharAtBuffer(int index, char ch)
void	setRaw(int index, Char value) Given an "effective index", set selected element.
void	shift(int srcStart, int dstStart, int count)
int	size() See java.util.List.
CharSeq	subSequence(int start, int end)
java.lang.String	substring(int start, int end)
char[]	toCharArray() Return a char[] contain the characters of this string.
java.lang.String	toString()
void	writeTo(java.lang.Appendable dest)
void	writeTo(int start, int count, java.lang.Appendable dest) Append a specified subsequence to an Appendable.

Methods inherited from class gnu.lists.AbstractCharVector

charAt, clearBuffer, compareTo, compareTo, compareTo, copyBuffer, ensureBufferLength, equals, getBuffer, getBufferLength, getCharRaw, getChars, hashCode, length, openReader, openReader, setBuffer

Methods inherited from class gnu.lists.SimpleVector

add, add, addPos, addSpace, asImmutable, checkCanWrite, delete, doCopyOnWrite, fill, forEach, gapReserve, gapReserveGeneric, getGapEnd, getGapSize, getGapStart, getOffsetBits, getRowMajor, getSegment, getSegment, getSegmentReadOnly, getSizeBits, isAfterPos, isGapBuffer, isReadOnly, isSubRange, isVerySimple, readExternal, setGapBounds, setGapBounds, setInfoField, setReadOnly, toDataArray, writeExternal

Methods inherited from class gnu.lists.AbstractSequence

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface gnu.lists.CharSeq

charAt, getChars, length

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Methods inherited from interface gnu.lists.Sequence

elements, fill, getInt, isEmpty

Methods inherited from interface java.util.List

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface gnu.lists.Consumable

consume

Methods inherited from interface gnu.kawa.util.BoundedHashable

boundedHash

Methods inherited from interface gnu.lists.Array

effectiveIndex, effectiveIndex, effectiveIndex, effectiveIndex, get, get, get, get, getBooleanRaw, getByteRaw, getDoubleRaw, getFloatRaw, getInt, getInt, getInt, getInt, getInt, getIntRaw, getLongRaw, getLowBound, getShortRaw, getSize, getSize, isEmpty, rank, set

Constructor Detail

FString

public FString()

FString

public FString(int num)

FString

public FString(int num,
               int value)

FString

public FString(char[] values)

Create an FString from a char[]. Note that this contructor does *not* copy the argument.

FString

public FString(char[] buffer,
               int offset,
               int length)

This constructor makes a copy.

FString

public FString(java.lang.CharSequence seq)

FString

public FString(java.lang.CharSequence seq,
               int offset,
               int length)

Copy a substring of a CharSequence.

Parameters:

offset - - start offset in 16-bit char units

length - - length in 16-bit char units

Method Detail

size

public int size()

Description copied from interface: Sequence

See java.util.List.

Specified by:

size in interface Sequence<Char>

Specified by:

size in interface java.util.Collection<Char>

Specified by:

size in interface java.util.List<Char>

Overrides:

size in class SimpleVector<Char>

effectiveIndex

public int effectiveIndex(int index)

Specified by:

effectiveIndex in interface Array<Char>

Overrides:

effectiveIndex in class SimpleVector<Char>

Parameters:

index - measured in Unicode code points (characters)

createPos

public int createPos(int index,
                     boolean isAfter)

Description copied from class: AbstractSequence

Generate a position at a given index. The result is a position cookie that must be free'd with releasePos.

Overrides:

createPos in class AbstractSequence<Char>

Parameters:

index - offset from beginning of desired position

isAfter - should the position have the isAfter property

nextIndex

protected int nextIndex(int ipos)

Description copied from class: AbstractSequence

Get the offset from the beginning corresponding to a position cookie.

Overrides:

nextIndex in class AbstractSequence<Char>

createRelativePos

public int createRelativePos(int pos,
                             int delta,
                             boolean isAfter)

Overrides:

createRelativePos in class AbstractSequence<Char>

alloc

public static FString alloc(int sz)

Create a empty string, but with a given initial buffer size.

getRaw

public final 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>

get

public final Char get(int index)

Description copied from interface: Sequence

See java.util.List.

Specified by:

get in interface Array<Char>

Specified by:

get in interface Sequence<Char>

Specified by:

get in interface java.util.List<Char>

Overrides:

get in class AbstractSequence<Char>

Parameters:

index - offset in character units (Unicode code points)

indexOf

public int indexOf(int ch,
                   int fromChar)

Parameters:

fromChar - offset in 16-bit code units

lastIndexOf

public int lastIndexOf(int ch,
                       int fromChar)

Parameters:

fromChar - offset in 16-bit code units

set

public Char set(int index,
                Char value)

Description copied from interface: Sequence

See java.util.List.

Specified by:

set in interface Sequence<Char>

Specified by:

set in interface java.util.List<Char>

Overrides:

set in class AbstractSequence<Char>

Parameters:

index - offset in character units (Unicode code points)

setRaw

public final void setRaw(int index,
                         Char value)

Description copied from class: AbstractSequence

Given an "effective index", set selected element.

Specified by:

setRaw in interface Array<Char>

Overrides:

setRaw in class AbstractSequence<Char>

Parameters:

index - offset in character units (Unicode code points)

characterAt

public final int characterAt(int index)

Parameters:

index - offset in 16-bit code units

toCharArray

public char[] toCharArray()

Return a char[] contain the characters of this string. It is unspecified if the result is a copy or shares with this FString.

shift

public void shift(int srcStart,
                  int dstStart,
                  int count)

Overrides:

shift in class SimpleVector<Char>

copy

public FString copy(int start,
                    int end)

addAll

public boolean addAll(java.lang.CharSequence s)

insert

public void insert(int where,
                   int ch,
                   boolean beforeMarkers)

insert

public void insert(int where,
                   java.lang.String str,
                   boolean beforeMarkers)

addAllStrings

public void addAllStrings(java.lang.Object[] args,
                          int startIndex)

Append arguments to this FString. Used to implement Scheme's string-append.

Parameters:

args - an array of FString value

startIndex - index of first string in args to use

toString

public java.lang.String toString()

Specified by:

toString in interface CharSeq

Specified by:

toString in interface java.lang.CharSequence

Overrides:

toString in class AbstractSequence<Char>

substring

public java.lang.String substring(int start,
                                  int end)

subSequence

public CharSeq subSequence(int start,
                           int end)

Specified by:

subSequence in interface java.lang.CharSequence

setCharAt

public void setCharAt(int index,
                      char ch)

Specified by:

setCharAt in interface CharSeq

setCharacterAt

public void setCharacterAt(int index,
                           int ch)

Specified by:

setCharacterAt in interface CharSeq

replace

public void replace(java.lang.CharSequence src,
                    int srcStart,
                    int srcEnd,
                    int dstStart,
                    int dstEnd)

Replace a substring of this string with another. The two strings may have different lengths, so this generalizes insertion and deletion. All indexes are code-unit (16-bit char) offsets.

setCharAtBuffer

public void setCharAtBuffer(int index,
                            char ch)

insertRepeated

public void insertRepeated(int where,
                           int value,
                           int count)

replace

public void replace(int where,
                    char[] chars,
                    int start,
                    int count)

replace

public void replace(int where,
                    java.lang.String string)

equals

public boolean equals(java.lang.Object obj)

Description copied from class: AbstractCharVector

Must override, since we override hashCode.

Specified by:

equals in interface java.util.Collection<Char>

Specified by:

equals in interface java.util.List<Char>

Specified by:

equals in class AbstractCharVector<Char>

newInstance

protected FString newInstance(int newLength)

Specified by:

newInstance in class SimpleVector<Char>

getElementKind

public int getElementKind()

Specified by:

getElementKind in interface Array<Char>

Overrides:

getElementKind in class AbstractSequence<Char>

getTag

public java.lang.String getTag()

Description copied from class: SimpleVector

This is convenience hack for printing "uniform vectors" (srfi 4). It may go away without notice!

Overrides:

getTag in class SimpleVector<Char>

consumePosRange

public void consumePosRange(int iposStart,
                            int iposEnd,
                            Consumer out)

Overrides:

consumePosRange in class AbstractSequence<Char>

append

public FString append(char c)

Specified by:

append in interface java.lang.Appendable

appendCharacter

public FString appendCharacter(int c)

Append a Unicode code point.

append

public FString append(java.lang.CharSequence csq)

Specified by:

append in interface java.lang.Appendable

append

public FString append(java.lang.CharSequence csq,
                      int start,
                      int end)

Specified by:

append in interface java.lang.Appendable

append

public FString append(java.lang.Object obj)

prependCharacter

public FString prependCharacter(int c)

prepend

public FString prepend(java.lang.CharSequence str,
                       int start,
                       int end)

prepend

public FString prepend(java.lang.Object obj)

writeTo

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

Description copied from interface: CharSeq

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.

Specified by:

writeTo in interface CharSeq

Throws:

java.io.IOException

writeTo

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

Specified by:

writeTo in interface CharSeq

Throws:

java.io.IOException