org.apache.oozie.fluentjob.api.action

Class ShellActionBuilder

java.lang.Object

org.apache.oozie.fluentjob.api.action.NodeBuilderBaseImpl<ShellActionBuilder>

org.apache.oozie.fluentjob.api.action.ShellActionBuilder

All Implemented Interfaces:

Builder<ShellAction>

@InterfaceAudience.Private
 @InterfaceStability.Unstable
public class ShellActionBuilder
extends NodeBuilderBaseImpl<ShellActionBuilder>
implements Builder<ShellAction>

A builder class for ShellAction. The properties of the builder can only be set once, an attempt to set them a second time will trigger an IllegalStateException. The properties that are lists are an exception to this rule, of course multiple elements can be added / removed. Builder instances can be used to build several elements, although properties already set cannot be changed after a call to build() either.

Method Summary

Modifier and Type	Method and Description
ShellAction	build() Builds and returns an object.
ShellActionBuilder	clearArchives()
ShellActionBuilder	clearArguments()
ShellActionBuilder	clearEnvironmentVariables()
ShellActionBuilder	clearFiles()
ShellActionBuilder	clearJobXmls()
static ShellActionBuilder	create()
static ShellActionBuilder	createFromExistingAction(Node action)
static ShellActionBuilder	createFromExistingAction(ShellAction action)
protected ShellActionBuilder	getRuntimeSelfReference()
ShellActionBuilder	withArchive(String archive)
ShellActionBuilder	withArgument(String argument)
ShellActionBuilder	withCaptureOutput(Boolean captureOutput)
ShellActionBuilder	withConfigProperty(String key, String value)
ShellActionBuilder	withEnvironmentVariable(String environmentVariable)
ShellActionBuilder	withExecutable(String executable)
ShellActionBuilder	withFile(String file)
ShellActionBuilder	withJobXml(String jobXml)
ShellActionBuilder	withLauncher(Launcher launcher)
ShellActionBuilder	withNameNode(String nameNode)
ShellActionBuilder	withoutArchive(String archive)
ShellActionBuilder	withoutArgument(String argument)
ShellActionBuilder	withoutEnvironmentVariable(String environmentVariable)
ShellActionBuilder	withoutFile(String file)
ShellActionBuilder	withoutJobXml(String jobXml)
ShellActionBuilder	withPrepare(Prepare prepare)
ShellActionBuilder	withResourceManager(String resourceManager)

Methods inherited from class org.apache.oozie.fluentjob.api.action.NodeBuilderBaseImpl

addAsChildToAllParents, clearCredentials, clearParents, withCredential, withErrorHandler, withName, withoutCredential, withoutErrorHandler, withoutParent, withParent, withParentDefaultConditional, withParentWithCondition, withRetryInterval, withRetryMax, withRetryPolicy

Methods inherited from class java.lang.Object

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

Method Detail

create

public static ShellActionBuilder create()

createFromExistingAction

public static ShellActionBuilder createFromExistingAction(ShellAction action)

createFromExistingAction

public static ShellActionBuilder createFromExistingAction(Node action)

withResourceManager

public ShellActionBuilder withResourceManager(String resourceManager)

withNameNode

public ShellActionBuilder withNameNode(String nameNode)

withPrepare

public ShellActionBuilder withPrepare(Prepare prepare)

withLauncher

public ShellActionBuilder withLauncher(Launcher launcher)

withJobXml

public ShellActionBuilder withJobXml(String jobXml)

withoutJobXml

public ShellActionBuilder withoutJobXml(String jobXml)

clearJobXmls

public ShellActionBuilder clearJobXmls()

withConfigProperty

public ShellActionBuilder withConfigProperty(String key,
                                             String value)

withExecutable

public ShellActionBuilder withExecutable(String executable)

withArgument

public ShellActionBuilder withArgument(String argument)

withoutArgument

public ShellActionBuilder withoutArgument(String argument)

clearArguments

public ShellActionBuilder clearArguments()

withEnvironmentVariable

public ShellActionBuilder withEnvironmentVariable(String environmentVariable)

withoutEnvironmentVariable

public ShellActionBuilder withoutEnvironmentVariable(String environmentVariable)

clearEnvironmentVariables

public ShellActionBuilder clearEnvironmentVariables()

withFile

public ShellActionBuilder withFile(String file)

withoutFile

public ShellActionBuilder withoutFile(String file)

clearFiles

public ShellActionBuilder clearFiles()

withArchive

public ShellActionBuilder withArchive(String archive)

withoutArchive

public ShellActionBuilder withoutArchive(String archive)

clearArchives

public ShellActionBuilder clearArchives()

withCaptureOutput

public ShellActionBuilder withCaptureOutput(Boolean captureOutput)

build

public ShellAction build()

Description copied from interface: Builder

Builds and returns an object.

Specified by:

build in interface Builder<ShellAction>

Returns:

The built object.

getRuntimeSelfReference

protected ShellActionBuilder getRuntimeSelfReference()

Specified by:

getRuntimeSelfReference in class NodeBuilderBaseImpl<ShellActionBuilder>