Package org.xwiki.rendering.listener.reference

Class ResourceType

java.lang.Object
org.xwiki.rendering.listener.reference.ResourceType
public class ResourceType extends Object
The Resource type. It can be one of:
  • document ("doc")
  • space ("space")
  • URL ("url")
  • document in another wiki (interwiki) ("interwiki")
  • relative URL ("path")
  • mail ("mailto")
  • attachment ("attach")
  • UNC path ("unc")
  • User ("user")
  • Data URI image ("data")
Since:
2.5RC1
Version:
$Id: f589c12267861d150bdd2436c4de9411014d8e85 $

  • Field Details

    • UNKNOWN

      public static final ResourceType UNKNOWN
      Special type to be used when the type of the resource is not known.

    • DOCUMENT

      public static final ResourceType DOCUMENT
      Represents a Document.

    • PAGE

      public static final ResourceType PAGE
      Represents a Page.
      Since:
      10.6RC1

    • SPACE

      public static final ResourceType SPACE
      Represents a Space.

    • URL

      public static final ResourceType URL
      Represents an URL.

    • INTERWIKI

      public static final ResourceType INTERWIKI
      Represents a document in another wiki.

    • PATH

      public static final ResourceType PATH
      Represents a relative URL in the current wiki.

    • MAILTO

      public static final ResourceType MAILTO
      Represents a mail.

    • ATTACHMENT

      public static final ResourceType ATTACHMENT
      Represents an attachment of a document.

    • PAGE_ATTACHMENT

      public static final ResourceType PAGE_ATTACHMENT
      Represents an attachment of a page.
      Since:
      13.10.5, 14.3RC1

    • ICON

      public static final ResourceType ICON
      Represents an icon.

    • UNC

      public static final ResourceType UNC
      Represents a UNC (Universal Naming Convention) (eg "\\myserver\myshare\mydoc.txt").
      Since:
      2.7M1

    • USER

      public static final ResourceType USER
      Represents a user.
      Since:
      5.3M2

    • DATA

      public static final ResourceType DATA
      Represents a image specified as a Data URI.
      Since:
      5.4RC1

  • Constructor Details

    • ResourceType

      public ResourceType(String scheme)
      Parameters:
      scheme - see getScheme()

  • Method Details

    • getScheme

      public String getScheme()
      Returns:
      the type of the link (eg "doc" for links to documents, etc)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object object)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object