org.xwiki.url

Interface XWikiURL

All Known Implementing Classes:

AbstractXWikiURL, XWikiEntityURL

public interface XWikiURL

Represents a XWiki URL.

Version:

$Id: 4d1080348a239dc67726a9c36ad26c9cb580304d $

Method Summary

Modifier and Type	Method and Description
void	addParameter(String name, String value)
Map<String,List<String>>	getParameters() A XWiki URL parameter provides optional additional information about the URL.
String	getParameterValue(String name)
List<String>	getParameterValues(String name)
XWikiURLType	getType()

Method Detail

getType

XWikiURLType getType()

Returns:

the type of URL (Entity URL, Attachment URL, Template URL, etc)

addParameter

void addParameter(String name,
                  String value)

Parameters:

value - the value of the parameter to add. If null then no value is added.

getParameters

Map<String,List<String>> getParameters()

A XWiki URL parameter provides optional additional information about the URL. For example these will find their way into the Query String when the XWiki URL serialized to a standard URL. Note that there can be several values for the same name (since this is allowed in URLs and we want to map a URL to a XWiki URL). Also note that the order in the map is the same as the order in the URL.

Returns:

the XWiki URL parameters

getParameterValues

List<String> getParameterValues(String name)

Parameters:

name - the parameter name for which to return the values

Returns:

all the parameter values matching the passed parameter name

getParameterValue

String getParameterValue(String name)

Parameters:

name - the parameter name for which to return the value

Returns:

the first parameter value matching the passed parameter name