org.jenkinsci.plugins.docker.traceability.model

Enum DockerEventType

java.lang.Object

java.lang.Enum<DockerEventType>

org.jenkinsci.plugins.docker.traceability.model.DockerEventType

All Implemented Interfaces:

Serializable, Comparable<DockerEventType>

@ExportedBean
public enum DockerEventType
extends Enum<DockerEventType>

Describes types of DockerEvents. Enum contains all events from Docker API v.1.16

Since:

1.0

Author:

Oleg Nenashev

Enum Constant Summary

Enum Constants

Enum Constant and Description
CREATE Container has been created.
DELETE
DESTROY
DIE Container has been terminated.
EXPORT
INSPECT_CONTAINER Inspect reports (just to update statuses).
KILL
NONE Indicates there's no event.
PAUSE
RESTART
START Container has been started.
STOP
UNKNOWN Unknown (unregistered) event.
UNPAUSE
UNTAG

Method Summary

Methods

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

CREATE

public static final DockerEventType CREATE

Container has been created.

START

public static final DockerEventType START

Container has been started.

DIE

public static final DockerEventType DIE

Container has been terminated.

INSPECT_CONTAINER

public static final DockerEventType INSPECT_CONTAINER

Inspect reports (just to update statuses).

DESTROY

public static final DockerEventType DESTROY

EXPORT

public static final DockerEventType EXPORT

KILL

public static final DockerEventType KILL

PAUSE

public static final DockerEventType PAUSE

RESTART

public static final DockerEventType RESTART

STOP

public static final DockerEventType STOP

UNPAUSE

public static final DockerEventType UNPAUSE

UNTAG

public static final DockerEventType UNTAG

DELETE

public static final DockerEventType DELETE

NONE

public static final DockerEventType NONE

Indicates there's no event. This event type is being used to update statuses w/o changing the statuses.

UNKNOWN

public static final DockerEventType UNKNOWN

Unknown (unregistered) event. Users should not rely on this type in their custom logic, because unknown events may be registered in the enum at some point. In DockerEvent class DockerEvent.getEventTypeStr() should be used in such case.

Method Detail

values

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

Returns:

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

valueOf

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

fromString

@Nonnull
public static DockerEventType fromString(@CheckForNull
                                 String str)

isContainerEvent

public boolean isContainerEvent()

Returns:

true for container events. Also returns true for UNKNOWN

isImageEvent

public boolean isImageEvent()