vodserver.parambuilder

Interface ParamBuilder

All Superinterfaces:

Comparable<ParamBuilder>, org.springframework.core.Ordered

All Known Implementing Classes:

AbstractContentRegExParamBuilder, AbstractParamBuilder, ContentDynamicRegExParamBuilder, ContentRegExParamBuilder, RequestParamBuilder, ScriptedParamBuilder, StaticParamBuilder, WebContentParamBuilder

public interface ParamBuilder
extends Comparable<ParamBuilder>, org.springframework.core.Ordered

This interface describes the contract for ParamBuilder implementations. It only contains a single method for updating parameters, but since it extends the Comparable and Ordered interfaces, those methods must be implemented as well.

Author:

Ruud Senden

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Methods

Modifier and Type	Method and Description
void	buildParams(Map<String,String> params, javax.servlet.http.HttpServletRequest request) This method builds the parameters.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.springframework.core.Ordered

getOrder

Method Detail

buildParams

void buildParams(Map<String,String> params,
               javax.servlet.http.HttpServletRequest request)

This method builds the parameters. Implementations can add new parameters, or retrieve, update, or delete parameters created by other ParamBuilders that were executed earlier in the chain of ParamBuilders.

Parameters:

params - The parameters map to which parameters can be added or existing parameters can be retrieved.

request - The original request, useful to retrieve request parameters for example.