com.helger.photon.basic.app.request

Class AbstractRequestParameterHandlerNamed

java.lang.Object

com.helger.photon.basic.app.request.AbstractRequestParameterHandlerNamed

All Implemented Interfaces:

IRequestParameterHandler, Serializable

Direct Known Subclasses:

RequestParameterHandlerURLParameter, RequestParameterHandlerURLPathNamed

@Immutable
public abstract class AbstractRequestParameterHandlerNamed
extends Object
implements IRequestParameterHandler

Base class for IRequestParameterHandler implementations that support special parameter names

Since:

7.0.2

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_REQUEST_PARAMETER_DISPLAY_LOCALE The default name of the parameter selecting the current display locale
static String	DEFAULT_REQUEST_PARAMETER_MENUITEM The default name of the parameter selecting the current menu item

Constructor Summary

Constructors

Constructor and Description
AbstractRequestParameterHandlerNamed()

Method Summary

Modifier and Type	Method and Description
String	getRequestParamNameLocale()
String	getRequestParamNameMenuItem()
abstract boolean	isValidParameterName(String sParamName) Check if the passed parameter name is valid according to the rules of this parameter handler.
AbstractRequestParameterHandlerNamed	setRequestParamNameLocale(String sRequestParamNameLocale)
AbstractRequestParameterHandlerNamed	setRequestParamNameMenuItem(String sRequestParamNameMenuItem)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.photon.basic.app.request.IRequestParameterHandler

buildURL, getParametersFromRequest, getParametersFromURL

Field Detail

DEFAULT_REQUEST_PARAMETER_DISPLAY_LOCALE

public static final String DEFAULT_REQUEST_PARAMETER_DISPLAY_LOCALE

The default name of the parameter selecting the current display locale

See Also:

Constant Field Values

DEFAULT_REQUEST_PARAMETER_MENUITEM

public static final String DEFAULT_REQUEST_PARAMETER_MENUITEM

The default name of the parameter selecting the current menu item

See Also:

Constant Field Values

Constructor Detail

AbstractRequestParameterHandlerNamed

public AbstractRequestParameterHandlerNamed()

Method Detail

isValidParameterName

public abstract boolean isValidParameterName(@Nonnull
                                             String sParamName)

Check if the passed parameter name is valid according to the rules of this parameter handler.

Parameters:

sParamName - The parameter name to check. May not be null.

Returns:

true if the parameter is valid, false otherwise.

getRequestParamNameLocale

@Nonnull
 @Nonempty
public final String getRequestParamNameLocale()

setRequestParamNameLocale

@Nonnull
public final AbstractRequestParameterHandlerNamed setRequestParamNameLocale(@Nonnull @Nonempty
                                                                                      String sRequestParamNameLocale)

getRequestParamNameMenuItem

@Nonnull
 @Nonempty
public final String getRequestParamNameMenuItem()

setRequestParamNameMenuItem

@Nonnull
public final AbstractRequestParameterHandlerNamed setRequestParamNameMenuItem(@Nonnull @Nonempty
                                                                                        String sRequestParamNameMenuItem)

toString

public String toString()

Overrides:

toString in class Object