name.pehl.piriti.commons.client

Annotation Type Mapping

@Documented
@Retention(value=RUNTIME)
@Target(value=ANNOTATION_TYPE)
public @interface Mapping

Annotation used inside Mappings to specify the mapping of one property.

Version:

$LastChangedRevision: 82 $

Author:

$LastChangedBy: harald.pehl $

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value The properties name.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends Converter<?>>	convert A custom converter which is used for the parsing and serialization of the value.
Class<? extends InstanceCreator<?,?>>	createWith Whether to use an InstanceCreator.
String	format The format to use when converting the JSON data to the properties type.
Class<? extends PropertyGetter<?,?>>	getter A custom property getter for reading the property.
boolean	native_ Wehther this property should be handled nativly.
String	path A "path" expression to select the JSON / XML data.
Class<? extends PropertySetter<?,?>>	setter A custom property setter for setting the property.
name.pehl.totoe.commons.client.WhitespaceHandling	whitespace How to handle how leading and trailing whitespace.

Element Detail

value

public abstract String value

The properties name.

path

public abstract String path

A "path" expression to select the JSON / XML data. This can be either just the key / element name or a JSONPath or XPath expression. Defaults to "" which means that the properties name is taken as a default.

Returns:

Default:

""

format

public abstract String format

The format to use when converting the JSON data to the properties type. Defaults to "".

Returns:

Default:

""

whitespace

public abstract name.pehl.totoe.commons.client.WhitespaceHandling whitespace

How to handle how leading and trailing whitespace. Please note that this does not effect whitespace within the mapped value.

Returns:

Default:

name.pehl.totoe.commons.client.WhitespaceHandling.REMOVE

createWith

public abstract Class<? extends InstanceCreator<?,?>> createWith

Whether to use an InstanceCreator.

Returns:

Default:

name.pehl.piriti.commons.client.NoopInstanceCreator.class

convert

public abstract Class<? extends Converter<?>> convert

A custom converter which is used for the parsing and serialization of the value. Defaults to NoopConverter which means no custom converter should be used.

Returns:

Default:

name.pehl.piriti.converter.client.NoopConverter.class

getter

public abstract Class<? extends PropertyGetter<?,?>> getter

A custom property getter for reading the property. Defaults to NoopPropertyGetter which means that the property is read using the field or a getter.

Returns:

Default:

name.pehl.piriti.property.client.NoopPropertyGetter.class

setter

public abstract Class<? extends PropertySetter<?,?>> setter

A custom property setter for setting the property. Defaults to NoopPropertySetter which means that the property is set using the field or a setter.

Returns:

Default:

name.pehl.piriti.property.client.NoopPropertySetter.class

native_

public abstract boolean native_

Wehther this property should be handled nativly.

Returns:

Default:

false