ParameterList Class Reference


                      
                      
                      subscript(_:)

Undocumented

Declaration

Swift

public subscript(index: Int) -> Parameter { get set }


                      
                      
                      empty

An immutable empty ParameterList.

Declaration

Swift

public static let empty: ParameterList


                      
                      
                      init(capacity:)

Construct a new list with 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 (and not less than) the list’s maximum length.

Declaration

Swift

override public init(capacity: Int = (4 as Int))

Parameters


                                  capacity

Optional initial capacity.


                      
                      
                      addFormal(name:type:)

Add a formal parameter.

See also

with.

Declaration

Swift

open func addFormal(name: String, type: DataType)

Parameters

`name`	Parameter name.
`type`	Parameter type.


                      
                      
                      append(_:)

Add item to the end of this list.

Declaration

Swift

public final func append(_ item: Parameter)

Parameters


                                  item

Item to be added.


                      
                      
                      append(contentsOf:)

Add all the items of list to the end of this list.

Declaration

Swift

public final func append(contentsOf list: ParameterList)

Parameters


                                  list

Items to be added.


                      
                      
                      copy()

Declaration

Swift

public final func copy() -> ParameterList

Return Value

A shallow copy of this list.


                      
                      
                      copyMutable()

Declaration

Swift

override open func copyMutable() -> DataValue

Return Value

a copy of this list which doesn’t share any mutable values with this list. The resulting list will not share any mutable values with this list. The resulting list might share immutable values with this list.


                      
                      
                      filter(_:)

Declaration

Swift

public final func filter(_ predicate: @escaping (Parameter) -> Bool) -> ParameterList

Parameters


                                  predicate

Function to be applied to each item of this list. Items matching this predicate will be returned in the new list.

Return Value

A new list which contains the items of this list that match a specified predicate function. Ordering is preserved.


                      
                      
                      first()

Throws

EmptyListException if the list is empty.

Declaration

Swift

public final func first() -> Parameter

Return Value

The first item in this list.


                      
                      
                      fromArray(_:)

Convert array to list.

Declaration

Swift

open class func fromArray(_ array: Array<Parameter>) -> ParameterList

Parameters


                                  array

Array with source items.

Return Value

New list with items copied from array parameter.


                      
                      
                      includes(item:)

Declaration

Swift

public final func includes(item: Parameter) -> Bool

Parameters


                                  item

Item for comparison. Comparison uses the equality property, which would usually be expected to match the == operator for item type Parameter.

Return Value

true if this list contains item.


                      
                      
                      indexOf(item:start:)

Declaration

Swift

public final func indexOf(item: Parameter, start: Int = (0 as Int)) -> Int

Parameters

`item`	Item for comparison. Comparison uses the `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).

Return Value

First index in this list of item, or -1 if not found.


                      
                      
                      insert(at:item:)

Insert item into this list, before the item (if any) at index.

Throws

ListIndexException if index is out of range (0 to length).

Declaration

Swift

public final func insert(at index: Int, item: Parameter)

Parameters

`index`	Zero-based index.
`item`	Item to be added.


                      
                      
                      insert(at:contentsOf:)

Insert all items of list into this list, before the item (if any) at index.

Throws

ListIndexException if index is out of range (0 to length).

Declaration

Swift

public final func insert(at index: Int, contentsOf list: ParameterList)

Parameters

`index`	Zero-based index.
`list`	List of items to be inserted.


                      
                      
                      item(at:)

Throws

ListIndexException if index is out of range (0 to length - 1).

Declaration

Swift

public final func item(at index: Int) -> Parameter

Parameters


                                  index

Zero-based index.

Return Value

The item in this list at the specified index.


                      
                      
                      last()

Throws

EmptyListException if the list is empty.

Declaration

Swift

public final func last() -> Parameter

Return Value

The last item in this list.


                      
                      
                      lastIndexOf(item:start:)

Declaration

Swift

public final func lastIndexOf(item: Parameter, start: Int = (2147483647 as Int)) -> Int

Parameters

`item`	Item for comparison. Comparison uses the `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).

Return Value

Last index in this list of item, or -1 if not found.


                      
                      
                      makeIterator()

Declaration

Swift

open func makeIterator() -> IndexingIterator<Array<Parameter>>

Return Value

This list converted to a Swift iterator.


                      
                      
                      of(_:)

Declaration

Swift

open class func of(_ items: Parameter...) -> ParameterList

Parameters


                                  rest_items

Items for the resulting list.

Return Value

A new list of item type Parameter, containing the specified items.


                      
                      
                      remove(name:)

Removed the parameter with the specified name.

Declaration

Swift

open func remove(name: String) -> Bool

Parameters


                                  name

Name of parameter to be removed.

Return Value

true if a parameter with the specified name was found (and removed), otherwise false.


                      
                      
                      required(name:)

Declaration

Swift

open func required(name: String) -> DataValue?

Parameters


                                  name

Required parameter name.

Return Value

the value of a required parameter, or throw DataServiceException with status 400 (Client Error) if the parameter is missing.


                      
                      
                      requiredList(name:)

Declaration

Swift

open func requiredList(name: String) -> ListBase

Parameters


                                  name

Required parameter name.

Return Value

the value of a required parameter with list type, or throw DataServiceException with status 400 (Client Error) if the parameter is missing.


                      
                      
                      reversed()

See also

copy, reverse.

Declaration

Swift

open func reversed() -> ParameterList

Return Value

a reversed copy of this list.


                      
                      
                      share(_:)

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.

Declaration

Swift

open class func share(_ list: ListBase) -> ParameterList

Parameters


                                  list

List whose items will be shared by the resulting list.

Return Value

A new list of item type Parameter, sharing the same items as list.


                      
                      
                      single()

Throws

EmptyListException if the list has no items, NotUniqueException if the list has multiple items.

Declaration

Swift

public final func single() -> Parameter

Return Value

A single item from this list.


                      
                      
                      slice(start:end:)

Declaration

Swift

public final func slice(start: Int, end: Int = (2147483647 as Int)) -> ParameterList

Parameters

`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.

Return Value

A slice of this list from index start (inclusive) to index end (exclusive).


                      
                      
                      sort(by:)

Sort this list in place (stable sort, O(n log n) complexity).

See also

copy, sort.

Declaration

Swift

public final func sort(by increasing: @escaping (Parameter, Parameter) -> Bool)

Parameters


                                  increasing

Predicate that returns true if its first argument should preceed its second argument in the desired ordering.


                      
                      
                      sorted()

See also

copy, sort.

Declaration

Swift

public final func sorted() -> ParameterList

Return Value

a sorted copy of this list using this list’s default comparer for ordering (stable sort, O(n log n) complexity).


                      
                      
                      sorted(by:)

See also

copy, sortBy.

Declaration

Swift

public final func sorted(by increasing: @escaping (Parameter, Parameter) -> Bool) -> ParameterList

Parameters


                                  increasing

Predicate that returns true if its first argument should preceed its second argument in the desired ordering.

Return Value

a sorted copy of this list (stable sort, O(n log n) complexity).


                      
                      
                      toArray()

Declaration

Swift

open func toArray() -> Array<Parameter>

Return Value

This list converted to a Swift array.


                      
                      
                      toNameList()

Declaration

Swift

open func toNameList() -> StringList

Return Value

A list with the Parameter.name for each parameter in this list.


                      
                      
                      update(at:item:)

Set the item in this list at the specified index.

Declaration

Swift

public final func update(at index: Int, item: Parameter)

Parameters

`index`	Zero-based index.
`item`	Item value.


                      
                      
                      with(name:value:)

See also

add.

Declaration

Swift

open func with(name: String, value: DataValue?) -> ParameterList

Parameters

`name`	Parameter name.
`value`	Parameter value.

Return Value

This list after adding an actual parameter.