io.cdap.cdap.api.workflow

Class AbstractCondition

java.lang.Object

io.cdap.cdap.api.workflow.AbstractCondition

All Implemented Interfaces:

Predicate<WorkflowContext>, ProgramLifecycle<WorkflowContext>, Condition

public abstract class AbstractCondition
extends Object
implements Condition

The abstract class provides default implementation of the Condition methods for an easy extension

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCondition()
protected	AbstractCondition(String name)

Method Summary

Modifier and Type	Method and Description
protected void	configure()
void	configure(ConditionConfigurer configurer) Configures the condition.
void	destroy() Classes derived from AbstractCondition can override this method to destroy the Condition.
protected WorkflowContext	getContext()
void	initialize(WorkflowContext context) Initializes a Program.
protected void	setDescription(String description)
protected void	setName(String name)
protected void	setProperties(Map<String,String> properties)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.cdap.cdap.api.Predicate

apply

Constructor Detail

AbstractCondition

protected AbstractCondition()

AbstractCondition

protected AbstractCondition(String name)

Method Detail

configure

protected void configure()

configure

public void configure(ConditionConfigurer configurer)

Description copied from interface: Condition

Configures the condition.

Specified by:

configure in interface Condition

Parameters:

configurer - the ConditionConfigurer used to configure the condition.

setName

protected void setName(String name)

setDescription

protected void setDescription(String description)

setProperties

protected void setProperties(Map<String,String> properties)

initialize

public void initialize(WorkflowContext context)
                throws Exception

Description copied from interface: ProgramLifecycle

Initializes a Program.

This method will be called only once per ProgramLifecycle instance.

Specified by:

initialize in interface ProgramLifecycle<WorkflowContext>

Parameters:

context - An instance of RuntimeContext

Throws:

Exception - If there is any error during initialization.

destroy

public void destroy()

Classes derived from AbstractCondition can override this method to destroy the Condition.

Specified by:

destroy in interface ProgramLifecycle<WorkflowContext>

getContext

protected final WorkflowContext getContext()

Returns:

an instance of WorkflowContext