org.xwiki.model.reference

Interface EntityReferenceResolver<T>

Type Parameters:

T - the object to resolve into an Entity Reference

@Role
public interface EntityReferenceResolver<T>

Resolve an Entity reference defined in a given representation into a validated EntityReference object, ie with valid values and a valid hierarchy (eg a Document reference must have a parent which is a space reference, reference values must not be null, etc).

Since:

2.2M1

Version:

$Id: b0fa8c4601bd1afdc5ea710d3126aa496cb80c9a $

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
EntityReference	resolve(T entityReferenceRepresentation, EntityType type, Object... parameters)

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

resolve

EntityReference resolve(T entityReferenceRepresentation,
                        EntityType type,
                        Object... parameters)

Parameters:

entityReferenceRepresentation - the representation of an entity reference (eg as a String)

type - the type of the Entity (Document, Space, Attachment, Wiki, etc) to resolve out of the representation

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

Returns:

the valid resolved reference as an Object