Package org.xwiki.model.reference

Interface DocumentReferenceResolver<T>

Type Parameters:

T - the type of the representation (eg a String)

@Role
public interface DocumentReferenceResolver<T>

Resolve a Document reference defined in a given representation into a validated DocumentReference 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: 9f05d31756968aa703e575c2826f30f1819e9754 $

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
DocumentReference	resolve(T documentReferenceRepresentation, Object... parameters)

Field Detail

TYPE_STRING

static final ParameterizedType TYPE_STRING

Type instance for DocumentReferenceResolver<String>.

Since:

4.0M1

TYPE_REFERENCE

static final ParameterizedType TYPE_REFERENCE

Type instance for DocumentReferenceResolver<EntityReference>.

Since:

4.0M1

TYPE_PAGEREFERENCE

static final ParameterizedType TYPE_PAGEREFERENCE

Type instance for DocumentReferenceResolver<PageReference>.

Since:

15.0RC1, 14.10.2

Method Detail

resolve

DocumentReference resolve(T documentReferenceRepresentation,
                          Object... parameters)

Parameters:

documentReferenceRepresentation - the representation of a document reference (eg as a String)

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

Returns:

the valid resolved document reference as an Object