com.atlassian.confluence.search.service
Enum SpaceCategoryEnum

java.lang.Object
  extended by java.lang.Enum<SpaceCategoryEnum>
      extended by com.atlassian.confluence.search.service.SpaceCategoryEnum
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<SpaceCategoryEnum>

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

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


Enum Constant Summary
ALL
           
FAVOURITES
           
GLOBAL
           
PERSONAL
           
 
Method Summary
static SpaceCategoryEnum get(java.lang.String rep)
           
 java.lang.String getRepresentation()
           
 java.lang.String toString()
          The String representation of the enum.
static SpaceCategoryEnum valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static SpaceCategoryEnum[] 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, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

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 Detail

values

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

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

valueOf

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

getRepresentation

public java.lang.String getRepresentation()

toString

public java.lang.String toString()
The String representation of the enum.

Overrides:
toString in class java.lang.Enum<SpaceCategoryEnum>

get

public static SpaceCategoryEnum get(java.lang.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.


Copyright © 2003-2010 Atlassian. All Rights Reserved.