com.exalead.searchapi.xmlv10.client

Class AbstractParametersContainer<P extends AbstractParameter>

java.lang.Object

com.exalead.searchapi.xmlv10.client.AbstractParametersContainer<P>

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

ParametersContainer, SuggestParametersContainer

public abstract class AbstractParametersContainer<P extends AbstractParameter>
extends java.lang.Object
implements java.lang.Cloneable

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>	parametersMap

Constructor Summary

Constructors

Constructor and Description
AbstractParametersContainer()

Method Summary

Modifier and Type	Method and Description
void	addParameter(java.lang.String key, java.lang.String value)
void	clear() Clear all
java.lang.Object	clone()
abstract java.util.List<P>	getAllParameters()
boolean	getBooleanValue(java.lang.String key, boolean defaultValue) Get the only value of a parameter for a given parameter type as boolean
int	getIntValue(java.lang.String key, int defaultValue) Get the only value of a parameter for a given parameter type as int
long	getLongValue(java.lang.String key, long defaultValue) Get the only value of a parameter for a given parameter type as long
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getParameters()
abstract java.util.List<P>	getParameters(java.lang.String key) Get all parameter values for a given parameters key.
java.lang.String	getValue(java.lang.String key) Get the only value of a parameter for a given parameter class
java.lang.String	getValue(java.lang.String key, java.lang.String defaultValue) Get the only value of a parameter for a given parameter class
java.util.List<java.lang.String>	getValues(java.lang.String key) Get all parameter values for a given parameters key.
java.lang.String	print() Print a unique string representing these parameters.
void	removeParameters(java.lang.String key) Remove all parameters of a given key
void	setParameter(java.lang.String key, boolean value)
void	setParameter(java.lang.String key, int value)
void	setParameter(java.lang.String key, long value)
void	setParameter(java.lang.String key, java.lang.String value)
void	setParameterStrict(java.lang.String key, java.lang.String value) Sets a parameter, but throws an exception if it already exists

Methods inherited from class java.lang.Object

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

Field Detail

parametersMap

protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> parametersMap

Constructor Detail

AbstractParametersContainer

public AbstractParametersContainer()

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

clear

public void clear()

Clear all

getValues

public java.util.List<java.lang.String> getValues(java.lang.String key)

Get all parameter values for a given parameters key.

getParameters

public abstract java.util.List<P> getParameters(java.lang.String key)

Get all parameter values for a given parameters key.

getValue

public java.lang.String getValue(java.lang.String key)
                          throws java.lang.IllegalArgumentException

Get the only value of a parameter for a given parameter class

Returns:

null if no parameter matches.

Throws:

java.lang.IllegalArgumentException - if several values match

getValue

public java.lang.String getValue(java.lang.String key,
                                 java.lang.String defaultValue)
                          throws java.lang.IllegalArgumentException

Get the only value of a parameter for a given parameter class

Returns:

defaultValue if no parameter matches.

Throws:

java.lang.IllegalArgumentException - if several values match

getIntValue

public int getIntValue(java.lang.String key,
                       int defaultValue)
                throws java.lang.IllegalArgumentException

Get the only value of a parameter for a given parameter type as int

Returns:

defaultValue if no parameter matches.

Throws:

java.lang.IllegalArgumentException - if several values match

getLongValue

public long getLongValue(java.lang.String key,
                         long defaultValue)
                  throws java.lang.IllegalArgumentException

Get the only value of a parameter for a given parameter type as long

Returns:

defaultValue if no parameter matches.

Throws:

java.lang.IllegalArgumentException - if several values match

getBooleanValue

public boolean getBooleanValue(java.lang.String key,
                               boolean defaultValue)
                        throws java.lang.IllegalArgumentException

Get the only value of a parameter for a given parameter type as boolean

Returns:

defaultValue if no parameter matches.

Throws:

java.lang.IllegalArgumentException - if several values match

print

public java.lang.String print()

Print a unique string representing these parameters. This string can be used as a query cache key

addParameter

public void addParameter(java.lang.String key,
                         java.lang.String value)

setParameter

public void setParameter(java.lang.String key,
                         java.lang.String value)

setParameter

public void setParameter(java.lang.String key,
                         int value)

setParameter

public void setParameter(java.lang.String key,
                         long value)

setParameter

public void setParameter(java.lang.String key,
                         boolean value)

setParameterStrict

public void setParameterStrict(java.lang.String key,
                               java.lang.String value)
                        throws java.lang.IllegalArgumentException

Sets a parameter, but throws an exception if it already exists

Throws:

java.lang.IllegalArgumentException

removeParameters

public void removeParameters(java.lang.String key)

Remove all parameters of a given key

getParameters

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getParameters()

getAllParameters

public abstract java.util.List<P> getAllParameters()