com.damnhandy.uri.template

Class DefaultVarExploder

java.lang.Object

com.damnhandy.uri.template.DefaultVarExploder

All Implemented Interfaces:

VarExploder

public class DefaultVarExploder
extends Object
implements VarExploder

The DefaultVarExploder is a VarExploder implementation that takes in a Java object and extracts the properties for use in a URI Template. Given the following URI expression:

 /mapper{?address*}
 

And this Java object for an address:

 Address address = new Address();
 address.setState("CA");
 address.setCity("Newport Beach");
 String result = UriTemplate.fromTemplate("/mapper{?address*}").set("address", address).expand();
 

The expanded URI will be:

 /mapper?city=Newport%20Beach&state=CA
 

The DefaultVarExploder breaks down the object properties as follows:

• All properties that contain a non-null return value will be included
• Getters or fields annotated with UriTransient will NOT included in the list
• By default, the property name is used as the label in the URI. This can be overridden by placing the VarName annotation on the field or getter method and specifying a name.
• Field level annotation take priority of getter annotations

Since:

1.0

Version:

$Revision: 1.1 $

Author:

Ryan J. McDonough

See Also:

VarName, UriTransient, VarExploder

Constructor Summary

Constructors

Constructor and Description
DefaultVarExploder(Object source)

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Object>	getNameValuePairs() Returns the properties of the source object a Map of name/value pairs.
Collection<Object>	getValues() Returns the properties of the source object a Collection of object values.
void	setSource(Object source)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultVarExploder

public DefaultVarExploder(Object source)

Parameters:

source - the Object to explode

Method Detail

getNameValuePairs

public Map<String,Object> getNameValuePairs()

Description copied from interface: VarExploder

Returns the properties of the source object a Map of name/value pairs.

Specified by:

getNameValuePairs in interface VarExploder

Returns:

setSource

public void setSource(Object source)

getValues

public Collection<Object> getValues()

Description copied from interface: VarExploder

Returns the properties of the source object a Collection of object values.

Specified by:

getValues in interface VarExploder

Returns: