org.apache.oozie.fluentjob.api.action

Class ActionAttributesBuilder

java.lang.Object

org.apache.oozie.fluentjob.api.action.ActionAttributesBuilder

All Implemented Interfaces:

Builder<ActionAttributes>

@InterfaceAudience.Private
 @InterfaceStability.Unstable
public class ActionAttributesBuilder
extends Object
implements Builder<ActionAttributes>

A builder class for ActionAttributes. 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
ActionAttributes	build() Creates a new ActionAttributes object with the properties stores in this builder.
void	clearJobXmls() Removes all job XMLs that are registered with this builder.
static ActionAttributesBuilder	create() Creates and returns an empty builder.
static ActionAttributesBuilder	createFromAction(Node action)
static ActionAttributesBuilder	createFromExisting(ActionAttributes attributes) Create and return a new ActionAttributesBuilder that is based on an already built ActionAttributes object.
void	withConfigProperty(String key, String value) Registers a configuration property (a key-value pair) with this builder.
void	withJobXml(String jobXml) Registers a job XML with this builder.
void	withLauncher(Launcher launcher)
void	withNameNode(String nameNode) Registers a name node.
void	withoutJobXml(String jobXml) Removes a job XML if it is registered with this builder, otherwise does nothing.
void	withResourceManager(String resourceManager)

Methods inherited from class java.lang.Object

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

Method Detail

create

public static ActionAttributesBuilder create()

Creates and returns an empty builder.

Returns:

An empty builder.

createFromExisting

public static ActionAttributesBuilder createFromExisting(ActionAttributes attributes)

Create and return a new ActionAttributesBuilder that is based on an already built ActionAttributes object. The properties of the builder will initially be the same as those of the provided ActionAttributes object, but it is possible to modify them once.

Parameters:

attributes - The ActionAttributes object on which this ActionAttributesBuilder will be based.

Returns:

A new ActionAttributesBuilder that is based on a previously built ActionAttributes object.

createFromAction

public static ActionAttributesBuilder createFromAction(Node action)

withResourceManager

public void withResourceManager(String resourceManager)

withNameNode

public void withNameNode(String nameNode)

Registers a name node.

Parameters:

nameNode - The string representing the name node.

Throws:

IllegalStateException - if a name node has already been set on this builder.

withJobXml

public void withJobXml(String jobXml)

Registers a job XML with this builder.

Parameters:

jobXml - The job XML to register.

withoutJobXml

public void withoutJobXml(String jobXml)

Removes a job XML if it is registered with this builder, otherwise does nothing.

Parameters:

jobXml - The job XML to remove.

clearJobXmls

public void clearJobXmls()

Removes all job XMLs that are registered with this builder.

withConfigProperty

public void withConfigProperty(String key,
                               String value)

Registers a configuration property (a key-value pair) with this builder. If the provided key has already been set on this builder, an exception is thrown. Setting a key to null means deleting it.

Parameters:

key - The name of the property to set.

value - The value of the property to set.

Throws:

IllegalStateException - if the provided key has already been set on this builder.

withLauncher

public void withLauncher(Launcher launcher)

build

public ActionAttributes build()

Creates a new ActionAttributes object with the properties stores in this builder. The new ActionAttributes object is independent of this builder and the builder can be used to build new instances.

Specified by:

build in interface Builder<ActionAttributes>

Returns:

A new ActionAttributes object with the propertied stores in this builder.