Package com.peterphi.std.guice.restclient.jaxb.webquery.plugin

Interface WebQueryDecodePlugin

All Known Implementing Classes:

WebQueryEnumOrdinalPlugin, WebQueryPresetPlugin

public interface WebQueryDecodePlugin

Defines a plugin that extends the functionality of the WebQuery Query String Decode functionality

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	WebQueryDecodePlugin.Builder

Method Summary

Modifier and Type	Method	Description
boolean	handles(String key)	Called before the native WebQuery.decode handles the provided key.
default boolean	handles(String key, List<String> values)	Called before the native WebQuery.decode handles the provided key.
void	process(WebQuery query, String key, List<String> values)	Called to request that the plugin add the appropriate constraints to query

Method Details

handles

default boolean handles(String key,
 List<String> values)

Called before the native WebQuery.decode handles the provided key. If this method returns true the plugin is responsible for decoding/processing the key.

Parameters:

key - the query string key

Returns:

true if this plugin should handle the named key

handles

boolean handles(String key)

Called before the native WebQuery.decode handles the provided key. If this method returns true the plugin is responsible for decoding/processing the key. Simple convenience method so implementors do not need to implement handles(String, List)

Parameters:

key - the query string key

Returns:

true if this plugin should handle the named key

process

void process(WebQuery query,
 String key,
 List<String> values)

Called to request that the plugin add the appropriate constraints to query

Parameters:

query - the WebQuery being constructed

key - the key (which this object has previously indicated that it handles(String))

values - the values provided at the query string