Package com.nirima.jenkins.plugins.docker

Enum DockerImagePullStrategy

java.lang.Object

java.lang.Enum<DockerImagePullStrategy>

com.nirima.jenkins.plugins.docker.DockerImagePullStrategy

All Implemented Interfaces:

Serializable, Comparable<DockerImagePullStrategy>

public enum DockerImagePullStrategy
extends Enum<DockerImagePullStrategy>

Author:

Kanstantsin Shautsou

Enum Constant Summary

Enum Constants

Enum Constant	Description
PULL_ALWAYS
PULL_LATEST
PULL_NEVER

Method Summary

Modifier and Type	Method	Description
String	getDescription()
abstract boolean	pullIfExists(String imageName)
abstract boolean	pullIfNotExists(String imageName)
boolean	shouldPullImage(com.github.dockerjava.api.DockerClient client, String image)
static DockerImagePullStrategy	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DockerImagePullStrategy[]	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

PULL_ALWAYS

public static final DockerImagePullStrategy PULL_ALWAYS

PULL_LATEST

public static final DockerImagePullStrategy PULL_LATEST

PULL_NEVER

public static final DockerImagePullStrategy PULL_NEVER

Method Detail

values

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

Returns:

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

valueOf

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

getDescription

public String getDescription()

pullIfNotExists

public abstract boolean pullIfNotExists(String imageName)

pullIfExists

public abstract boolean pullIfExists(String imageName)

shouldPullImage

public boolean shouldPullImage(com.github.dockerjava.api.DockerClient client,
                               String image)