info.magnolia.module.blossom.annotation
Enum AreaType

java.lang.Object
  java.lang.Enum<AreaType>
      info.magnolia.module.blossom.annotation.AreaType

All Implemented Interfaces:

Serializable, Comparable<AreaType>

public enum AreaType
extends Enum<AreaType>

Enumeration of area types.

• NO_COMPONENT The area does not have any components within it
• LIST The area can have zero or more components within it
• SINGLE The area can have zero or one component within it

Since:

2.0

See Also:

Area

Enum Constant Summary

LIST

NO_COMPONENT

SINGLE

Method Summary

String	getDefinitionFormat()
static AreaType	valueOf(String name) Returns the enum constant of this type with the specified name.
static AreaType[]	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

NO_COMPONENT

public static final AreaType NO_COMPONENT

LIST

public static final AreaType LIST

SINGLE

public static final AreaType SINGLE

Method Detail

values

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

Returns:

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

valueOf

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

getDefinitionFormat

public String getDefinitionFormat()