com.atlassian.gadgets.directory

Enum Directory.EntryScope

java.lang.Object

java.lang.Enum<Directory.EntryScope>

com.atlassian.gadgets.directory.Directory.EntryScope

All Implemented Interfaces:

Serializable, Comparable<Directory.EntryScope>

Enclosing interface:

Directory

public static enum Directory.EntryScope
extends Enum<Directory.EntryScope>

This scope is used to determine entries that get retrieved when Directory.getEntries(com.atlassian.gadgets.GadgetRequestContext, com.atlassian.gadgets.directory.Directory.EntryScope) is called. The reason behind scoping is it is faster to retrieve local entries.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL
EXTERNAL
LOCAL

Method Summary

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

ALL

public static final Directory.EntryScope ALL

LOCAL

public static final Directory.EntryScope LOCAL

EXTERNAL

public static final Directory.EntryScope EXTERNAL

Method Detail

values

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

Returns:

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

valueOf

public static Directory.EntryScope 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