Package org.xwiki.user.group

Enum WikiTarget

java.lang.Object

java.lang.Enum<WikiTarget>

org.xwiki.user.group.WikiTarget

All Implemented Interfaces:

Serializable, Comparable<WikiTarget>

public enum WikiTarget
extends Enum<WikiTarget>

The wikis where to search.

Since:

10.8RC1

Version:

$Id: a1908d7061c125f437adde64a73f691779a4439b $

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Search in all wikis.
ENTITY	Search in the entity's wiki only.
ENTITY_AND_CURRENT	Search in the entity's wiki and the current wiki.

Method Summary

Modifier and Type	Method	Description
static WikiTarget	valueOf(String name)	Returns the enum constant of this type with the specified name.
static WikiTarget[]	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 WikiTarget ENTITY

Search in the entity's wiki only.

ENTITY_AND_CURRENT

public static final WikiTarget ENTITY_AND_CURRENT

Search in the entity's wiki and the current wiki.

ALL

public static final WikiTarget ALL

Search in all wikis.

Method Detail

values

public static WikiTarget[] 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 (WikiTarget c : WikiTarget.values())
    System.out.println(c);

Returns:

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

valueOf

public static WikiTarget 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