org.zalando.guild.api.json.fields.jackson.servlet

Class ParamBasedPredicateFunction

java.lang.Object

org.zalando.guild.api.json.fields.jackson.servlet.ParamBasedPredicateFunction

All Implemented Interfaces:

com.google.common.base.Function<javax.servlet.http.HttpServletRequest,org.zalando.guild.api.json.fields.java.model.FieldPredicate>

public class ParamBasedPredicateFunction
extends Object
implements com.google.common.base.Function<javax.servlet.http.HttpServletRequest,org.zalando.guild.api.json.fields.java.model.FieldPredicate>

A Predicate Function that parses a FieldPredicate from a request parameter.

Since:

23.09.2015

Author:

Sean Patrick Floyd (sean.floyd@zalando.de)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ParamBasedPredicateFunction() Protected to allow subclassing.
protected	ParamBasedPredicateFunction(String paramName) Protected to allow subclassing.

Method Summary

Modifier and Type	Method and Description
org.zalando.guild.api.json.fields.java.model.FieldPredicate	apply(javax.servlet.http.HttpServletRequest request) Open-closed principle.
protected org.zalando.guild.api.json.fields.java.model.FieldPredicate	handleExpressionFailure(String expression, IllegalArgumentException e) If you want custom error handling for illegal expressions, override this method.
static ParamBasedPredicateFunction	paramBasedPredicateFunctionWithCustomName(String paramName) Return a Predicate Function that maps the query parameter "fields" to a FieldPredicate.
static ParamBasedPredicateFunction	paramBasedPredicateFunctionWithDefaultName() Return a Predicate Function that maps the query parameter "fields" to a FieldPredicate.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.base.Function

equals

Constructor Detail

ParamBasedPredicateFunction

protected ParamBasedPredicateFunction(String paramName)

Protected to allow subclassing.

ParamBasedPredicateFunction

protected ParamBasedPredicateFunction()

Protected to allow subclassing.

Method Detail

paramBasedPredicateFunctionWithDefaultName

@Nonnull
public static ParamBasedPredicateFunction paramBasedPredicateFunctionWithDefaultName()

Return a Predicate Function that maps the query parameter "fields" to a FieldPredicate.

paramBasedPredicateFunctionWithCustomName

@Nonnull
public static ParamBasedPredicateFunction paramBasedPredicateFunctionWithCustomName(@Nonnull
                                                                                             String paramName)

Return a Predicate Function that maps the query parameter "fields" to a FieldPredicate.

apply

@Nonnull
public final org.zalando.guild.api.json.fields.java.model.FieldPredicate apply(@Nonnull
                                                                                        javax.servlet.http.HttpServletRequest request)

Open-closed principle.

Specified by:

apply in interface com.google.common.base.Function<javax.servlet.http.HttpServletRequest,org.zalando.guild.api.json.fields.java.model.FieldPredicate>

handleExpressionFailure

@Nonnull
protected org.zalando.guild.api.json.fields.java.model.FieldPredicate handleExpressionFailure(@Nonnull
                                                                                                       String expression,
                                                                                                       @Nonnull
                                                                                                       IllegalArgumentException e)

If you want custom error handling for illegal expressions, override this method. The default behavior is to return a FieldPredicate that never matches.