Module com.oracle.bedrock.runtime.docker

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

Class Remove.RemoveContainer

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<Remove.RemoveContainer>

com.oracle.bedrock.runtime.docker.commands.Remove.RemoveContainer

All Implemented Interfaces:

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

Enclosing class:

Remove<R extends Remove>

public static class Remove.RemoveContainer
extends Remove<Remove.RemoveContainer>

A representation of a Docker command to remove one or more containers (equates to the Docker rm command).

Nested Class Summary

Nested classes/interfaces inherited from class com.oracle.bedrock.runtime.docker.commands.Remove

Remove.RemoveContainer, Remove.RemoveImage, Remove.RemoveLink

Method Summary

Modifier and Type	Method	Description
Remove.RemoveContainer	andVolumes()	Remove the volumes associated with the container (equates to the --volumes argument).
Remove.RemoveContainer	andVolumes(boolean remove)	Remove the volumes associated with the container (equates to the --volumes argument).
Remove.RemoveContainer	force()	Force removal of the container (equates to the --force argument).
Remove.RemoveContainer	force(boolean force)	Force removal of the container (equates to the --force argument).
protected Remove.RemoveContainer	withCommandArguments(List<com.oracle.bedrock.runtime.options.Argument> containers, com.oracle.bedrock.runtime.options.Argument... args)	Obtain a copy of this CommandWithArgumentList with the addition of the specified command arguments Arguments.
protected Remove.RemoveContainer	withoutCommandArguments(List<com.oracle.bedrock.runtime.options.Argument> names, com.oracle.bedrock.runtime.options.Argument... args)	Obtain a copy of this CommandWithArgumentList without the the specified command arguments Arguments.

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

containers, containers, images, images, link

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

onLaunch, withCommandArguments, 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

force

public Remove.RemoveContainer force()

Force removal of the container (equates to the --force argument).

Returns:

a new Remove.RemoveContainer instance that is the same as this instance with the --force option applied

force

public Remove.RemoveContainer force(boolean force)

Force removal of the container (equates to the --force argument).

Parameters:

force - true to add the --force option or false to remove the --force option

Returns:

a new Remove.RemoveContainer instance that is the same as this instance with the --force option applied

andVolumes

public Remove.RemoveContainer andVolumes()

Remove the volumes associated with the container (equates to the --volumes argument).

Returns:

a new Remove.RemoveContainer instance that is the same as this instance with the --volumes option applied

andVolumes

public Remove.RemoveContainer andVolumes(boolean remove)

Remove the volumes associated with the container (equates to the --volumes argument).

Parameters:

remove - true to add the --volumes option, false to remove the --volumes option

Returns:

a new Remove.RemoveContainer instance that is the same as this instance with the --volumes option applied

withCommandArguments

protected Remove.RemoveContainer withCommandArguments(List<com.oracle.bedrock.runtime.options.Argument> containers,
                                                      com.oracle.bedrock.runtime.options.Argument... args)

Description copied from class: CommandWithArgumentList

Obtain a copy of this CommandWithArgumentList with the addition of the specified command arguments Arguments.

Specified by:

withCommandArguments in class CommandWithArgumentList<Remove.RemoveContainer>

Parameters:

containers - the List of Arguments that appear at the end of the command line

args - the new command to add

Returns:

a copy of this CommandWithArgumentList with the addition of the specified command arguments Arguments

withoutCommandArguments

protected Remove.RemoveContainer withoutCommandArguments(List<com.oracle.bedrock.runtime.options.Argument> names,
                                                         com.oracle.bedrock.runtime.options.Argument... args)

Description copied from class: CommandWithArgumentList

Obtain a copy of this CommandWithArgumentList without the the specified command arguments Arguments.

Specified by:

withoutCommandArguments in class CommandWithArgumentList<Remove.RemoveContainer>

Parameters:

names - the List of Arguments that appear at the end of the command line

args - the new command to add

Returns:

a copy of this CommandWithArgumentList without the specified command arguments Arguments