public class ParameterList extends ListBase implements java.lang.Iterable<Parameter>
A list of item type Parameter.
Uses the property and function naming conventions of the JavaScript Array object.
| Modifier and Type | Field and Description |
|---|---|
static ParameterList |
empty |
| Constructor and Description |
|---|
ParameterList()
See ParameterList(int).
|
ParameterList(int capacity)
Construct a new list with
ParameterList.length of zero and optional initial capacity. |
| Modifier and Type | Method and Description |
|---|---|
void |
add(Parameter item)
Add
item to the end of this list. |
void |
addAll(ParameterList list)
Add all the items of
list to the end of this list. |
void |
addFormal(java.lang.String name,
DataType type)
Add a formal parameter.
|
ParameterList |
addThis(Parameter item)
Add
item to the end of this list. |
ParameterList |
copy()
Return a shallow copy of this list.
|
Parameter |
first()
Return the first item in this list.
|
static ParameterList |
from(java.util.List<Parameter> list) |
Parameter |
get(int index)
Return the item in this list at the specified
index. |
DataValue |
getRequired(java.lang.String name)
Return (nullable) the value of a required parameter, or throw
DataServiceException with status 400 (Client Error) if the parameter is missing. |
ListBase |
getRequiredList(java.lang.String name)
Return the value of a required parameter with list type, or throw
DataServiceException with status 400 (Client Error) if the parameter is missing. |
boolean |
includes(Parameter item)
Return
true if this list contains item. |
int |
indexOf(Parameter item)
|
int |
indexOf(Parameter item,
int start)
Return first index in this list of
item, or -1 if not found. |
void |
insertAll(int index,
ParameterList list)
Insert all items of
list into this list, before the item (if any) at index. |
void |
insertAt(int index,
Parameter item)
Insert
item into this list, before the item (if any) at index. |
java.util.Iterator<Parameter> |
iterator() |
Parameter |
last()
Return the last item in this list.
|
int |
lastIndexOf(Parameter item)
|
int |
lastIndexOf(Parameter item,
int start)
Return last index in this list of
item, or -1 if not found. |
boolean |
remove(java.lang.String name)
Removed the parameter with the specified
name. |
void |
set(int index,
Parameter item)
Set the item in this list at the specified
index. |
static ParameterList |
share(ListBase list)
|
Parameter |
single()
Return a single item from this list.
|
ParameterList |
slice(int start)
See slice(int, int).
|
ParameterList |
slice(int start,
int end)
Return a slice of this list from index
start (inclusive) to index end (exclusive). |
java.util.List<Parameter> |
toGeneric() |
ParameterList |
with(java.lang.String name,
DataValue value)
Return this list after adding an actual parameter.
|
clear, getComparer, getDataType, getEquality, getUntypedList, isEmpty, length, removeAt, removeFirst, removeLast, removeRange, reverse, shareWith, sort, sortWith, toDynamic, toString, validatecloneMutable, equals, getTypeCode, hashCodepublic static final ParameterList empty
public ParameterList()
public ParameterList(int capacity)
Construct a new list with ParameterList.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(Parameter item)
Add item to the end of this list.
item - Item to be added.public void addAll(ParameterList list)
Add all the items of list to the end of this list.
list - Items to be added.public void addFormal(java.lang.String name,
DataType type)
Add a formal parameter.
name - Parameter name.type - Parameter type.public ParameterList addThis(Parameter item)
Add item to the end of this list.
item - Item to be added.public ParameterList copy()
Return a shallow copy of this list.
public Parameter first()
Return the first item in this list.
EmptyListException if the list is empty.
public static ParameterList from(java.util.List<Parameter> list)
public Parameter get(int index)
Return the item in this list at the specified index.
ListIndexException if index is out of range (0 to ParameterList.length - 1).
index - Zero-based index.public DataValue getRequired(java.lang.String name)
Return (nullable) the value of a required parameter, or throw DataServiceException with status 400 (Client Error) if the parameter is missing.
name - Required parameter name.DataServiceException with status 400 (Client Error) if the parameter is missing.public ListBase getRequiredList(java.lang.String name)
Return the value of a required parameter with list type, or throw DataServiceException with status 400 (Client Error) if the parameter is missing.
name - Required parameter name.DataServiceException with status 400 (Client Error) if the parameter is missing.public boolean includes(Parameter item)
Return true if this list contains item.
item - Item for comparison. Comparison uses the ParameterList.equality property, which would usually be expected to match the == operator for item type Parameter.true if this list contains item.public int indexOf(Parameter item)
item - Item parameter.public int indexOf(Parameter item, int start)
Return first index in this list of item, or -1 if not found.
item - Item for comparison. Comparison uses the ParameterList.equality property, which would usually be expected to match the == operator for item type Parameter.start - Zero-based starting index (search moves forwards from this index).item, or -1 if not found.public void insertAll(int index,
ParameterList 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 ParameterList.length).
index - Zero-based index.list - List of items to be inserted.public void insertAt(int index,
Parameter item)
Insert item into this list, before the item (if any) at index.
ListIndexException if index is out of range (0 to ParameterList.length).
index - Zero-based index.item - Item to be added.public java.util.Iterator<Parameter> iterator()
iterator in interface java.lang.Iterable<Parameter>public Parameter last()
Return the last item in this list.
EmptyListException if the list is empty.
public int lastIndexOf(Parameter item)
item - Item parameter.public int lastIndexOf(Parameter item, int start)
Return last index in this list of item, or -1 if not found.
item - Item for comparison. Comparison uses the ParameterList.equality property, which would usually be expected to match the == operator for item type Parameter.start - Zero-based starting index (search moves backwards from this index).item, or -1 if not found.public boolean remove(java.lang.String name)
Removed the parameter with the specified name.
name - Name of parameter to be removed.true if a parameter with the specified name was found (and removed), otherwise false.public void set(int index,
Parameter item)
Set the item in this list at the specified index.
index - Zero-based index.item - Item value.public static ParameterList share(ListBase list)
Return a new ParameterList that shares the ListBase.untypedList as the list parameter.
To ensure type safety, items in list that do not have the item type Parameter will be removed.
list - List whose items will be shared by the resulting list.Parameter, sharing the same items as list.public Parameter single()
Return a single item from this list.
EmptyListException if the list has no items, NotUniqueException if the list has multiple items.
public ParameterList slice(int start)
start - Start parameter.public ParameterList 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<Parameter> toGeneric()
public ParameterList with(java.lang.String name, DataValue value)
Return this list after adding an actual parameter.
name - Parameter name.value - (nullable) Parameter value.