org.xwiki.model.reference

Interface ObjectReferenceResolver<T>

Type Parameters:

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

@Role
public interface ObjectReferenceResolver<T>

Resolve an Object reference defined in a given representation into a validated ObjectReference 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:

2.3M1

Version:

$Id: 9f7aa78acdac4dc6aa8a7173a663a2b539fa04c0 $

Field Summary

Fields

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

Method Summary

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

Field Detail

TYPE_STRING

static final ParameterizedType TYPE_STRING

Type instance for ObjectReferenceResolver<String>.

Since:

4.0M1

TYPE_REFERENCE

static final ParameterizedType TYPE_REFERENCE

Type instance for ObjectReferenceResolver<EntityReference>.

Since:

4.0M1

Method Detail

resolve

@Deprecated
ObjectReference resolve(T objectReferenceRepresentation)

Deprecated.

Parameters:

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

Returns:

the valid resolved object reference as an object

resolve

ObjectReference 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

Since:

3.3M2