com.buildforge.services.common.dbo
Enum EnvironmentEntryDBO.Action
java.lang.Object
java.lang.Enum<EnvironmentEntryDBO.Action>
com.buildforge.services.common.dbo.EnvironmentEntryDBO.Action
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Comparable<EnvironmentEntryDBO.Action>
- Enclosing class:
- EnvironmentEntryDBO
public static enum EnvironmentEntryDBO.Action
- extends java.lang.Enum<EnvironmentEntryDBO.Action>
Identifies what action is taken when an environment entry is
applied. The interpretation is as follows:
Value | Meaning |
SET | The variable is set to new value,
overwriting any previous setting for it. |
SET_IF_NOT_SET | Like SET , but ignored
if the variable already has a non-empty setting. |
APPEND | The variable is treated as a PATH-style
environment variable in system-dependent format. If the variable
is unset or blank, this behaves like SET . Otherwise, the
previous value is retained, and a path separator and the new
value are added to the end of the variable. |
PREPEND | The variable is treated as a PATH-style
environment variable in system-dependent format. If the variable
is unset or blank, this behaves like SET . Otherwise, the
previous value is retained, and the new value and a path separator
are added to the beginning of the variable. |
CLEAR | The variable is set to an empty string
(the specified value is ignored). This is exactly equivilant to
using SET with a blank value specified. |
UNSET | The variable is deleted (the specified
value is ignored). |
HIDDEN | Like SET , but the value is
not reported when the setting takes effect. This is intended
for use with variables that define sensitive information, such as
passwords, that are required by the build process. |
Methods inherited from class java.lang.Enum |
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
Methods inherited from class java.lang.Object |
getClass, notify, notifyAll, wait, wait, wait |
SET
public static final EnvironmentEntryDBO.Action SET
SET_IF_NOT_SET
public static final EnvironmentEntryDBO.Action SET_IF_NOT_SET
APPEND
public static final EnvironmentEntryDBO.Action APPEND
PREPEND
public static final EnvironmentEntryDBO.Action PREPEND
CLEAR
public static final EnvironmentEntryDBO.Action CLEAR
UNSET
public static final EnvironmentEntryDBO.Action UNSET
HIDDEN
public static final EnvironmentEntryDBO.Action HIDDEN
CLASS
public static final java.lang.Class<EnvironmentEntryDBO.Action> CLASS
code
public final char code
values
public static final EnvironmentEntryDBO.Action[] values()
- Returns an array containing the constants of this enum type, in
the order they're declared. This method may be used to iterate
over the constants as follows:
for(EnvironmentEntryDBO.Action c : EnvironmentEntryDBO.Action.values())
System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in
the order they're declared
valueOf
public static EnvironmentEntryDBO.Action 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
fromDB
public static EnvironmentEntryDBO.Action fromDB(char code)
fromObject
public static EnvironmentEntryDBO.Action fromObject(java.lang.Object o)
throws APIException
- Throws:
APIException