com.buildforge.services.common.dbo
Enum EnvironmentEntryDBO.Mode
java.lang.Object
java.lang.Enum<EnvironmentEntryDBO.Mode>
com.buildforge.services.common.dbo.EnvironmentEntryDBO.Mode
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Comparable<EnvironmentEntryDBO.Mode>
- Enclosing class:
- EnvironmentEntryDBO
public static enum EnvironmentEntryDBO.Mode
- extends java.lang.Enum<EnvironmentEntryDBO.Mode>
Identifies special treatment of the variable regarding its display in
the UI and whether or not its value may be changed. It is interpreted
as follows:
Value | Meaning |
NORMAL | The variable exhibts normal behavior.
Its value is present in the start page, and users are free to
change its setting to anything they like when starting a
build. |
REQUIRED | Like NORMAL , but the value
may not be left blank. If the specified value is blank, then
builds of the project may not be quick started. |
MUST_CHANGE | Like NORMAL , but users
are not permitted to start a build without first changing the
setting. Naturally, this also prohibits quick start builds for
the project. |
READ_ONLY | Like NORMAL , but users are
not permitted to alter the value when starting a build. |
SUPPRESS_DISPLAY | The setting is not shown on
the build start page, and therefore can not be changed. This is
primarily intended for use with EnvironmentEntryDBO.Action.HIDDEN variables,
but might also be useful for other read-only settings that would
unnecessarily clutter the build start page. |
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 |
MUST_CHANGE
public static final EnvironmentEntryDBO.Mode MUST_CHANGE
NORMAL
public static final EnvironmentEntryDBO.Mode NORMAL
READ_ONLY
public static final EnvironmentEntryDBO.Mode READ_ONLY
REQUIRED
public static final EnvironmentEntryDBO.Mode REQUIRED
SUPPRESS_DISPLAY
public static final EnvironmentEntryDBO.Mode SUPPRESS_DISPLAY
CLASS
public static final java.lang.Class<EnvironmentEntryDBO.Mode> CLASS
code
public final char code
values
public static final EnvironmentEntryDBO.Mode[] 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.Mode c : EnvironmentEntryDBO.Mode.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.Mode 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.Mode fromDB(char code)
fromObject
public static EnvironmentEntryDBO.Mode fromObject(java.lang.Object o)
throws APIException
- Throws:
APIException