com.dtolabs.rundeck.core.plugins.configuration

Enum PropertyScope

java.lang.Object

java.lang.Enum<PropertyScope>

com.dtolabs.rundeck.core.plugins.configuration.PropertyScope

All Implemented Interfaces:

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

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

Available scopes for properties, indicating where the runtime values can be resolved from.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Framework Only framework properties
Instance Instance and all earlier levels
InstanceOnly Only instance properties
Project Project and Framework properties
ProjectOnly Only Project properties
Unspecified No specific scope specified

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isFrameworkLevel()
boolean	isInstanceLevel()
boolean	isProjectLevel()
boolean	isUnspecified()
static PropertyScope	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PropertyScope[]	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

Framework

public static final PropertyScope Framework

Only framework properties

ProjectOnly

public static final PropertyScope ProjectOnly

Only Project properties

Project

public static final PropertyScope Project

Project and Framework properties

InstanceOnly

public static final PropertyScope InstanceOnly

Only instance properties

Instance

public static final PropertyScope Instance

Instance and all earlier levels

Unspecified

public static final PropertyScope Unspecified

No specific scope specified

Method Detail

values

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

Returns:

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

valueOf

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

isUnspecified

public boolean isUnspecified()

Returns:

true if this scope is Unspecified

isInstanceLevel

public boolean isInstanceLevel()

Returns:

true if this scope encompasses Instance level properties

isProjectLevel

public boolean isProjectLevel()

Returns:

true if this scope encompasses Project level properties

isFrameworkLevel

public boolean isFrameworkLevel()

Returns:

true if this scope encompasses Framework level properties