com.atlassian.bamboo

Enum KeyType

java.lang.Object

java.lang.Enum<KeyType>

com.atlassian.bamboo.KeyType

All Implemented Interfaces:

Serializable, Comparable<KeyType>

public enum KeyType
extends Enum<KeyType>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	KeyType.Constants

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHAIN
CHAIN_RESULT
DEPLOYMENT
DEPLOYMENT_RESULT
JOB
JOB_RESULT
UNKNOWN

Method Summary

Modifier and Type	Method and Description
static Key	getKeyFromString(String key) Get the typed key from its string representation
static KeyType	getKeyTypeFromString(String key) Look at the provided key and work out what KeyType it is
Key	toKey(String key) Attempt to create the correct key for this KeyType with the provided key
static KeyType	valueOf(String name) Returns the enum constant of this type with the specified name.
static KeyType[]	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

CHAIN

public static final KeyType CHAIN

CHAIN_RESULT

public static final KeyType CHAIN_RESULT

DEPLOYMENT

public static final KeyType DEPLOYMENT

DEPLOYMENT_RESULT

public static final KeyType DEPLOYMENT_RESULT

JOB

public static final KeyType JOB

JOB_RESULT

public static final KeyType JOB_RESULT

UNKNOWN

public static final KeyType UNKNOWN

Method Detail

values

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

Returns:

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

valueOf

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

getKeyTypeFromString

public static KeyType getKeyTypeFromString(String key)

Look at the provided key and work out what KeyType it is

Parameters:

key - The string representation of a key

Returns:

The KeyType that matches

toKey

public Key toKey(String key)

Attempt to create the correct key for this KeyType with the provided key

Parameters:

key - The key as a string, e.g. "FOO-BAR"

Returns:

A typed key for this KeyType

getKeyFromString

public static Key getKeyFromString(String key)

Get the typed key from its string representation

Parameters:

key -

Returns: