jetbrains.buildServer.agent

Enum BuildParameterPolicy

java.lang.Object

java.lang.Enum<BuildParameterPolicy>

jetbrains.buildServer.agent.BuildParameterPolicy

All Implemented Interfaces:

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

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

Defines the way to transfer build parameter to the build That is build runner implementation where it's decided weather build parameter is transferred to the build process explicitly. All build system properties will be persisted the the build parameters file. Path to that file is set to AgentRuntimeProperties.AGENT_BUILD_PARAMS_FILE_PROP build system property

Since:

4.0

Author:

Eugene Petrenko

Enum Constant Summary

Enum Constants

Enum Constant and Description
FILE This parameter may not be transferred to the build.
MANDATORY This parameter is expected to be transferred to the build explicitly

Method Summary

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

MANDATORY

public static final BuildParameterPolicy MANDATORY

This parameter is expected to be transferred to the build explicitly

FILE

public static final BuildParameterPolicy FILE

This parameter may not be transferred to the build. Parameters are saved to properties file. Path to that file is set to AgentRuntimeProperties.AGENT_BUILD_PARAMS_FILE_PROP

Method Detail

values

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

Returns:

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

valueOf

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