org.xwiki.url
Enum XWikiURLType

java.lang.Object
  java.lang.Enum<XWikiURLType>
      org.xwiki.url.XWikiURLType

All Implemented Interfaces:

Serializable, Comparable<XWikiURLType>

public enum XWikiURLType
extends Enum<XWikiURLType>

Represents a type of XWiki URL (URL to an Entity, URL to a skin file, etc).

Since:

2.0M1

Version:

$Id$

Enum Constant Summary

ENTITY

RESOURCE

SKIN

TEMPLATE

Method Summary

static XWikiURLType	valueOf(String name) Returns the enum constant of this type with the specified name.
static XWikiURLType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ENTITY

public static final XWikiURLType ENTITY

SKIN

public static final XWikiURLType SKIN

TEMPLATE

public static final XWikiURLType TEMPLATE

RESOURCE

public static final XWikiURLType RESOURCE

Method Detail

values

public static XWikiURLType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (XWikiURLType c : XWikiURLType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static XWikiURLType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null