NodeBuilderBaseImpl (Apache Oozie Fluent Job API 5.2.1 API)

java.lang.Object
- org.apache.oozie.fluentjob.api.action.NodeBuilderBaseImpl<B>

Type Parameters:

B - The type of the concrete builder class deriving from this class.

Direct Known Subclasses:

DistcpActionBuilder, EmailActionBuilder, FSActionBuilder, GitActionBuilder, Hive2ActionBuilder, HiveActionBuilder, JavaActionBuilder, MapReduceActionBuilder, PigActionBuilder, ShellActionBuilder, SparkActionBuilder, SqoopActionBuilder, SshActionBuilder, SubWorkflowActionBuilder
```
@InterfaceAudience.Private
 @InterfaceStability.Unstable
public abstract class NodeBuilderBaseImpl<B extends NodeBuilderBaseImpl<B>>
extends Object
```
An abstract base class for builders that build concrete instances of subclasses of Node. This class doesn't implement the Builder interface as no type information as to the concrete node to build. The concrete node builder classes of course should implement Builder. The concrete builders should provide a fluent API, and to facilitate this, the methods in this base class have to return the concrete builder. Therefore it is templated on the type of the concrete builder class. Although it cannot be enforced that the provided generic parameter is the same as the class deriving from this class, it definitely should be, and the constraint on the type parameter tries to minimize the chance that the class is subclassed incorrectly. 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.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addAsChildToAllParents(Node child)`
`B`	`clearCredentials()` Removes all `Credential`s registered with this builder.
`B`	`clearParents()` Removes all parents registered with this builder.
`protected abstract B`	`getRuntimeSelfReference()`
`B`	`withCredential(Credential credential)` Registers a `Credential` that will be the `cred` of the action built by this builder.
`B`	`withErrorHandler(ErrorHandler errorHandler)` Registers an error handler with this builder.
`B`	`withName(String name)` Registers a name that will be the name of the action built by this builder.
`B`	`withoutCredential(Credential credential)` Removes a `Credential` registered with this builder.
`B`	`withoutErrorHandler()` Removes the currently registered error handler if any.
`B`	`withoutParent(Node parent)` Removes a parent registered with this builder.
`B`	`withParent(Node parent)` Registers an unconditional parent with this builder.
`B`	`withParentDefaultConditional(Node parent)` Registers a conditional parent for which this node is the default transition.
`B`	`withParentWithCondition(Node parent, String condition)` Registers a conditional parent with this builder.
`B`	`withRetryInterval(Integer retryInterval)` Registers an `Integer` that will be the `retry-interval` of the action built by this builder.
`B`	`withRetryMax(Integer retryMax)` Registers an `Integer` that will be the `retry-max` of the action built by this builder.
`B`	`withRetryPolicy(String retryPolicy)` Registers a `String` that will be the `retry-policy` of the action built by this builder.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - withErrorHandler
```
public B withErrorHandler(ErrorHandler errorHandler)
```
    Registers an error handler with this builder.
    
    Parameters:
    
    errorHandler - The error handler to register.
    
    Returns:
    
    This builder.
  - withoutErrorHandler
```
public B withoutErrorHandler()
```
    Removes the currently registered error handler if any.
    
    Returns:
    
    This builder.
  - withName
```
public B withName(String name)
```
    Registers a name that will be the name of the action built by this builder.
    
    Parameters:
    
    name - The name of the action that will be built.
    
    Returns:
    
    This builder.
  - withCredential
```
public B withCredential(Credential credential)
```
    Registers a Credential that will be the cred of the action built by this builder.
    
    Parameters:
    
    credential - The Credential of the action that will be built.
    
    Returns:
    
    This builder.
  - withoutCredential
```
public B withoutCredential(Credential credential)
```
    Removes a Credential registered with this builder. If the credential is not registered with this builder, this method does nothing.
    
    Parameters:
    
    credential - The Credential to remove.
    
    Returns:
    
    This builder.
  - clearCredentials
```
public B clearCredentials()
```
    Removes all Credentials registered with this builder.
    
    Returns:
    
    This builder.
  - withRetryMax
```
public B withRetryMax(Integer retryMax)
```
    Registers an Integer that will be the retry-max of the action built by this builder.
    
    Parameters:
    
    retryMax - The retry-max of the action that will be built.
    
    Returns:
    
    This builder.
  - withRetryInterval
```
public B withRetryInterval(Integer retryInterval)
```
    Registers an Integer that will be the retry-interval of the action built by this builder.
    
    Parameters:
    
    retryInterval - The retry-interval of the action that will be built.
    
    Returns:
    
    This builder.
  - withRetryPolicy
```
public B withRetryPolicy(String retryPolicy)
```
    Registers a String that will be the retry-policy of the action built by this builder.
    
    Parameters:
    
    retryPolicy - The retry-policy of the action that will be built.
    
    Returns:
    
    This builder.
  - withParent
```
public B withParent(Node parent)
```
    Registers an unconditional parent with this builder. If the parent is already registered with this builder, IllegalArgumentException is thrown.
    
    Parameters:
    
    parent - The node that will be the parent of the built action.
    
    Returns:
    
    This builder.
    
    Throws:
    
    IllegalArgumentException - if the provided node is already registered as a parent.
  - withParentWithCondition
```
public B withParentWithCondition(Node parent,
                                 String condition)
```
    Registers a conditional parent with this builder. If the parent is already registered with this builder, IllegalArgumentException is thrown.
    
    Parameters:
    
    parent - The node that will be the parent of the built action.
    
    condition - The condition of the parent.
    
    Returns:
    
    This builder.
    
    Throws:
    
    IllegalArgumentException - if the provided node is already registered as a parent.
  - withParentDefaultConditional
```
public B withParentDefaultConditional(Node parent)
```
    Registers a conditional parent for which this node is the default transition. If the parent is already registered with this builder, IllegalArgumentException is thrown. IllegalArgumentException is thrown.
    
    Parameters:
    
    parent - The node that will be the parent of the built action.
    
    Returns:
    
    This builder.
    
    Throws:
    
    IllegalArgumentException - if the provided node is already registered as a parent.
  - withoutParent
```
public B withoutParent(Node parent)
```
    Removes a parent registered with this builder. If the parent is not registered with this builder, this method does nothing.
    
    Parameters:
    
    parent - The parent to remove.
    
    Returns:
    
    This builder.
  - clearParents
```
public B clearParents()
```
    Removes all parents registered with this builder.
    
    Returns:
    
    This builder.
  - addAsChildToAllParents
```
protected void addAsChildToAllParents(Node child)
```
  - getRuntimeSelfReference
```
protected abstract B getRuntimeSelfReference()
```

Class NodeBuilderBaseImpl<B extends NodeBuilderBaseImpl<B>>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

withErrorHandler

withoutErrorHandler

withName

withCredential

withoutCredential

clearCredentials

withRetryMax

withRetryInterval

withRetryPolicy

withParent

withParentWithCondition

withParentDefaultConditional

withoutParent

clearParents

addAsChildToAllParents

getRuntimeSelfReference