org.wikimodel.wem
Class WikiParameters

java.lang.Object
  org.wikimodel.wem.WikiParameters

public class WikiParameters
extends Object

This is a default implementation of the IWikiParams interface.

Author:

kotelnikov

Field Summary

static WikiParameters

EMPTY An empty parameter list

Constructor Summary

WikiParameters(Collection<WikiParameter> list)

WikiParameters(String str)

Method Summary

WikiParameters	addParameter(String key, String value) Creates a new copy of this parameter object with new specified key/value pair.
boolean	equals(Object obj)
WikiParameter	getParameter(int pos)
WikiParameter	getParameter(String key)
WikiParameter[]	getParameters(String key) Returns all parameters with this key
int	getSize() Returns the number of parameters in the internal list.
int	hashCode()
static WikiParameters	newWikiParameters(String str)
WikiParameters	remove(String key)
List<WikiParameter>	toList() Returns a new list containing all parameters defined in this object.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY

public static final WikiParameters EMPTY

An empty parameter list

Constructor Detail

WikiParameters

public WikiParameters(Collection<WikiParameter> list)

Parameters:

list -

WikiParameters

public WikiParameters(String str)

Parameters:

str -

Method Detail

newWikiParameters

public static WikiParameters newWikiParameters(String str)

addParameter

public WikiParameters addParameter(String key,
                                   String value)

Creates a new copy of this parameter object with new specified key/value pair.

Parameters:

key - the parameter name

value - the value of the parameter

Returns:

a new copy of parameters object with the given key/value pair

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

getParameter

public WikiParameter getParameter(int pos)

Parameters:

pos - the position of the parameter

Returns:

the parameter from the specified position

getParameter

public WikiParameter getParameter(String key)

Parameters:

key - the key of the parameter

Returns:

the wiki parameter by key

getParameters

public WikiParameter[] getParameters(String key)

Returns all parameters with this key

Parameters:

key - the key of the parameter

Returns:

the wiki parameter by key

getSize

public int getSize()

Returns the number of parameters in the internal list.

Returns:

the number of parameters in the internal list

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

remove

public WikiParameters remove(String key)

Parameters:

key - the key of the parameter to remove

Returns:

a new copy of parameter list without the specified parameter; if this parameter list does not contain such a key then this method returns a reference to this object

toList

public List<WikiParameter> toList()

Returns a new list containing all parameters defined in this object.

Returns:

a list of all parameters

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()