javaposse.jobdsl.plugin

Enum LookupStrategy

java.lang.Object

java.lang.Enum<LookupStrategy>

javaposse.jobdsl.plugin.LookupStrategy

All Implemented Interfaces:

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

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

A JobLookupStrategy encapsulates where a seed job will look for existing jobs and where it will create new jobs. This matters when you use relative names in a job dsl script and the seed job is in a folder.

Enum Constant Summary

Enum Constants

Enum Constant and Description
JENKINS_ROOT Using this naming strategy jobs with relative path names are absolute names.
SEED_JOB Using this naming strategy jobs with relative path names are created relative to the seed job's parent folder.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract hudson.model.ItemGroup	getContext(hudson.model.Item seedJob) Get the context in which new items should be created for the given seed job.
java.lang.String	getDisplayName()
abstract <T extends hudson.model.Item> T	getItem(hudson.model.Item seedJob, java.lang.String path, java.lang.Class<T> type) Get an item by its path name in the context of a seed job.
hudson.model.ItemGroup	getParent(hudson.model.Item seedJob, java.lang.String path) Get the parent ItemGroup of the item addressed by the given path.
static LookupStrategy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static LookupStrategy[]	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

JENKINS_ROOT

public static final LookupStrategy JENKINS_ROOT

Using this naming strategy jobs with relative path names are absolute names.

SEED_JOB

public static final LookupStrategy SEED_JOB

Using this naming strategy jobs with relative path names are created relative to the seed job's parent folder.

Method Detail

values

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

Returns:

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

valueOf

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

getItem

public abstract <T extends hudson.model.Item> T getItem(hudson.model.Item seedJob,
                                      java.lang.String path,
                                      java.lang.Class<T> type)

Get an item by its path name in the context of a seed job.

Parameters:

seedJob - the seed job

path - the path name

Returns:

the item for the given path

getContext

protected abstract hudson.model.ItemGroup getContext(hudson.model.Item seedJob)

Get the context in which new items should be created for the given seed job.

Parameters:

seedJob - a seed job

Returns:

the context

getParent

public hudson.model.ItemGroup getParent(hudson.model.Item seedJob,
                               java.lang.String path)

Get the parent ItemGroup of the item addressed by the given path.

Parameters:

seedJob - the seed job

path - path to the item for which the parent should be looked up

Returns:

parent ItemGroup of the item with the given path

getDisplayName

public java.lang.String getDisplayName()