org.xwiki.url
Interface XWikiURLFactory<T,U extends XWikiURL>

Type Parameters:

T - the object to transform into a XWiki URL

U - the return type (e.g. XWikiURL, XWikiEntityURL, etc)

@Role
@Unstable
public interface XWikiURLFactory<T,U extends XWikiURL>

Transforms some representation of an XWiki URL into a XWikiURL instance.

Version:

$Id: 7a21623b3b4e727d6c3708aa0719b05a034a0e94 $

Field Summary

static ParameterizedType

TYPE_URL_XWIKIURL Type instance for XWikiURLFactory<URL, XWikiURL>.

Method Summary

U	createURL(T urlRepresentation, Map<String,Object> parameters) Transforms some representation of a XWiki URL into a XWikiURL instance.

Field Detail

TYPE_URL_XWIKIURL

static final ParameterizedType TYPE_URL_XWIKIURL

Type instance for XWikiURLFactory<URL, XWikiURL>.

Method Detail

createURL

U createURL(T urlRepresentation,
            Map<String,Object> parameters)
                             throws URLCreationException,
                                    UnsupportedURLException

Transforms some representation of a XWiki URL into a XWikiURL instance.

Parameters:

urlRepresentation - the object to transform into a XWikiURL 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 XWikiURL instance

Throws:

URLCreationException - if there was an error while creating the XWiki URL object

UnsupportedURLException - if the passed URL points to an unsupported URL type that we cannot parse