Package com.xwiki.macros.viewfile.macro

Enum ViewFileDisplay

java.lang.Object

java.lang.Enum<ViewFileDisplay>

com.xwiki.macros.viewfile.macro.ViewFileDisplay

All Implemented Interfaces:

Serializable, Comparable<ViewFileDisplay>

public enum ViewFileDisplay
extends Enum<ViewFileDisplay>

Enum for the display propert of ViewFileMacro.

Since:

1.27

Version:

$Id$

Enum Constant Summary

Enum Constants

Enum Constant	Description
button	Button.
full	Full.
thumbnail	Thumbnail.

Method Summary

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

thumbnail

public static final ViewFileDisplay thumbnail

Thumbnail.

button

public static final ViewFileDisplay button

Button.

full

public static final ViewFileDisplay full

Full.

Method Detail

values

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

Returns:

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

valueOf

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

forName

public static ViewFileDisplay forName(String name)

Parameters:

name - the name of a display type.

Returns:

the display type corresponding to the name, or null.