com.madara

Class WaitSettings

java.lang.Object

com.madara.MadaraJNI

com.madara.EvalSettings

com.madara.WaitSettings

public class WaitSettings
extends EvalSettings

Encapsulates settings for a wait statement.

Field Summary

Fields

Modifier and Type	Field and Description
static WaitSettings	DEFAULT_WAIT_SETTINGS

Fields inherited from class com.madara.EvalSettings

DEFAULT_EVAL_SETTINGS

Constructor Summary

Constructors

Modifier	Constructor and Description
	WaitSettings() Default constructor
protected	WaitSettings(long cptr) C pointer constructor
	WaitSettings(WaitSettings waitSettings) Copy constructor

Method Summary

Modifier and Type	Method and Description
protected void	finalize() Cleans up underlying C resources
void	free() Deletes the C instantiation.
double	getMaxWaitTime()
double	getPollFrequency()
void	setMaxWaitTime(double maxWaitTime)
void	setPollFrequency(double freq)

Methods inherited from class com.madara.EvalSettings

getAlwaysOverwrite, getDefaultClockIncrement, getDelaySendingModifieds, getPostPrintStatement, getPrePrintStatement, getTreatGlobalsAsLocals, setAlwaysOverwrite, setDefaultClockIncrement, setDelaySendingModifieds, setPostPrintStatement, setPrePrintStatement, setTreatGlobalsAsLocals

Methods inherited from class com.madara.MadaraJNI

getCPtr, setCPtr, toString

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WAIT_SETTINGS

public static WaitSettings DEFAULT_WAIT_SETTINGS

Constructor Detail

WaitSettings

public WaitSettings()

Default constructor

WaitSettings

public WaitSettings(WaitSettings waitSettings)

Copy constructor

Parameters:

waitSettings - settings to be copied

WaitSettings

protected WaitSettings(long cptr)

C pointer constructor

Parameters:

cptr - the C ptr to be inherited

Method Detail

setPollFrequency

public void setPollFrequency(double freq)

Parameters:

freq - Frequency to poll an expression for truth.

getPollFrequency

public double getPollFrequency()

Returns:

current poll frequency

setMaxWaitTime

public void setMaxWaitTime(double maxWaitTime)

Parameters:

maxWaitTime - Maximum time to wait for an expression to become true.

getMaxWaitTime

public double getMaxWaitTime()

Returns:

current max wait time

free

public void free()

Deletes the C instantiation. To prevent memory leaks, this must be called before an instance of WaitSettings gets garbage collected

Overrides:

free in class EvalSettings

finalize

protected void finalize()
                 throws java.lang.Throwable

Cleans up underlying C resources

Overrides:

finalize in class EvalSettings

Throws:

java.lang.Throwable - necessary for override but unused