org.xwiki.url
Interface XWikiURLFactory<T>

Type Parameters:

T - the object to transform into a XWiki URL

@ComponentRole
public interface XWikiURLFactory<T>

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

Version:

$Id$

Method Summary

XWikiURL

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

Method Detail

createURL

XWikiURL createURL(T urlRepresentation,
                   java.util.Map<java.lang.String,java.lang.Object> parameters)
                   throws InvalidURLException

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:

InvalidURLException - if the input representation doesn't represent a valid XWiki URL