co.ecg.alpaca.toolkit.helper.model

Class IterableProcess<T extends IterableProcess<T,E>,E extends Enum<E>>

java.lang.Object

co.ecg.alpaca.toolkit.helper.model.ErrorableProcess

co.ecg.alpaca.toolkit.helper.model.IterableProcess<T,E>

All Implemented Interfaces:

Loggable

Direct Known Subclasses:

AbstractDestroy, AbstractImport, AbstractInformationBuilder, AbstractMigration

public abstract class IterableProcess<T extends IterableProcess<T,E>,E extends Enum<E>>
extends ErrorableProcess

An abstract iterable process in which the process execution can occur through steps defined in an enumeration. Created by mkeathley on 5/23/16.

Field Summary

Fields

Modifier and Type	Field and Description
protected HashMap<E,Object[]>	stepList

Fields inherited from class co.ecg.alpaca.toolkit.helper.model.ErrorableProcess

errors, log

Constructor Summary

Constructors

Constructor and Description
IterableProcess(co.ecg.alpaca.toolkit.model.BroadWorksServer bws, Class<E> stepClazz) Creates an iterable process with the provided BroadWorksServer and step class enum

Method Summary

Modifier and Type	Method and Description
T	addStep(E... step) Adds the provided step(s) to the step list.
T	addStep(E step, Object[] data) Adds the provided step with additional data.
T	all() Perform All Steps
T	allBut(E... step) Perform all Steps except the listed steps
boolean	isConcurrent() Returns true IFF the process is allowed to return before completing
T	only(E... step) Adds the provided step(s) to the step list after clearing the list.
T	setConcurrent(boolean concurrent) Sets if the operation should return before the underyling threads have completed
protected boolean	step(E... step) Checks if any of the steps in the parameter list have been added to the step list

Methods inherited from class co.ecg.alpaca.toolkit.helper.model.ErrorableProcess

checkValidity, exception, getErrors, hasErrors, isError, isError

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.ecg.alpaca.toolkit.helper.model.Loggable

getSessionLogger, logger

Field Detail

stepList

protected HashMap<E extends Enum<E>,Object[]> stepList

Constructor Detail

IterableProcess

public IterableProcess(co.ecg.alpaca.toolkit.model.BroadWorksServer bws,
                       Class<E> stepClazz)
                throws HelperException

Creates an iterable process with the provided BroadWorksServer and step class enum

Parameters:

bws - The BroadWorksServer object

stepClazz - The class of the step enumeration list

Throws:

HelperException

Method Detail

step

@SafeVarargs
protected final boolean step(E... step)

Checks if any of the steps in the parameter list have been added to the step list

Parameters:

step - The steps to check for existence in the step list.

Returns:

True IFF the step list contains a provided step.

all

public T all()

Perform All Steps

Returns:

IterableProcess

allBut

@SafeVarargs
public final T allBut(E... step)

Perform all Steps except the listed steps

Returns:

IterableProcess

only

@SafeVarargs
public final T only(E... step)

Adds the provided step(s) to the step list after clearing the list.

Returns:

IterableProcess

addStep

@SafeVarargs
public final T addStep(E... step)

Adds the provided step(s) to the step list.

Returns:

IterableProcess

addStep

public T addStep(E step,
                 Object[] data)

Adds the provided step with additional data.

Returns:

IterableProcess

isConcurrent

public boolean isConcurrent()

Returns true IFF the process is allowed to return before completing

Returns:

A boolean value of isConcurrent

setConcurrent

public T setConcurrent(boolean concurrent)

Sets if the operation should return before the underyling threads have completed

Parameters:

concurrent - The desired concurrency value

Returns:

IterableProcess