org.xwiki.rendering.macro.wikibridge
Enum WikiMacroVisibility

java.lang.Object
  java.lang.Enum<WikiMacroVisibility>
      org.xwiki.rendering.macro.wikibridge.WikiMacroVisibility

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<WikiMacroVisibility>

public enum WikiMacroVisibility
extends java.lang.Enum<WikiMacroVisibility>

The visibility of a Wiki Macro, ie whether it's visible to the current user only, to the current wiki only or globally.

Since:

2.2M1

Version:

$Id$

Enum Constant Summary

GLOBAL
Macro visible for all wikis in a farm.

USER
Macro visible only by the current user.

WIKI
Macro visible only for the current wiki.

Method Summary

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

Macro visible only by the current user.

WIKI

public static final WikiMacroVisibility WIKI

Macro visible only for the current wiki.

GLOBAL

public static final WikiMacroVisibility GLOBAL

Macro visible for all wikis in a farm.

Method Detail

values

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

Returns:

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

valueOf

public static WikiMacroVisibility valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

fromString

public static WikiMacroVisibility fromString(java.lang.String visibilityAsString)

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

Parameters:

visibilityAsString - the visibility as a string

Returns:

the enum matching the visibility defined as a string