org.xwiki.resource

Interface ResourceReferenceSerializer<T extends ResourceReference,U>

Type Parameters:

T - the type of the resource reference to serialize

U - the return type (e.g. a URL, a String, etc)

@Role
@Unstable
public interface ResourceReferenceSerializer<T extends ResourceReference,U>

Transforms a Resource Reference into some other representation (eg URL).

Since:

6.1M2

Version:

$Id: c7d932249be8f0540faa3ec8eb3bce8d2fe35be3 $

Method Summary

Methods

Modifier and Type	Method and Description
U	serialize(T resource) Transforms a Resource Reference into some other representation.

Method Detail

serialize

U serialize(T resource)
            throws SerializeResourceReferenceException,
                   UnsupportedResourceReferenceException

Transforms a Resource Reference into some other representation.

Parameters:

resource - the Resource Reference to transform

Returns:

the new representation

Throws:

SerializeResourceReferenceException - if there was an error while serializing the XWiki Resource object

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