Module com.oracle.bedrock.runtime.docker

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

Class SimpleDockerCommand

java.lang.Object

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

com.oracle.bedrock.runtime.docker.commands.SimpleDockerCommand

All Implemented Interfaces:

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

public class SimpleDockerCommand
extends AbstractDockerCommand<SimpleDockerCommand>

A representation of a generic Docker command.

Instances of SimpleDockerCommand are immutable, methods that add options and configuration to this SimpleDockerCommand command return a new instance of a SimpleDockerCommand 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

Method Summary

Modifier and Type	Method	Description
static SimpleDockerCommand	of(String command)	Create a SimpleDockerCommand with the specified command name.
SimpleDockerCommand	withCommandArguments(com.oracle.bedrock.runtime.options.Argument... args)	Obtain a copy of this AbstractDockerCommand with the addition of the specified command arguments Arguments.
SimpleDockerCommand	withoutCommandArguments(com.oracle.bedrock.runtime.options.Argument... args)	Obtain a copy of this AbstractDockerCommand without the specified command arguments Arguments.

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

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

Methods inherited from class java.lang.Object

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

Method Detail

withCommandArguments

public SimpleDockerCommand withCommandArguments(com.oracle.bedrock.runtime.options.Argument... args)

Description copied from class: AbstractDockerCommand

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

Command arguments in Docker come after the command name on the command line, e.g. docker [options...] COMMAND_NAME [args...] Parts of the Docker documentation that refer to these parameters as both arguments and options. In our case we refer to them as arguments and the are applied after the command name on the command line.

Specified by:

withCommandArguments in class AbstractDockerCommand<SimpleDockerCommand>

Parameters:

args - the additional Arguments

Returns:

a copy of this AbstractDockerCommand with the addition of the specified Arguments

withoutCommandArguments

public SimpleDockerCommand withoutCommandArguments(com.oracle.bedrock.runtime.options.Argument... args)

Description copied from class: AbstractDockerCommand

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

Command arguments in Docker come after the command name on the command line, e.g. docker [options...] COMMAND_NAME [args...] Parts of the Docker documentation that refer to these parameters as both arguments and options. In our case we refer to them as arguments and the are applied after the command name on the command line.

Specified by:

withoutCommandArguments in class AbstractDockerCommand<SimpleDockerCommand>

Parameters:

args - the additional Arguments

Returns:

a copy of this AbstractDockerCommand without the specified Arguments

of

public static SimpleDockerCommand of(String command)

Create a SimpleDockerCommand with the specified command name.

Parameters:

command - the name of the command

Returns:

a SimpleDockerCommand with the specified command name