org.xwiki.model.reference

Interface PageObjectReferenceResolver<T>

Type Parameters:

T - the type of the representation (e.g. a String)

@Role
 @Unstable
public interface PageObjectReferenceResolver<T>

Resolve an Object reference defined in a given representation into a validated PageObjectReference object, i.e. with valid values and a valid hierarchy (e.g. an Object reference must have a parent which is a document reference, reference values must not be null, etc).

Since:

10.6RC1

Version:

$Id: 38897305b094edeb304c37aa8712c07652b31373 $

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
PageObjectReference	resolve(T objectReferenceRepresentation, Object... parameters)

Field Detail

TYPE_STRING

static final ParameterizedType TYPE_STRING

Type instance for PageObjectReferenceResolver<String>.

TYPE_REFERENCE

static final ParameterizedType TYPE_REFERENCE

Type instance for PageObjectReferenceResolver<EntityReference>.

Method Detail

resolve

PageObjectReference resolve(T objectReferenceRepresentation,
                            Object... parameters)

Parameters:

objectReferenceRepresentation - the representation of an object reference (e.g. as a String)

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

Returns:

the valid resolved object reference as an object