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

Class WebQueryEnumOrdinalPlugin

java.lang.Object

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

All Implemented Interfaces:

WebQueryDecodePlugin

public class WebQueryEnumOrdinalPlugin
extends Object
implements WebQueryDecodePlugin

Nested Class Summary

Nested classes/interfaces inherited from interface com.peterphi.std.guice.restclient.jaxb.webquery.plugin.WebQueryDecodePlugin

WebQueryDecodePlugin.Builder

Constructor Summary

Constructors

Constructor	Description
WebQueryEnumOrdinalPlugin(String key, Class<? extends Enum> clazz)

Method Summary

Modifier and Type	Method	Description
boolean	handles(String key)	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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.peterphi.std.guice.restclient.jaxb.webquery.plugin.WebQueryDecodePlugin

handles

Constructor Details

WebQueryEnumOrdinalPlugin

public WebQueryEnumOrdinalPlugin(String key,
 Class<? extends Enum> clazz)

Method Details

handles

public boolean handles(String key)

Description copied from interface: WebQueryDecodePlugin

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 WebQueryDecodePlugin.handles(String, List)

Specified by:

handles in interface WebQueryDecodePlugin

Parameters:

key - the query string key

Returns:

true if this plugin should handle the named key

process

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

Description copied from interface: WebQueryDecodePlugin

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

Specified by:

process in interface WebQueryDecodePlugin

Parameters:

query - the WebQuery being constructed

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

values - the values provided at the query string