Module com.oracle.bedrock.runtime.docker

Package com.oracle.bedrock.runtime.docker.commands

Class Remove<R extends Remove>

java.lang.Object

com.oracle.bedrock.runtime.docker.commands.AbstractDockerCommand<C>

com.oracle.bedrock.runtime.docker.commands.CommandWithArgumentList<R>

com.oracle.bedrock.runtime.docker.commands.Remove<R>

All Implemented Interfaces:

com.oracle.bedrock.runtime.MetaClass<com.oracle.bedrock.runtime.Application>

Direct Known Subclasses:

Remove.RemoveContainer, Remove.RemoveImage, Remove.RemoveLink

public abstract class Remove<R extends Remove>
extends CommandWithArgumentList<R>

A representation of the Docker rm and rmi commands to remove containers, container links and images.

Instances of Remove are immutable, methods that add options and configuration to this Remove command return a new instance of a Remove command with the modifications applied.

Copyright (c) 2016. All Rights Reserved. Oracle Corporation.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.

Author:

Jonathan Knight

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Remove.RemoveContainer	A representation of a Docker command to remove one or more containers (equates to the Docker rm command).
static class	Remove.RemoveImage	A representation of a Docker command to remove an image.
static class	Remove.RemoveLink	A representation of a Docker command to remove a link between two containers (equates to the Docker rm --link containerA/contaunerB command).

Method Summary

Modifier and Type	Method	Description
static Remove.RemoveContainer	containers(Object... names)	Create a Remove.RemoveContainer command to remove specific containers.
static Remove.RemoveContainer	containers(List<?> names)	Create a Remove.RemoveContainer command to remove specific containers.
static Remove.RemoveImage	images(Object... tags)	Create a Remove.RemoveImage command to remove specific images.
static Remove.RemoveImage	images(List<?> tags)	Create a Remove.RemoveImage command to remove specific images.
static Remove	link(String first, String second)	Create a Remove command to remove a link between two containers.

Methods inherited from class com.oracle.bedrock.runtime.docker.commands.CommandWithArgumentList

onLaunch, withCommandArguments, withCommandArguments, withoutCommandArguments, withoutCommandArguments

Methods inherited from class com.oracle.bedrock.runtime.docker.commands.AbstractDockerCommand

getCommandArguments, getImplementationClass, getTimeout, onLaunched, onLaunching, timeoutAfter, timeoutAfter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

containers

public static Remove.RemoveContainer containers(Object... names)

Create a Remove.RemoveContainer command to remove specific containers.

Parameters:

names - values that will resolve to a set of tags for containers to be removed

Returns:

a Remove.RemoveContainer command to remove specific containers

containers

public static Remove.RemoveContainer containers(List<?> names)

Create a Remove.RemoveContainer command to remove specific containers.

Parameters:

names - a List of values that will resolve to a set of tags for containers to be removed

Returns:

a Remove.RemoveContainer command to remove specific containers

link

public static Remove link(String first,
                          String second)

Create a Remove command to remove a link between two containers.

Parameters:

first - the name of the first container

second - the name of the second container

Returns:

a Remove command to remove a link between two containers

images

public static Remove.RemoveImage images(Object... tags)

Create a Remove.RemoveImage command to remove specific images.

Parameters:

tags - values that will resolve to a set of tags for images to be removed

Returns:

a Remove.RemoveImage command to remove specific images

images

public static Remove.RemoveImage images(List<?> tags)

Create a Remove.RemoveImage command to remove specific images.

Parameters:

tags - a List of values that will resolve to a set of tags for images to be removed

Returns:

a Remove.RemoveImage command to remove specific images