org.xwiki.component.wiki
Enum WikiComponentScope

java.lang.Object
  java.lang.Enum<WikiComponentScope>
      org.xwiki.component.wiki.WikiComponentScope

All Implemented Interfaces:

Serializable, Comparable<WikiComponentScope>

public enum WikiComponentScope
extends Enum<WikiComponentScope>

The scope of a WikiComponent, i.e. whether it's registered for the current user only, for the current wiki only, or for all the wikis.

Since:

4.3M2

Version:

$Id: 308a7ed76f9b1377483d624a9102d0a6a704a239 $

Enum Constant Summary

GLOBAL
Component registered for all wikis in a farm.

USER
Component registered for the current user only.

WIKI
Component registered for the current wiki only.

Method Summary

static WikiComponentScope	fromString(String scopeAsString) Convert between a string representation of a Macro scope and its matching enum.
static WikiComponentScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static WikiComponentScope[]	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

USER

public static final WikiComponentScope USER

Component registered for the current user only.

WIKI

public static final WikiComponentScope WIKI

Component registered for the current wiki only.

GLOBAL

public static final WikiComponentScope GLOBAL

Component registered for all wikis in a farm.

Method Detail

values

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

Returns:

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

valueOf

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

fromString

public static WikiComponentScope fromString(String scopeAsString)

Convert between a string representation of a Macro scope and its matching enum. If no matching enum is found then defaults to Wiki level visibility.

Parameters:

scopeAsString - the scope as a string

Returns:

the enum matching the scope defined as a string