Package org.magicwerk.brownies.collections.primitive

Class ICharList.IReadOnlyCharList

java.lang.Object

org.magicwerk.brownies.collections.primitive.ICharList

org.magicwerk.brownies.collections.primitive.ICharList.IReadOnlyCharList

All Implemented Interfaces:

java.io.Serializable, java.lang.CharSequence, java.lang.Cloneable

Direct Known Subclasses:

ICharList.IReadOnlyCharListFromArray, ICharList.IReadOnlyCharListFromCollection, ICharList.IReadOnlyCharListFromList, ICharList.IReadOnlyCharListFromMult

Enclosing class:

ICharList

protected abstract static class ICharList.IReadOnlyCharList
extends ICharList

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.magicwerk.brownies.collections.primitive.ICharList

ICharList.IReadOnlyCharList, ICharList.IReadOnlyCharListFromArray, ICharList.IReadOnlyCharListFromCollection, ICharList.IReadOnlyCharListFromList, ICharList.IReadOnlyCharListFromMult

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	IReadOnlyCharList()

Method Summary

Modifier and Type	Method	Description
int	binarySearch(int index, int len, char key)	Searches the specified range for an object using the binary search algorithm.
int	capacity()	Returns capacity of this list.
protected boolean	doAdd(int index, char elem)	Helper method for adding an element to the list.
protected void	doAssign(ICharList that)	Assign this list the content of the that list.
protected void	doClone(ICharList that)	Initialize this object after the bitwise copy has been made by Object.clone().
protected ICharList	doCreate(int capacity)	Create list with specified capacity.
protected void	doEnsureCapacity(int minCapacity)	Increases the capacity of this list instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.
protected char	doRemove(int index)	Helper method to remove an element.
protected char	doReSet(int index, char elem)	Sets an element at specified position.
protected char	doSet(int index, char elem)	Helper method for setting an element in the list.
private void	error()	Throw exception if an attempt is made to change an immutable list.
protected char	getDefaultElem()
void	sort(int index, int len)	Sort specified elements in the list using the specified comparator.
void	trimToSize()
ICharList	unmodifiableList()

Methods inherited from class org.magicwerk.brownies.collections.primitive.ICharList

add, add, addAll, addAll, addAll, addAll, addArray, addArray, addArray, addArray, addFirst, addIfAbsent, addLast, addMult, addMult, binarySearch, charAt, checkIndex, checkIndexAdd, checkLength, checkLengths, checkNonNull, checkRange, clear, clone, contains, containsAll, containsAny, containsIf, copy, copy, count, countIf, crop, doAddAll, doClear, doCreateArray, doGet, doGetAll, doModify, doRemoveAll, doReplaceAll, doRotate, doTransfer, doTransferSwap, drag, element, ensureCapacity, equals, equalsElem, extract, extractIf, fill, filter, filterMap, get, getAll, getAll, getDistinct, getFirst, getFirstOrNull, getIf, getLast, getLastOrNull, getSingle, getSingleOrNull, hashCode, hashCodeElem, indexOf, indexOf, indexOfIf, initAll, initAll, initArray, initMult, isEmpty, lastIndexOf, lastIndexOf, length, map, mapFilter, move, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, push, put, putAll, putAll, putArray, putMult, remove, remove, remove, removeAll, removeAll, removeAll, removeElem, removeFirst, removeFirstOccurrence, removeIf, removeLast, removeLastOccurrence, replaceAll, replaceAll, replaceArray, replaceMult, resize, retain, retainAll, retainAll, retainIf, reverse, reverse, rotate, rotate, set, setAll, setAll, setArray, setArray, setMult, size, sort, subSequence, swap, toArray, toArray, toArray, toArray, toArray, toArray, toArray, toString, transferCopy, transferMove, transferRemove, transferSwap, transform, transformedList

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Constructor Detail

IReadOnlyCharList

protected IReadOnlyCharList()

Method Detail

unmodifiableList

public ICharList unmodifiableList()

Specified by:

unmodifiableList in class ICharList

doClone

protected void doClone(ICharList that)

Description copied from class: ICharList

Initialize this object after the bitwise copy has been made by Object.clone().

Specified by:

doClone in class ICharList

Parameters:

that - source object

capacity

public int capacity()

Description copied from class: ICharList

Returns capacity of this list. Note that two lists are considered equal even if they have a distinct capacity. Also the capacity can be changed by operations like clone() etc.

Specified by:

capacity in class ICharList

Returns:

capacity of this list

doSet

protected char doSet(int index,
                     char elem)

Description copied from class: ICharList

Helper method for setting an element in the list. This is the only method which really sets an element. Override if you need to validity checks before setting.

Specified by:

doSet in class ICharList

Parameters:

index - index where element will be placed

elem - element to set

Returns:

old element which was at the position

doReSet

protected char doReSet(int index,
                       char elem)

Description copied from class: ICharList

Sets an element at specified position. This method is used internally if existing elements will be moved etc. Override if you need to validity checks.

Specified by:

doReSet in class ICharList

Parameters:

index - index where element will be placed

elem - element to set

Returns:

old element which was at the position

getDefaultElem

protected char getDefaultElem()

Specified by:

getDefaultElem in class ICharList

doAdd

protected boolean doAdd(int index,
                        char elem)

Description copied from class: ICharList

Helper method for adding an element to the list. This is the only method which really adds an element. Override if you need to validity checks before adding.

Specified by:

doAdd in class ICharList

Parameters:

index - index where element should be added (-1 means it is up to the implementation to choose the index)

elem - element to add

Returns:

true if element has been added, false otherwise

doRemove

protected char doRemove(int index)

Description copied from class: ICharList

Helper method to remove an element. This is the only method which really removes an element. Override if you need to validity checks before removing.

Specified by:

doRemove in class ICharList

Parameters:

index - index of element to remove

Returns:

removed element

doEnsureCapacity

protected void doEnsureCapacity(int minCapacity)

Description copied from class: ICharList

Increases the capacity of this list instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.

Specified by:

doEnsureCapacity in class ICharList

Parameters:

minCapacity - the desired minimum capacity

trimToSize

public void trimToSize()

Specified by:

trimToSize in class ICharList

doCreate

protected ICharList doCreate(int capacity)

Description copied from class: ICharList

Create list with specified capacity.

Specified by:

doCreate in class ICharList

Parameters:

capacity - initial capacity (use -1 for default capacity)

Returns:

created list

doAssign

protected void doAssign(ICharList that)

Description copied from class: ICharList

Assign this list the content of the that list. This is done by bitwise copying so the that list should not be used afterwards.

Specified by:

doAssign in class ICharList

Parameters:

that - list to copy content from

sort

public void sort(int index,
                 int len)

Description copied from class: ICharList

Sort specified elements in the list using the specified comparator.

Specified by:

sort in class ICharList

Parameters:

index - index of first element to sort

len - number of elements to sort

See Also:

Arrays.sort(int[])

binarySearch

public int binarySearch(int index,
                        int len,
                        char key)

Description copied from class: ICharList

Searches the specified range for an object using the binary search algorithm.

Note that the method is defined to work with an arbitrary type <K>. This allows to search directly for a key field in the object without the need to construct an object containing the key:

  persons.binarySearch("john", new SearchByName());

  class SearchByName implements Comparator<Object> {
 	 public int compare(Object o1, Object o2) {
 	   String s1 = (o1 instanceof String) ? (String) o1 : ((Name) o1).getName();
 	   String s2 = (o2 instanceof String) ? (String) o2 : ((Name) o2).getName();
 	   return s1.compareTo(s2);
 	 }
  }
  /

Specified by:

binarySearch in class ICharList

Parameters:

index - index of first element to search

len - number of elements to search

key - the value to be searched for

Returns:

index of the search key, if it is contained in the array; otherwise, (-(insertion point) - 1). The insertion point is defined as the point at which the key would be inserted into the array: the index of the first element greater than the key, or a.length if all elements in the array are less than the specified key. Note that this guarantees that the return value will be >= 0 if and only if the key is found.

See Also:

Arrays.binarySearch(long[], long)

error

private void error()

Throw exception if an attempt is made to change an immutable list.