org.xwiki.model.reference

Interface EntityReferenceSerializer<T>

Type Parameters:

T - the type of the new representation

@Role
public interface EntityReferenceSerializer<T>

Generate a different representation of an Entity Reference (eg as a String).

Since:

2.2M1

Version:

$Id: cddba2459ddd16b8e2ebe6d951b716720f2f33bf $

Field Summary

Fields

Modifier and Type	Field and Description
static ParameterizedType	TYPE_REFERENCE Type instance for EntityReferenceResolver<EntityReference>.
static ParameterizedType	TYPE_STRING Type instance for EntityReferenceResolver<String>.

Method Summary

Modifier and Type	Method and Description
T	serialize(EntityReference reference, Object... parameters) Serialize an entity reference into a new representation of type T.

Field Detail

TYPE_STRING

static final ParameterizedType TYPE_STRING

Type instance for EntityReferenceResolver<String>.

Since:

4.0M1

TYPE_REFERENCE

static final ParameterizedType TYPE_REFERENCE

Type instance for EntityReferenceResolver<EntityReference>.

Since:

4.0M1

Method Detail

serialize

T serialize(EntityReference reference,
            Object... parameters)

Serialize an entity reference into a new representation of type T.

Parameters:

reference - the reference to serialize

parameters - optional parameters. Their meaning depends on the serializer implementation

Returns:

the new representation (eg as a String)