org.xwiki.resource

Interface ResourceReferenceResolver<T>

Type Parameters:

T - the object to transform into a XWiki Resource Reference

@Role
@Unstable
public interface ResourceReferenceResolver<T>

Transforms some representation of an XWiki Resource Reference (aka a URI) into a ResourceReference instance.

Since:

6.1M2

Version:

$Id: 7d4a7440d96f3443937875ae39084af01cd5d525 $

Field Summary

Fields

Modifier and Type	Field and Description
static ParameterizedType	TYPE_URL Type instance for ResourceReferenceResolver<URL>.

Method Summary

Methods

Modifier and Type	Method and Description
ResourceReference	resolve(T representation, Map<String,Object> parameters) Transforms some representation of a XWiki Resource Reference into a ResourceReference instance.

Field Detail

TYPE_URL

static final ParameterizedType TYPE_URL

Type instance for ResourceReferenceResolver<URL>.

Method Detail

resolve

ResourceReference resolve(T representation,
                        Map<String,Object> parameters)
                          throws CreateResourceReferenceException,
                                 UnsupportedResourceReferenceException

Transforms some representation of a XWiki Resource Reference into a ResourceReference instance.

Parameters:

representation - the object to transform into a ResourceReference instance

parameters - generic parameters that depend on the underlying implementation. In order to know what to pass you need to check the documentation for the implementation you're using.

Returns:

the ResourceReference instance

Throws:

CreateResourceReferenceException - if there was an error while creating the XWiki Resource object

UnsupportedResourceReferenceException - if the passed representation points to an unsupported Resource Reference type that we don't know how to resolve