io.sphere.sdk.annotations

Annotation Type PropertySpec

@Retention(value=CLASS)
public @interface PropertySpec

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name
Class<?>	type The type for the field.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	docLinkTaglet
boolean	isOptional
String	jsonName
boolean	useReference

Element Detail

type

public abstract Class<?> type

The type for the field. An array type will be converted to a paramaterized list type.

Returns:

the type of this property

name

public abstract String name

isOptional

public abstract boolean isOptional

Default:

false

jsonName

public abstract String jsonName

Default:

""

useReference

public abstract boolean useReference

Default:

false

docLinkTaglet

public abstract String docLinkTaglet

Default:

""