com.sencha.gxt.core.client.util

Class Params

java.lang.Object

com.sencha.gxt.core.client.util.Params

public class Params
extends Object

Aggregates both a list of values and a map of named values. Allows methods to support both list and maps in a single parameter.

Note that only one type of values should be specified.

Constructor Summary

Constructors

Constructor and Description
Params() Creates a new params instance.
Params(Map<String,Object> values) Creates a new params instance.
Params(Object... values) Creates a new params instance.
Params(String key, Object value) Creates a new parameters instance.

Method Summary

Modifier and Type	Method and Description
Params	add(Object value) Adds a value.
List<Object>	getList() Returns the list values.
Map<String,Object>	getMap() Returns the values as a map.
boolean	isList() Returns true if the parameters are a list.
boolean	isMap() Returns true if the parameters are a map.
Params	set(String key, Object value) Sets a value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Params

public Params()

Creates a new params instance.

Params

public Params(Map<String,Object> values)

Creates a new params instance.

Parameters:

values - the initial values

Params

public Params(Object... values)

Creates a new params instance.

Parameters:

values - the initial values

Params

public Params(String key,
              Object value)

Creates a new parameters instance.

Parameters:

key - the key

value - the value

Method Detail

add

public Params add(Object value)

Adds a value.

Parameters:

value - the value to add

Returns:

this

getList

public List<Object> getList()

Returns the list values.

Returns:

the list values

getMap

public Map<String,Object> getMap()

Returns the values as a map.

Returns:

the map of values

isList

public boolean isList()

Returns true if the parameters are a list.

Returns:

true if a list

isMap

public boolean isMap()

Returns true if the parameters are a map.

Returns:

true if a map

set

public Params set(String key,
                  Object value)

Sets a value.

Parameters:

key - the key

value - the value

Returns:

this