Package com.google.gerrit.extensions.annotations

Enum Class CapabilityScope

java.lang.Object

java.lang.Enum<CapabilityScope>

com.google.gerrit.extensions.annotations.CapabilityScope

All Implemented Interfaces:

Serializable, Comparable<CapabilityScope>, java.lang.constant.Constable

public enum CapabilityScope
extends Enum<CapabilityScope>

Declared scope of a capability named by RequiresCapability.

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
CONTEXT	Scope is assumed based on the context.
CORE	Scope is the core server.
PLUGIN	Scope is only the plugin.

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CONTEXT

public static final CapabilityScope CONTEXT

Scope is assumed based on the context.

When @RequiresCapability is used within a plugin the scope of the capability is assumed to be that plugin.

If @RequiresCapability is used within the core Gerrit Code Review server (and thus is outside of a plugin) the scope is the core server and will use com.google.gerrit.common.data.GlobalCapability.

PLUGIN

public static final CapabilityScope PLUGIN

Scope is only the plugin.

CORE

public static final CapabilityScope CORE

Scope is the core server.

Method Details

values

public static CapabilityScope[] 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 CapabilityScope 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