Mode (Pro Macros - API 1.28.1 API)

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

All Implemented Interfaces:

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

Since:

1.26.3

Version:

$Id$

Enum Constant Summary

Enum Constants
Enum Constant Description

inline
Displays the macro in a comma separated list.

list
Displays the macro in a bullet list.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static Mode`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static Mode[]`	`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
  - inline
```
public static final Mode inline
```
    Displays the macro in a comma separated list.
  - list
```
public static final Mode list
```
    Displays the macro in a bullet list.
- Method Detail
  - values
```
public static Mode[] 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 (Mode c : Mode.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Mode 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