com.github.crob1140.confluence.spaces

Enum SpaceType

java.lang.Object

java.lang.Enum<SpaceType>

com.github.crob1140.confluence.spaces.SpaceType

All Implemented Interfaces:

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

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

This enumerable represents the possible values for the type of a Space instance.

Enum Constant Summary

Enum Constants

Enum Constant and Description
GLOBAL
PERSONAL

Method Summary

Modifier and Type	Method and Description
java.lang.String	getIdentifier() This method returns the unique identifier for the space type.
static SpaceType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SpaceType[]	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

GLOBAL

public static final SpaceType GLOBAL

PERSONAL

public static final SpaceType PERSONAL

Method Detail

values

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

Returns:

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

valueOf

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

getIdentifier

public java.lang.String getIdentifier()

This method returns the unique identifier for the space type.

Returns:

The unique identifier for the body type.