Package org.eclipse.epsilon.common.launch

Class ProfilableRunConfiguration

java.lang.Object

org.eclipse.epsilon.common.launch.ProfilableRunConfiguration

All Implemented Interfaces:

Runnable, Callable<Object>, Supplier<Object>, CheckedSupplier<Object,Exception>

Direct Known Subclasses:

EolRunConfiguration

public abstract class ProfilableRunConfiguration
extends Object
implements Runnable, Callable<Object>, CheckedSupplier<Object,Exception>

Generic utility class for building standalone applications with support for:
- Multi-stage, detailed AST profiling
- Writing to output files
- Identifying and comparing configurations
- Displaying results
- Building configurations using an elegant builder syntax
... and more

The intention is that this class is used as a base for building more complex standalone run configurations which can be built and invoked easily (at least, from the client's perspective!).

Since:

1.6

Author:

Sina Madani

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProfilableRunConfiguration.Builder<C extends ProfilableRunConfiguration,B extends ProfilableRunConfiguration.Builder<C,B>>

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	hasRun
protected int	id
final Path	outputFile
protected String	printMarker
protected final Collection<ProfileDiagnostic>	profiledStages
final boolean	profileExecution
protected Object	result
final Path	script
final boolean	showResults
protected final int	targetRepeats

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ProfilableRunConfiguration(ProfilableRunConfiguration other)
protected	ProfilableRunConfiguration(ProfilableRunConfiguration.Builder<?,?> builder)

Method Summary

Modifier and Type	Method	Description
protected void	afterRepeatLoop()
protected void	beforeRepeatLoop()
static <C extends ProfilableRunConfiguration, B extends ProfilableRunConfiguration.Builder<C, B>> B	Builder(Class<C> configClass)
final Object	call()
boolean	equals(Object obj)
protected abstract Object	execute()
protected static <C extends ProfilableRunConfiguration, B extends ProfilableRunConfiguration.Builder<C, B>> Constructor<B>	findBuilder(Class<C> configClass)
protected final int	getCurrentRepeat()
Duration	getExecutionTime()
int	getId()
protected List<Object>	getProfilingOutput()
Object	getResult()
protected List<Object>	getResultOutput()
final Object	getThrows()
protected void	handleException(Exception ex)
int	hashCode()
protected final boolean	isFirstRepeat()
protected final boolean	isLastRepeat()
protected void	postExecute()
protected void	preExecute()
protected void	reset()
final void	run()
String	toString()
final void	writeOut(Object... lines)
protected void	writeOut(Collection<?> lines)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.epsilon.common.function.CheckedSupplier

get

Field Details

printMarker

protected String printMarker

id

protected int id

showResults

public final boolean showResults

profileExecution

public final boolean profileExecution

script

public final Path script

outputFile

public final Path outputFile

profiledStages

protected final Collection<ProfileDiagnostic> profiledStages

hasRun

protected boolean hasRun

result

protected Object result

targetRepeats

protected final int targetRepeats

Constructor Details

ProfilableRunConfiguration

protected ProfilableRunConfiguration(ProfilableRunConfiguration.Builder<?,?> builder)

ProfilableRunConfiguration

protected ProfilableRunConfiguration(ProfilableRunConfiguration other)

Method Details

Builder

public static <C extends ProfilableRunConfiguration,
B extends ProfilableRunConfiguration.Builder<C,
B>>
B Builder(Class<C> configClass)

findBuilder

protected static <C extends ProfilableRunConfiguration,
B extends ProfilableRunConfiguration.Builder<C,
B>>
Constructor<B> findBuilder(Class<C> configClass)

getThrows

public final Object getThrows()
                       throws Exception

Specified by:

getThrows in interface CheckedSupplier<Object,Exception>

Throws:

Exception

call

public final Object call()
                  throws Exception

Specified by:

call in interface Callable<Object>

Throws:

Exception

beforeRepeatLoop

protected void beforeRepeatLoop()
                         throws Exception

Throws:

Exception

afterRepeatLoop

protected void afterRepeatLoop()
                        throws Exception

Throws:

Exception

getCurrentRepeat

protected final int getCurrentRepeat()

isFirstRepeat

protected final boolean isFirstRepeat()

isLastRepeat

protected final boolean isLastRepeat()

run

public final void run()

Specified by:

run in interface Runnable

handleException

protected void handleException(Exception ex)

preExecute

protected void preExecute()
                   throws Exception

Throws:

Exception

execute

protected abstract Object execute()
                           throws Exception

Throws:

Exception

getProfilingOutput

protected List<Object> getProfilingOutput()

getResultOutput

protected List<Object> getResultOutput()

postExecute

protected void postExecute()
                    throws Exception

Throws:

Exception

reset

protected void reset()
              throws Exception

Throws:

Exception

getExecutionTime

public Duration getExecutionTime()

getResult

public Object getResult()

getId

public int getId()

writeOut

public final void writeOut(Object... lines)

writeOut

protected void writeOut(Collection<?> lines)

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object