org.apache.oozie.fluentjob.api.action

Class EmailActionBuilder

java.lang.Object

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

org.apache.oozie.fluentjob.api.action.EmailActionBuilder

All Implemented Interfaces:

Builder<EmailAction>

@InterfaceAudience.Private
 @InterfaceStability.Unstable
public class EmailActionBuilder
extends NodeBuilderBaseImpl<EmailActionBuilder>
implements Builder<EmailAction>

A builder class for EmailAction.

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
EmailAction	build() Creates a new EmailAction object with the properties stores in this builder.
static EmailActionBuilder	create() Creates and returns an empty builder.
static EmailActionBuilder	createFromExistingAction(EmailAction action) Create and return a new EmailActionBuilder that is based on an already built EmailAction object.
static EmailActionBuilder	createFromExistingAction(Node action)
protected EmailActionBuilder	getRuntimeSelfReference()
EmailActionBuilder	withAttachment(String attachment) Sets the attachment of the email.
EmailActionBuilder	withBcc(String bcc) Sets the address of the secret recipient of a copy of the email.
EmailActionBuilder	withBody(String body) Sets the body of the email.
EmailActionBuilder	withCc(String cc) Sets the address of the recipient of a copy of the email.
EmailActionBuilder	withContentType(String contentType) Sets the content type of the email.
EmailActionBuilder	withRecipient(String to) Sets the address of the recipient of the email.
EmailActionBuilder	withSubject(String subject) Sets the subject of the email.

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 EmailActionBuilder create()

Creates and returns an empty builder.

Returns:

An empty builder.

createFromExistingAction

public static EmailActionBuilder createFromExistingAction(EmailAction action)

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

Parameters:

action - The EmailAction object on which this EmailActionBuilder will be based.

Returns:

A new EmailActionBuilder that is based on a previously built EmailAction object.

createFromExistingAction

public static EmailActionBuilder createFromExistingAction(Node action)

withRecipient

public EmailActionBuilder withRecipient(String to)

Sets the address of the recipient of the email.

Parameters:

to - the recipient in To: field

Returns:

This builder.

withCc

public EmailActionBuilder withCc(String cc)

Sets the address of the recipient of a copy of the email.

Parameters:

cc - the recipient in CC: field

Returns:

This builder.

withBcc

public EmailActionBuilder withBcc(String bcc)

Sets the address of the secret recipient of a copy of the email.

Parameters:

bcc - the recipient in BCC: field

Returns:

This builder.

withSubject

public EmailActionBuilder withSubject(String subject)

Sets the subject of the email.

Parameters:

subject - the email subject

Returns:

This builder.

withBody

public EmailActionBuilder withBody(String body)

Sets the body of the email.

Parameters:

body - the email body

Returns:

This builder.

withContentType

public EmailActionBuilder withContentType(String contentType)

Sets the content type of the email.

Parameters:

contentType - the email content type

Returns:

This builder

withAttachment

public EmailActionBuilder withAttachment(String attachment)

Sets the attachment of the email.

Parameters:

attachment - the email attachment path

Returns:

This builder.

build

public EmailAction build()

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

Specified by:

build in interface Builder<EmailAction>

Returns:

A new EmailAction object with the properties stored in this builder.

getRuntimeSelfReference

protected EmailActionBuilder getRuntimeSelfReference()

Specified by:

getRuntimeSelfReference in class NodeBuilderBaseImpl<EmailActionBuilder>