Class: ParameterList

ParameterList

This class represents a list for Parameter.

new ParameterList()

Extends

Requires

  • module:easejs
  • module:AbstractList
  • module:Parameter

Members

protectedcounterinteger

Number of items.

protecteditemsParameterList

ItemList

Methods

Clears this list.

contains(_item){boolean}

Verifies whether the given item is contained in the list.
Name Type Description
_item Parameter Parameter that should be verified

inherited containsKey(_key){boolean}

Verifies whether an item exists for the specified key.
Name Type Description
_key string Key that should be verified.

equals(_list){boolean}

Compare the specified ParameterList with this instance.
Name Type Description
_list ParameterList ParameterList that should be compared

getIdentifier(){String}

Returns an identifier of all the parameters in the list. The identifier can be used to compare two parameter lists.
Format: [FirstParameterName:FirstParameterValue][SecondParameterName:SecondParameterValue]…
Example
 [CP_TARGET_LATITUDE:52][CP_TARGET_LONGITUDE:13][CP_UNIT:KILOMETERS]

inherited getItem(_key){*}

Returns the item for the specified key.
Name Type Description
_key string key that should be searched for
Returns all items as parameter objects.

getItemsAsJson(){Object}

Returns the objects of the list as JSON objects.

inherited getKeys(){Array}

Returns the keys of all items.

inherited isEmpty(){boolean}

Verifies whether the list is empty.
Adds the specified item to the item list.
Name Type Description
_parameter Parameter ParameterList

putAll(_parameterList)

Adds all items in the specified list to the item list.
Name Type Description
_parameterList ParameterList ParameterList

inherited removeItem(_key)

Removes the item from this list for the specified key.
Name Type Description
_key string key that should be searched for
Returns the number of items that are included.

withItems(_parameterList){ParameterList}

Builder for item list.
Name Type Description
_parameterList ParameterList | Array ParameterList