Scope (Pro Macros - API 1.28.0 API)

java.lang.Object
- java.lang.Enum<Scope>
- - com.xwiki.pickers.contributors.Scope

All Implemented Interfaces:

Serializable, Comparable<Scope>
```
@Unstable
public enum Scope
extends Enum<Scope>
```
Picker for the scope parameter of the contributors macro.

Since:

1.26.3

Version:

$Id$

Enum Constant Summary

Enum Constants
Enum Constant	Description
`children`	Include direct children of the specified pages.
`descendants`	Include all children of the specified pages.
`specified`	Include only the specified pages.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static Scope`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static Scope[]`	`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
  - children
```
public static final Scope children
```
    Include direct children of the specified pages.
  - descendants
```
public static final Scope descendants
```
    Include all children of the specified pages.
  - specified
```
public static final Scope specified
```
    Include only the specified pages. Should be treated as blank when handling the macro to keep the backwards compatibility.
- Method Detail
  - values
```
public static Scope[] 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 (Scope c : Scope.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Scope 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