public class GeographyValueList extends ListBase implements java.lang.Iterable<GeographyValue>
A list of item type GeographyValue
.
Modifier and Type | Field and Description |
---|---|
static GeographyValueList |
empty |
Constructor and Description |
---|
GeographyValueList()
|
GeographyValueList(int capacity)
Construct a new list with
GeographyValueList.length of zero and optional initial capacity . |
Modifier and Type | Method and Description |
---|---|
void |
add(GeographyValue item)
Add
item to the end of this list. |
void |
addAll(GeographyValueList list)
Add all the items of
list to the end of this list. |
GeographyValueList |
addThis(GeographyValue item)
Add
item to the end of this list. |
GeographyValueList |
copy()
Return a shallow copy of this list.
|
GeographyValue |
first()
Return the first item in this list.
|
static GeographyValueList |
from(java.util.List<GeographyValue> list) |
GeographyValue |
get(int index)
Return the item in this list at the specified
index . |
boolean |
includes(GeographyValue item)
Return
true if this list contains item . |
int |
indexOf(GeographyValue item)
|
int |
indexOf(GeographyValue item,
int start)
Return first index in this list of
item , or -1 if not found. |
void |
insertAll(int index,
GeographyValueList list)
Insert all items of
list into this list, before the item (if any) at index . |
void |
insertAt(int index,
GeographyValue item)
Insert
item into this list, before the item (if any) at index . |
java.util.Iterator<GeographyValue> |
iterator() |
GeographyValue |
last()
Return the last item in this list.
|
int |
lastIndexOf(GeographyValue item)
|
int |
lastIndexOf(GeographyValue item,
int start)
Return last index in this list of
item , or -1 if not found. |
void |
set(int index,
GeographyValue item)
Set the item in this list at the specified
index . |
static GeographyValueList |
share(ListBase list)
|
GeographyValue |
single()
Return a single item from this list.
|
GeographyValueList |
slice(int start)
See slice(int, int).
|
GeographyValueList |
slice(int start,
int end)
Return a slice of this list from index
start (inclusive) to index end (exclusive). |
java.util.List<GeographyValue> |
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 GeographyValueList empty
public GeographyValueList()
public GeographyValueList(int capacity)
Construct a new list with GeographyValueList.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(GeographyValue item)
Add item
to the end of this list.
item
- Item to be added.public void addAll(GeographyValueList list)
Add all the items of list
to the end of this list.
list
- Items to be added.public GeographyValueList addThis(GeographyValue item)
Add item
to the end of this list.
item
- Item to be added.public GeographyValueList copy()
Return a shallow copy of this list.
public GeographyValue first()
Return the first item in this list.
EmptyListException
if the list is empty.
public static GeographyValueList from(java.util.List<GeographyValue> list)
public GeographyValue get(int index)
Return the item in this list at the specified index
.
ListIndexException
if index
is out of range (0 to GeographyValueList.length
- 1).
index
- Zero-based index.public boolean includes(GeographyValue item)
Return true
if this list contains item
.
item
- Item for comparison. Comparison uses the GeographyValueList.equality
property, which would usually be expected to match the ==
operator for item type GeographyValue
.true
if this list contains item
.public int indexOf(GeographyValue item)
public int indexOf(GeographyValue item, int start)
Return first index in this list of item
, or -1
if not found.
item
- Item for comparison. Comparison uses the GeographyValueList.equality
property, which would usually be expected to match the ==
operator for item type GeographyValue
.start
- Zero-based starting index (search moves forwards from this index).item
, or -1
if not found.public void insertAll(int index, GeographyValueList 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 GeographyValueList.length
).
index
- Zero-based index.list
- List of items to be inserted.public void insertAt(int index, GeographyValue item)
Insert item
into this list, before the item (if any) at index
.
ListIndexException
if index
is out of range (0 to GeographyValueList.length
).
index
- Zero-based index.item
- Item to be added.public java.util.Iterator<GeographyValue> iterator()
iterator
in interface java.lang.Iterable<GeographyValue>
public GeographyValue last()
Return the last item in this list.
EmptyListException
if the list is empty.
public int lastIndexOf(GeographyValue item)
public int lastIndexOf(GeographyValue item, int start)
Return last index in this list of item
, or -1
if not found.
item
- Item for comparison. Comparison uses the GeographyValueList.equality
property, which would usually be expected to match the ==
operator for item type GeographyValue
.start
- Zero-based starting index (search moves backwards from this index).item
, or -1
if not found.public void set(int index, GeographyValue item)
Set the item in this list at the specified index
.
index
- Zero-based index.item
- Item value.public static GeographyValueList share(ListBase list)
Return a new GeographyValueList
that shares the ListBase.untypedList
as the list
parameter.
To ensure type safety, items in list
that do not have the item type GeographyValue
will be removed.
list
- List whose items will be shared by the resulting list.GeographyValue
, sharing the same items as list
.public GeographyValue single()
Return a single item from this list.
EmptyListException
if the list has no items, NotUniqueException
if the list has multiple items.
public GeographyValueList slice(int start)
public GeographyValueList 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 java.util.List<GeographyValue> toGeneric()