net.sourceforge.stripes.controller
Class UrlBindingParameter

java.lang.Object
  net.sourceforge.stripes.controller.UrlBindingParameter

public class UrlBindingParameter
extends Object

A parameter to a clean URL.

Since:

Stripes 1.5

Author:

Ben Gunter

Field Summary

protected Class<? extends ActionBean>	beanClass
protected String	defaultValue
protected String	name
static String	PARAMETER_NAME_EVENT The special parameter name for the event to execute
protected String	value

Constructor Summary

UrlBindingParameter(Class<? extends ActionBean> beanClass, String name, String value)
Create a new UrlBindingParameter with the given name and value.

UrlBindingParameter(Class<? extends ActionBean> beanClass, String name, String value, String defaultValue)
Create a new UrlBindingParameter with the given name, value and default value.

UrlBindingParameter(UrlBindingParameter prototype)
Make an exact copy of the given UrlBindingParameter.

UrlBindingParameter(UrlBindingParameter prototype, String value)
Make a copy of the given UrlBindingParameter except that the parameter's value will be set to value.

Method Summary

boolean	equals(Object o)
Class<? extends ActionBean>	getBeanClass() Get the ActionBean class to which the UrlBinding applies.
String	getDefaultValue() Get the parameter's default value, which may be null.
String	getName() Get the parameter name.
String	getValue() Return the parameter value that was extracted from a URI.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_NAME_EVENT

public static final String PARAMETER_NAME_EVENT

The special parameter name for the event to execute

See Also:

Constant Field Values

beanClass

protected Class<? extends ActionBean> beanClass

name

protected String name

value

protected String value

defaultValue

protected String defaultValue

Constructor Detail

UrlBindingParameter

public UrlBindingParameter(Class<? extends ActionBean> beanClass,
                           String name,
                           String value)

Create a new UrlBindingParameter with the given name and value. The defaultValue will be null.

Parameters:

name - parameter name

value - parameter value

UrlBindingParameter

public UrlBindingParameter(Class<? extends ActionBean> beanClass,
                           String name,
                           String value,
                           String defaultValue)

Create a new UrlBindingParameter with the given name, value and default value.

Parameters:

name - parameter name

value - parameter value

defaultValue - default value to use if value is null

UrlBindingParameter

public UrlBindingParameter(UrlBindingParameter prototype)

Make an exact copy of the given UrlBindingParameter.

Parameters:

prototype - a parameter

UrlBindingParameter

public UrlBindingParameter(UrlBindingParameter prototype,
                           String value)

Make a copy of the given UrlBindingParameter except that the parameter's value will be set to value.

Parameters:

prototype - a parameter

value - the new parameter value

Method Detail

getBeanClass

public Class<? extends ActionBean> getBeanClass()

Get the ActionBean class to which the UrlBinding applies.

getDefaultValue

public String getDefaultValue()

Get the parameter's default value, which may be null.

Returns:

the default value

getName

public String getName()

Get the parameter name.

Returns:

parameter name

getValue

public String getValue()

Return the parameter value that was extracted from a URI.

Returns:

parameter value

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object