org.xwiki.resource

Interface ResourceReferenceResolver<T>

Type Parameters:

T - the object to transform into a XWiki Resource Reference

@Role
public interface ResourceReferenceResolver<T>

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

Since:

6.1M2

Version:

$Id: 66ec3f0ee6922b8e682ca8f1f6642fb359187e7d $

Method Summary

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

Method Detail

resolve

ResourceReference resolve(T representation,
                          ResourceType resourceType,
                          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

resourceType - the type of Resource represented by the passed representation parameter. To get this type you can use a ResourceTypeResolver

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

Since:

7.1M1