Package org.xwiki.resource

Interface ResourceReference

  • All Known Implementing Classes:
    AbstractResourceReference
    public interface ResourceReference
    Represents a reference to an XWiki Resource (Entity Resource, Attachment Resource, Template Resource, etc).
    Since:
    6.1M2
    Version:
    $Id: b253de17710ffd9f07250904ce0f919d7e7c92d8 $

    • Method Detail

      • getType

        ResourceType getType()
        Returns:
        the type of Resource (Entity Resource, Attachment Resource, Template Resource, etc)

      • addParameter

        void addParameter​(String name,
                  Object value)
        Parameters:
        name - the name of the parameter to add
        value - the value of the parameter to add. If null then no value is added. Collections are also supported in which case a multivalued parameter is used.

      • getParameters

        Map<String,​List<String>> getParameters()
        A Resource Reference parameter provides optional additional information about the Resource Reference. For example these will find their way into the Query String when the Resource Reference is serialized to a standard URL. Note that there can be several values for the same name (since for example this is allowed in URLs and we want to map a URL to an XWiki Resource Reference). Also note that the order in the map is the same as the order in the representation when it was parsed.
        Returns:
        the Resource Reference 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