public class CharList extends ListBase implements java.lang.Iterable<java.lang.Character>
A list of item type char
.
Uses the property and function naming conventions of the JavaScript Array object.
Constructor and Description |
---|
CharList()
See CharList(int).
|
CharList(int capacity)
Construct a new list with
CharList.length of zero and optional initial capacity . |
Modifier and Type | Method and Description |
---|---|
void |
add(char item)
Add
item to the end of this list. |
void |
addAll(CharList list)
Add all the items of
list to the end of this list. |
CharList |
addThis(char item)
Add
item to the end of this list. |
CharList |
copy()
Return a shallow copy of this list.
|
char |
first()
Return the first item in this list.
|
static CharList |
from(java.util.List<java.lang.Character> list) |
char |
get(int index)
Return the item in this list at the specified
index . |
boolean |
includes(char item)
Return
true if this list contains item . |
int |
indexOf(char item)
See indexOf(char, int).
|
int |
indexOf(char item,
int start)
Return first index in this list of
item , or -1 if not found. |
void |
insertAll(int index,
CharList list)
Insert all items of
list into this list, before the item (if any) at index . |
void |
insertAt(int index,
char item)
Insert
item into this list, before the item (if any) at index . |
java.util.Iterator<java.lang.Character> |
iterator() |
char |
last()
Return the last item in this list.
|
int |
lastIndexOf(char item)
|
int |
lastIndexOf(char item,
int start)
Return last index in this list of
item , or -1 if not found. |
void |
set(int index,
char item)
Set the item in this list at the specified
index . |
static CharList |
share(ListBase list)
|
char |
single()
Return a single item from this list.
|
CharList |
slice(int start)
See slice(int, int).
|
CharList |
slice(int start,
int end)
Return a slice of this list from index
start (inclusive) to index end (exclusive). |
ListBase |
toDynamic()
Return (nullable) a dynamic representation of this list (
DataValueList , ComplexValueList , or EntityValueList ), or null if there is no dynamic representation available. |
java.util.List<java.lang.Character> |
toGeneric() |
clear, getComparer, getDataType, getEquality, getUntypedList, isEmpty, length, removeAt, removeFirst, removeLast, removeRange, reverse, shareWith, sort, sortWith, toString, validate
cloneMutable, equals, getTypeCode, hashCode
public static final CharList empty
public CharList()
public CharList(int capacity)
Construct a new list with CharList.length
of zero and optional initial capacity
.
A list can expand in length beyond its initial capacity, but best performance
will be obtained if the initial capacity is close to the list's maximum length.
capacity
- Optional initial capacity.public void add(char item)
Add item
to the end of this list.
item
- Item to be added.public void addAll(CharList list)
Add all the items of list
to the end of this list.
list
- Items to be added.public CharList addThis(char item)
Add item
to the end of this list.
item
- Item to be added.public CharList copy()
Return a shallow copy of this list.
public char first()
Return the first item in this list.
EmptyListException
if the list is empty.
public static CharList from(java.util.List<java.lang.Character> list)
public char get(int index)
Return the item in this list at the specified index
.
ListIndexException
if index
is out of range (0 to CharList.length
- 1).
index
- Zero-based index.public boolean includes(char item)
Return true
if this list contains item
.
item
- Item for comparison. Comparison uses the CharList.equality
property, which would usually be expected to match the ==
operator for item type char
.true
if this list contains item
.public int indexOf(char item)
item
- Item parameter.public int indexOf(char item, int start)
Return first index in this list of item
, or -1
if not found.
item
- Item for comparison. Comparison uses the CharList.equality
property, which would usually be expected to match the ==
operator for item type char
.start
- Zero-based starting index (search moves forwards from this index).item
, or -1
if not found.public void insertAll(int index, CharList list)
Insert all items of list
into this list, before the item (if any) at index
.
ListIndexException
if index
is out of range (0 to CharList.length
).
index
- Zero-based index.list
- List of items to be inserted.public void insertAt(int index, char item)
Insert item
into this list, before the item (if any) at index
.
ListIndexException
if index
is out of range (0 to CharList.length
).
index
- Zero-based index.item
- Item to be added.public java.util.Iterator<java.lang.Character> iterator()
iterator
in interface java.lang.Iterable<java.lang.Character>
public char last()
Return the last item in this list.
EmptyListException
if the list is empty.
public int lastIndexOf(char item)
item
- Item parameter.public int lastIndexOf(char item, int start)
Return last index in this list of item
, or -1
if not found.
item
- Item for comparison. Comparison uses the CharList.equality
property, which would usually be expected to match the ==
operator for item type char
.start
- Zero-based starting index (search moves backwards from this index).item
, or -1
if not found.public void set(int index, char item)
Set the item in this list at the specified index
.
index
- Zero-based index.item
- Item value.public static CharList share(ListBase list)
Return a new CharList
that shares the ListBase.untypedList
as the list
parameter.
To ensure type safety, items in list
that do not have the item type char
will be removed.
list
- List whose items will be shared by the resulting list.char
, sharing the same items as list
.public char single()
Return a single item from this list.
EmptyListException
if the list has no items, NotUniqueException
if the list has multiple items.
public CharList slice(int start)
start
- Start parameter.public CharList slice(int start, int end)
Return a slice of this list from index start
(inclusive) to index end
(exclusive).
start
- Zero-based starting index (inclusive), or negative for starting index relative to the end of this list.end
- Zero-based ending index (exclusive), or negative for ending index relative to the end of this list.start
(inclusive) to index end
(exclusive).public ListBase toDynamic()
Return (nullable) a dynamic representation of this list (DataValueList
, ComplexValueList
, or EntityValueList
), or null
if there is no dynamic representation available.
toDynamic
in class ListBase
DataValueList
, ComplexValueList
, or EntityValueList
), or null
if there is no dynamic representation available.public java.util.List<java.lang.Character> toGeneric()