Package com.adobe.granite.rest.converter.siren

Class AbstractSirenConverter

java.lang.Object

com.adobe.granite.rest.converter.siren.AbstractSirenConverter

All Implemented Interfaces:

ResourceConverter<Entity>

Direct Known Subclasses:

AbstractPageableSirenConverter

public abstract class AbstractSirenConverter
extends Object
implements ResourceConverter<Entity>

AbtractConverter is a base implementation of ResourceConverter. ResourceConverter implementations are encouraged to extend from this abstract base class.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREFIX_SRN	SIREN properties prefix
static final String	REL_CHILD	Relation attribute name "child".
static final String	REL_CONTENT	Relation attribute name "content".
static final String	REL_NEXT	Relation attribute name "next".
static final String	REL_PARENT	Relation attribute name "parent".
static final String	REL_PREV	Relation attribute name "prev".
static final String	REL_SELF	Relation attribute name "self".

Constructor Summary

Constructors

Constructor	Description
AbstractSirenConverter(Resource resource)

Method Summary

Modifier and Type	Method	Description
Entity	toEntity(ResourceConverterContext context)	Converts a resource into an object of type T to represent an entity.
Entity	toSubEntity(ResourceConverterContext context)	Converts a resource to an object of type T to represent a sub-entity.

Methods inherited from class java.lang.Object

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

Field Details

PREFIX_SRN

public static final String PREFIX_SRN

SIREN properties prefix

See Also:

• Constant Field Values

REL_SELF

public static final String REL_SELF

Relation attribute name "self".

See Also:

• Constant Field Values

REL_CHILD

public static final String REL_CHILD

Relation attribute name "child".

See Also:

• Constant Field Values

REL_CONTENT

public static final String REL_CONTENT

Relation attribute name "content".

See Also:

• Constant Field Values

REL_NEXT

public static final String REL_NEXT

Relation attribute name "next".

See Also:

• Constant Field Values

REL_PREV

public static final String REL_PREV

Relation attribute name "prev".

See Also:

• Constant Field Values

REL_PARENT

public static final String REL_PARENT

Relation attribute name "parent".

See Also:

• Constant Field Values

Constructor Details

AbstractSirenConverter

public AbstractSirenConverter(Resource resource)

Method Details

toEntity

public Entity toEntity(ResourceConverterContext context)
                throws ResourceConverterException

Converts a resource into an object of type T to represent an entity.

Specified by:

toEntity in interface ResourceConverter<Entity>

Parameters:

context - Converter context

Returns:

Converted object of type T

Throws:

ResourceConverterException - if an error occurs during conversion

toSubEntity

public Entity toSubEntity(ResourceConverterContext context)
                   throws ResourceConverterException

Description copied from interface: ResourceConverter

Converts a resource to an object of type T to represent a sub-entity. The sub-entity might only contain a subset of information and might be used to represent child elements of a collection.

Specified by:

toSubEntity in interface ResourceConverter<Entity>

Parameters:

context - Converter context

Returns:

Converted sub-object of type T

Throws:

ResourceConverterException - if an error occurs during conversion