Package org.jenkinsci.plugins.workflow.cps.persistence

Enum PersistenceContext

java.lang.Object

java.lang.Enum<PersistenceContext>

org.jenkinsci.plugins.workflow.cps.persistence.PersistenceContext

All Implemented Interfaces:

Serializable, Comparable<PersistenceContext>

public enum PersistenceContext
extends Enum<PersistenceContext>

Author:

Kohsuke Kawaguchi

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANYWHERE	A class is a "handle" that can be serialized by anyone into a small object (via Java serialization or XStream), and upon deserialization it reconnects itself with other states persisted elsewhere.
FLOW_NODE	A class gets persisted through FlowNode (for example in action) via XStream.
JOB	A class gets persisted in the config.xml as a part of Job through XStream.
NONE	A class does not get persisted anywhere.
PROGRAM	A class gets persisted in program data file along with all the objects used in the user's CPS transformed program.
RUN	A class gets persisted in the build.xml as a part of Run through XStream.

Method Summary

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

RUN

public static final PersistenceContext RUN

A class gets persisted in the build.xml as a part of Run through XStream.

JOB

public static final PersistenceContext JOB

A class gets persisted in the config.xml as a part of Job through XStream.

ANYWHERE

public static final PersistenceContext ANYWHERE

A class is a "handle" that can be serialized by anyone into a small object (via Java serialization or XStream), and upon deserialization it reconnects itself with other states persisted elsewhere.

See Also:

StepContext

PROGRAM

public static final PersistenceContext PROGRAM

A class gets persisted in program data file along with all the objects used in the user's CPS transformed program. The persistence is through JBoss river protocol, which is a variant of Java serialization.

FLOW_NODE

public static final PersistenceContext FLOW_NODE

A class gets persisted through FlowNode (for example in action) via XStream.

NONE

public static final PersistenceContext NONE

A class does not get persisted anywhere. It's only used in memory.

Method Detail

values

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

Returns:

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

valueOf

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