org.apache.stanbol.enhancer.engines.geonames.impl

Class RequestProperty

java.lang.Object

org.apache.stanbol.enhancer.engines.geonames.impl.RequestProperty

public class RequestProperty
extends Object

Defines information for a Property of an GET or POST request such as the name, required or optional, default values and a list of possible values.

This class is intended to allow to define meta data about a used web service (e.g. within an Enumeration)

Author:

Rupert Westenthaler

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RequestProperty(String name, boolean required, String defaultValue, String... valueList) Constructs a Property definition for a (RESTful) web service.

Method Summary

Modifier and Type	Method and Description
boolean	allowedValue(String value)
String	defaultValue()
boolean	encode(StringBuilder requestString, boolean first, Collection<String> values) Encodes the Property for the given parameters.
String	getName()
Set<String>	getValueList()
boolean	hasDefault()
boolean	hasValueList()
boolean	isOptional()
boolean	isRequired()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestProperty

protected RequestProperty(String name,
                          boolean required,
                          String defaultValue,
                          String... valueList)

Constructs a Property definition for a (RESTful) web service.

Parameters:

name - the name of the property (MUST NOT be null)

required - defines if the property is optional or required

defaultValue - the value used if this parameter is not parsed. null indicates no default configuration.

valueList - the list of allowed values for this parameter. null or an empty array indicate that there are no restrictions on possible values.

Method Detail

getName

public String getName()

hasDefault

public boolean hasDefault()

defaultValue

public String defaultValue()

hasValueList

public boolean hasValueList()

allowedValue

public boolean allowedValue(String value)

getValueList

public Set<String> getValueList()

isRequired

public boolean isRequired()

isOptional

public boolean isOptional()

encode

public boolean encode(StringBuilder requestString,
                      boolean first,
                      Collection<String> values)

Encodes the Property for the given parameters.

Parameters:

requestString - The string builder used to create the request

first - if the property is the first property added to the request

values - the value(s) for the property. If null or an empty list, than the defaultValue() is added if present. Also if the parsed collection contains the null value the defaultValue() is added instead.

Returns:

true if the parsed request string was modified as a result of this call - meaning that parameter was added to the request.

toString

public String toString()

Overrides:

toString in class Object