Package com.atlassian.confluence.search.service

Enum Class SpaceCategoryEnum

java.lang.Object

java.lang.Enum<SpaceCategoryEnum>

com.atlassian.confluence.search.service.SpaceCategoryEnum

All Implemented Interfaces:

Serializable, Comparable<SpaceCategoryEnum>, Constable

public enum SpaceCategoryEnum
extends Enum<SpaceCategoryEnum>

An enum representing the different categories of space that may be specified in a search.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL
FAVOURITES
GLOBAL
PERSONAL

Method Summary

Modifier and Type	Method	Description
static SpaceCategoryEnum	get(String rep)
String	getRepresentation()
String	toString()	The String representation of the enum.
static SpaceCategoryEnum	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SpaceCategoryEnum[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALL

public static final SpaceCategoryEnum ALL

FAVOURITES

public static final SpaceCategoryEnum FAVOURITES

GLOBAL

public static final SpaceCategoryEnum GLOBAL

PERSONAL

public static final SpaceCategoryEnum PERSONAL

Method Details

values

public static SpaceCategoryEnum[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static SpaceCategoryEnum valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getRepresentation

public String getRepresentation()

toString

public String toString()

The String representation of the enum.

Overrides:

toString in class Enum<SpaceCategoryEnum>

get

public static SpaceCategoryEnum get(String rep)

Parameters:

rep - the String representation of the enum.

Returns:

the SpaceCategoryEnum for the supplied String. Null is returned if the parameter does not map to a SpaceCategoryEnum.