org.millscript.commons.util.list
Class IStringList

java.lang.Object
  org.millscript.commons.util.list.AbstractIList<java.lang.Character>
      org.millscript.commons.util.list.IStringList

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IList<java.lang.Character>, IMap<java.lang.Integer,java.lang.Character>

public class IStringList
extends AbstractIList<java.lang.Character>
implements java.lang.Cloneable, java.io.Serializable

This class provides an immutable List implementation which is backed by a String(i.e. a list of characters).

See Also:

Serialized Form

Nested Class Summary

static class

IStringList.StringListIterator This class provides a map interator implementation which iterates over the characters in a string and their position in the string.

Nested classes/interfaces inherited from class org.millscript.commons.util.list.AbstractIList

AbstractIList.ListMapletIterator<V>, AbstractIList.ListMapletList<V>

Constructor Summary

IStringList()
Constructs a new empty immutable string list.

IStringList(java.lang.String string)
Constructs a new immutable string list with the specified backing string.

IStringList(java.lang.String string, int start, int end)
Constructs a new immutable string list with a copy of the specified backing string, starting and ending at the specified indices.

Method Summary

java.lang.Object	clone()
protected java.lang.Character	doGet(int pos) Returns the value at the specified position(one based) in the list.
protected IList<java.lang.Character>	doSlice(int first, int last, boolean share) Returns a list containing a slice of the elements in this list, starting at first(one based, inclusive) and continuing last(one based, inclusive).
int	indexOf(java.lang.Character value) Returns the index(one based) of the first occurance of the specified object in this list.
ListIterator<java.lang.Character>	iterator(boolean share) Returns an iterator over the values in this list and their respective position.
int	size() Returns the number of mappings defined in this map.

Methods inherited from class org.millscript.commons.util.list.AbstractIList

allButFirst, allButLast, allFirst, allLast, contains, contains, contains, contains0, contains0, contains0, containsAll, containsKey, containsKey, containsKey0, containsKey0, containsSlice, containsSlice0, containsValue, decorate, equals, first, get, get, get0, get0, getDefault, hashCode, indexOf0, isEmtpy, keyList, last, mapletList, setDefault, setDefault, sharedMapletList, sharedValueList, slice, slice0, toArray, toArray, toString, valueList

Methods inherited from class java.lang.Object

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

Constructor Detail

IStringList

public IStringList()

Constructs a new empty immutable string list.

IStringList

public IStringList(java.lang.String string)

Constructs a new immutable string list with the specified backing string.

Parameters:

objects - the backing string

IStringList

public IStringList(java.lang.String string,
                   int start,
                   int end)

Constructs a new immutable string list with a copy of the specified backing string, starting and ending at the specified indices.

Parameters:

objects - the backing string to copy

start - the index of the first element in the slice

end - the index of the last element in the slice. If end < start, the new list will be empty

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

See Also:

Object.clone()

doGet

protected java.lang.Character doGet(int pos)

Description copied from class: AbstractIList

Returns the value at the specified position(one based) in the list. This method is called by the generic AbstractIList.get(int) method after the index has been validated. Hence this method should generally not need to perform any further validation.

Specified by:

doGet in class AbstractIList<java.lang.Character>

Parameters:

pos - the index(one based) of the value to return

Returns:

the value at the specified position(one based)

See Also:

AbstractIList.doGet(int)

doSlice

protected IList<java.lang.Character> doSlice(int first,
                                             int last,
                                             boolean share)

Description copied from class: AbstractIList

Returns a list containing a slice of the elements in this list, starting at first(one based, inclusive) and continuing last(one based, inclusive). This method is called by the generic #slice(int, int) method after the indices have been validated. Hence, this method assumes that the specified indices are within the bounds of the list and that the first index is less than or equal to the last index. The case where the first index is greater than the last is handled elsewhere.

Specified by:

doSlice in class AbstractIList<java.lang.Character>

Parameters:

first - the index(one based) of the first element in the slice

last - the index(one based) of the last element in the slice

share - if true the specified object array will be shared otherwise the array will be copied.

Returns:

a list containing the specified slice of this list

See Also:

AbstractIList.doSlice(int, int, boolean)

indexOf

public int indexOf(java.lang.Character value)

Description copied from interface: IList

Returns the index(one based) of the first occurance of the specified object in this list.

Specified by:

indexOf in interface IList<java.lang.Character>

Parameters:

value - the value to find

Returns:

the index(one based) of the first occurance of the specified object in this list or 0 if no such element exists

See Also:

IList.indexOf(java.lang.Object)

iterator

public ListIterator<java.lang.Character> iterator(boolean share)

Description copied from interface: IList

Returns an iterator over the values in this list and their respective position. The order of iteration is implementation dependant and should follow any ordering the list implementation provides.

Specified by:

iterator in interface IList<java.lang.Character>

Specified by:

iterator in interface IMap<java.lang.Integer,java.lang.Character>

Parameters:

share - if true this instances backing store should be shared with the returned list, otherwise any backing store will be copied.

Returns:

an iterator over this maps mappings

See Also:

IMap.iterator(boolean)

size

public int size()

Description copied from interface: IMap

Returns the number of mappings defined in this map.

Specified by:

size in interface IMap<java.lang.Integer,java.lang.Character>

Returns:

the number of mappings in this map

See Also:

IMap.size()