Package com.atlassian.bamboo.variable

Enum VariableType

java.lang.Object

java.lang.Enum<VariableType>

com.atlassian.bamboo.variable.VariableType

All Implemented Interfaces:

Serializable, Comparable<VariableType>

@PublicApi
public enum VariableType
extends Enum<VariableType>
implements Serializable

Type of Bamboo variable.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CUSTOM	Automatically defined variable
ENVIRONMENT	Variable for Deployment Environment
GLOBAL	Global variable
JOB	Deprecated. job variables are not supported
MANUAL	Manually defined variable
PLAN	Plan variable
PROJECT	Variable defined for Project
RESULT	Variable defined at build runtime, i.e.
SYSTEM	System (environment) variable
UNKNOWN
VERSION	Variable for Deployment Version

Method Summary

Modifier and Type	Method	Description
Predicate<VariableDefinitionIdentifier>	isSameType()
com.google.common.base.Predicate<VariableDefinitionIdentifier>	isTypeEqual()	Deprecated. since 7.0 use isSameType()
static VariableType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static VariableType[]	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

GLOBAL

public static final VariableType GLOBAL

Global variable

PLAN

public static final VariableType PLAN

Plan variable

JOB

@Deprecated
public static final VariableType JOB

Deprecated.

job variables are not supported

Job variable: not supported, value not removed so that int values of this enum are the same.

MANUAL

public static final VariableType MANUAL

Manually defined variable

CUSTOM

public static final VariableType CUSTOM

Automatically defined variable

SYSTEM

public static final VariableType SYSTEM

System (environment) variable

UNKNOWN

public static final VariableType UNKNOWN

ENVIRONMENT

public static final VariableType ENVIRONMENT

Variable for Deployment Environment

VERSION

public static final VariableType VERSION

Variable for Deployment Version

RESULT

public static final VariableType RESULT

Variable defined at build runtime, i.e. injected by a task.

Since:

5.7

PROJECT

public static final VariableType PROJECT

Variable defined for Project

Method Detail

values

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

Returns:

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

valueOf

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

isTypeEqual

@Deprecated
public com.google.common.base.Predicate<VariableDefinitionIdentifier> isTypeEqual()

Deprecated.

since 7.0 use isSameType()

isSameType

public Predicate<VariableDefinitionIdentifier> isSameType()