|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.carrotsearch.hppc.CharArrayList
@Generated(date="2011-07-12T16:58:49+0200", value="HPPC generated from: CharArrayList.java") public class CharArrayList
An array-backed list of chars. A single array is used to store and manipulate
all elements. Reallocations are governed by a ArraySizingStrategy
and may be expensive if they move around really large chunks of memory.
See ObjectArrayList
class for API similarities and differences against Java
Collections.
Field Summary | |
---|---|
char[] |
buffer
Internal array for storing the list. |
static int |
DEFAULT_CAPACITY
Default capacity if no other capacity is given in the constructor. |
int |
elementsCount
Current number of elements stored in buffer . |
protected ArraySizingStrategy |
resizer
Buffer resizing strategy. |
Constructor Summary | |
---|---|
CharArrayList()
Create with default sizing strategy and initial capacity for storing 5 elements. |
|
CharArrayList(CharContainer container)
Creates a new list from elements of another container. |
|
CharArrayList(int initialCapacity)
Create with default sizing strategy and the given initial capacity. |
|
CharArrayList(int initialCapacity,
ArraySizingStrategy resizer)
Create with a custom buffer resizing strategy. |
Method Summary | ||
---|---|---|
void |
add(char... elements)
Vararg-signature method for adding elements at the end of the list. |
|
void |
add(char e1)
Adds an element to the end of this container (the last index is incremented by one). |
|
void |
add(char[] elements,
int start,
int length)
Add all elements from a range of given array to the list. |
|
void |
add(char e1,
char e2)
Appends two elements at the end of the list. |
|
int |
addAll(CharContainer container)
Adds all elements from another container. |
|
int |
addAll(java.lang.Iterable<? extends CharCursor> iterable)
Adds all elements from another iterable. |
|
void |
clear()
Sets the number of stored elements to zero. |
|
CharArrayList |
clone()
Clone this object. |
|
boolean |
contains(char e1)
Lookup a given element in the container. |
|
protected void |
ensureBufferSpace(int expectedAdditions)
Ensures the internal buffer has enough free slots to store expectedAdditions . |
|
void |
ensureCapacity(int minCapacity)
Increases the capacity of this instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument. |
|
boolean |
equals(java.lang.Object obj)
Compares the specified object with this container for equality. |
|
|
forEach(T predicate)
Applies a predicate to container elements as long, as the predicate
returns true . |
|
|
forEach(T procedure)
Applies a procedure to all container elements. |
|
|
forEach(T predicate,
int fromIndex,
int toIndex)
Applies predicate to a slice of the list,
fromIndex , inclusive, to toIndex ,
exclusive, or until predicate returns false . |
|
|
forEach(T procedure,
int fromIndex,
int toIndex)
Applies procedure to a slice of the list,
fromIndex , inclusive, to toIndex ,
exclusive. |
|
static CharArrayList |
from(char... elements)
Create a list from a variable number of arguments or an array of char . |
|
static CharArrayList |
from(CharContainer container)
Create a list from elements of another container. |
|
char |
get(int index)
|
|
int |
hashCode()
|
|
int |
indexOf(char e1)
Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element. |
|
void |
insert(int index,
char e1)
Inserts the specified element at the specified position in this list. |
|
boolean |
isEmpty()
Shortcut for size() == 0 . |
|
java.util.Iterator<CharCursor> |
iterator()
Returns an iterator to a cursor traversing the collection. |
|
int |
lastIndexOf(char e1)
Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element. |
|
static CharArrayList |
newInstance()
Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor). |
|
static CharArrayList |
newInstanceWithCapacity(int initialCapacity)
Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor). |
|
void |
release()
Sets the number of stored elements to zero and releases the internal storage array. |
|
char |
remove(int index)
Removes the element at the specified position in this list and returns it. |
|
int |
removeAll(CharLookupContainer c)
Default implementation uses a predicate for removal. |
|
int |
removeAll(CharPredicate predicate)
Removes all elements in this collection for which the given predicate returns true . |
|
int |
removeAllOccurrences(char e1)
Removes all occurrences of e from this collection. |
|
int |
removeFirstOccurrence(char e1)
Removes the first element that equals e1 , returning its
deleted position or -1 if the element was not found. |
|
int |
removeLastOccurrence(char e1)
Removes the last element that equals e1 , returning its
deleted position or -1 if the element was not found. |
|
void |
removeRange(int fromIndex,
int toIndex)
Removes from this list all of the elements whose index is between fromIndex , inclusive, and toIndex , exclusive. |
|
void |
resize(int newSize)
Truncate or expand the list to the new size. |
|
int |
retainAll(CharLookupContainer c)
Default implementation uses a predicate for retaining. |
|
int |
retainAll(CharPredicate predicate)
Default implementation redirects to CharCollection.removeAll(CharPredicate)
and negates the predicate. |
|
char |
set(int index,
char e1)
Replaces the element at the specified position in this list with the specified element. |
|
int |
size()
Return the current number of elements in this container. |
|
char[] |
toArray()
Default implementation of copying to an array. |
|
java.lang.String |
toString()
Convert the contents of this container to a human-friendly string. |
|
void |
trimToSize()
Trim the internal buffer to the current size. |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.carrotsearch.hppc.CharCollection |
---|
removeAll, retainAll, retainAll |
Field Detail |
---|
public static final int DEFAULT_CAPACITY
public char[] buffer
size()
).
public int elementsCount
buffer
.
protected final ArraySizingStrategy resizer
Constructor Detail |
---|
public CharArrayList()
BoundedProportionalArraySizingStrategy
public CharArrayList(int initialCapacity)
BoundedProportionalArraySizingStrategy
public CharArrayList(int initialCapacity, ArraySizingStrategy resizer)
public CharArrayList(CharContainer container)
Method Detail |
---|
public void add(char e1)
add
in interface CharIndexedContainer
public final void add(char e1, char e2)
add
(vararg-version) or access the buffer directly (tight
loop).
public final void add(char[] elements, int start, int length)
public final void add(char... elements)
This method is handy, but costly if used in tight loops (anonymous array passing)
public final int addAll(CharContainer container)
public final int addAll(java.lang.Iterable<? extends CharCursor> iterable)
public final void insert(int index, char e1)
insert
in interface CharIndexedContainer
index
- The index at which the element should be inserted, shifting
any existing and subsequent elements to the right.public final char get(int index)
get
in interface CharIndexedContainer
index
from the list.public final char set(int index, char e1)
set
in interface CharIndexedContainer
public final char remove(int index)
Careful. Do not confuse this method with the overridden signature in
Java Collections (List.remove(Object)
). Use: CharCollection.removeAll(com.carrotsearch.hppc.CharLookupContainer)
,
CharIndexedContainer.removeFirstOccurrence(char)
or CharIndexedContainer.removeLastOccurrence(char)
depending
on the actual need.
remove
in interface CharIndexedContainer
public final void removeRange(int fromIndex, int toIndex)
fromIndex
, inclusive, and toIndex
, exclusive.
removeRange
in interface CharIndexedContainer
public final int removeFirstOccurrence(char e1)
e1
, returning its
deleted position or -1
if the element was not found.
removeFirstOccurrence
in interface CharIndexedContainer
public final int removeLastOccurrence(char e1)
e1
, returning its
deleted position or -1
if the element was not found.
removeLastOccurrence
in interface CharIndexedContainer
public final int removeAllOccurrences(char e1)
e
from this collection.
removeAllOccurrences
in interface CharCollection
e1
- Element to be removed from this collection, if present.
public final boolean contains(char e1)
contains
in interface CharContainer
true
if this container has an element
equal to e
.public final int indexOf(char e1)
indexOf
in interface CharIndexedContainer
public final int lastIndexOf(char e1)
lastIndexOf
in interface CharIndexedContainer
public final boolean isEmpty()
size() == 0
.
isEmpty
in interface CharContainer
public final void ensureCapacity(int minCapacity)
protected final void ensureBufferSpace(int expectedAdditions)
expectedAdditions
. Increases internal buffer size if needed.
public void resize(int newSize)
trimToSize()
if you need a truncated buffer),
but the truncated values will be reset to the default value (zero). If the list is
expanded, the elements beyond the current size are initialized with JVM-defaults
(zero or null
values).
public final int size()
O(n)
time, although implementing classes
should try to maintain the current size and return in constant time.
size
in interface CharContainer
public final void trimToSize()
public final void clear()
elementsCount
field to zero.
clear
in interface CharCollection
public final void release()
public final char[] toArray()
The returned array is sized to match exactly the number of elements of the stack.
toArray
in interface CharContainer
public CharArrayList clone()
clone
in class java.lang.Object
public int hashCode()
hashCode
in interface CharIndexedContainer
hashCode
in class java.lang.Object
List.hashCode()
(should be implemented
with the same algorithm).public boolean equals(java.lang.Object obj)
CharIndexedContainer
, both have the same size, and all corresponding
pairs of elements at the same index are equal. In other words, two indexed
containers are defined to be equal if they contain the same elements in the same
order.
Note that, unlike in List
, containers may be of different types and still
return true
from CharIndexedContainer.equals(java.lang.Object)
. This may be dangerous if you use
different hash functions in two containers, but don't override the default
implementation of CharIndexedContainer.equals(java.lang.Object)
. It is the programmer's responsibility to
enforcing these contracts properly.
equals
in interface CharIndexedContainer
equals
in class java.lang.Object
public java.util.Iterator<CharCursor> iterator()
The iterator is implemented as a
cursor and it returns the same cursor instance on every call to
Iterator.next()
(to avoid boxing of primitive types). To read the current
list's value (or index in the list) use the cursor's public fields. An example is
shown below.
for (CharCursor<char> c : container) { System.out.println("index=" + c.index + " value=" + c.value); }
iterator
in interface CharContainer
iterator
in interface java.lang.Iterable<CharCursor>
public <T extends CharProcedure> T forEach(T procedure)
procedure
to all container elements. Returns the argument (any
subclass of CharProcedure
. This lets the caller to call methods of the argument
by chaining the call (even if the argument is an anonymous type) to retrieve computed values,
for example (IntContainer):
int count = container.forEach(new IntProcedure() { int count; // this is a field declaration in an anonymous class. public void apply(int value) { count++; }}).count;
forEach
in interface CharContainer
public <T extends CharProcedure> T forEach(T procedure, int fromIndex, int toIndex)
procedure
to a slice of the list,
fromIndex
, inclusive, to toIndex
,
exclusive.
public int removeAll(CharPredicate predicate)
true
.
removeAll
in interface CharCollection
public <T extends CharPredicate> T forEach(T predicate)
predicate
to container elements as long, as the predicate
returns true
. The iteration is interrupted otherwise.
forEach
in interface CharContainer
public <T extends CharPredicate> T forEach(T predicate, int fromIndex, int toIndex)
predicate
to a slice of the list,
fromIndex
, inclusive, to toIndex
,
exclusive, or until predicate returns false
.
public static CharArrayList newInstance()
public static CharArrayList newInstanceWithCapacity(int initialCapacity)
public static CharArrayList from(char... elements)
char
.
The elements are copied from the argument to the internal buffer.
public static CharArrayList from(CharContainer container)
public int removeAll(CharLookupContainer c)
removeAll
in interface CharCollection
public int retainAll(CharLookupContainer c)
retainAll
in interface CharCollection
public int retainAll(CharPredicate predicate)
CharCollection.removeAll(CharPredicate)
and negates the predicate.
retainAll
in interface CharCollection
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |