org.arl.fjage

Class WakerBehavior

java.lang.Object

org.arl.fjage.Behavior

org.arl.fjage.WakerBehavior

All Implemented Interfaces:

java.lang.Comparable<Behavior>

public class WakerBehavior
extends Behavior

A behavior that is executed once after a specified delay. Once the specified delay expires, the onWake() method of this behavior is called.

Field Summary

Fields inherited from class org.arl.fjage.Behavior

action, agent, log

Constructor Summary

Constructors

Constructor and Description
WakerBehavior(long millis) Creates a behavior which is executed once after a specified delay.
WakerBehavior(long millis, java.lang.Runnable runnable) Creates a behavior which is executed once after a specified delay.

Method Summary

Modifier and Type	Method and Description
void	action() This method calls onWake() when the specified delay for this behavior expires.
static WakerBehavior	create(long millis, java.lang.Runnable runnable) Creates a new WakerBehavior which runs the specified Runnable once the specified delay expires.
boolean	done() Returns false until the delay expires, and true once the delay has expired and the onWake() method has been called.
int	getPriority() This method should return a number that denotes the priority of a behavior.
long	getWakeupTime() Returns the wakeup time for this behavior.
void	onStart() Computes the wakeup time for this behavior.
void	onWake() This method is called once the specified delay for this behavior expires.
void	reset() Resets the behavior, allowing it to be used again.
void	stop() Terminates the behavior.

Methods inherited from class org.arl.fjage.Behavior

agent, agentForService, agentForService, agentsForService, agentsForService, block, block, compareTo, isBlocked, onEnd, println, restart

Methods inherited from class java.lang.Object

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

Constructor Detail

WakerBehavior

public WakerBehavior(long millis)

Creates a behavior which is executed once after a specified delay.

Parameters:

millis - delay in milliseconds.

WakerBehavior

public WakerBehavior(long millis,
                     java.lang.Runnable runnable)

Creates a behavior which is executed once after a specified delay.

Parameters:

millis - delay in milliseconds.

runnable - Runnable to run.

Method Detail

getWakeupTime

public final long getWakeupTime()

Returns the wakeup time for this behavior. On a real-time platform, the time is the epoch time, while a discrete event simulator gives the wakeup time in simulated time.

Returns:

the wakeup time in milliseconds.

See Also:

Platform.currentTimeMillis()

stop

public final void stop()

Terminates the behavior.

onWake

public void onWake()

This method is called once the specified delay for this behavior expires. A behavior usually overrides this.

onStart

public final void onStart()

Computes the wakeup time for this behavior.

Overrides:

onStart in class Behavior

See Also:

Behavior.onStart()

action

public final void action()

This method calls onWake() when the specified delay for this behavior expires.

Overrides:

action in class Behavior

See Also:

Behavior.action()

done

public final boolean done()

Returns false until the delay expires, and true once the delay has expired and the onWake() method has been called.

Overrides:

done in class Behavior

Returns:

false when the delay has not expired, false after it has expired.

See Also:

Behavior.done()

reset

public void reset()

Resets the behavior, allowing it to be used again.

Overrides:

reset in class Behavior

See Also:

Behavior.reset()

getPriority

public int getPriority()

Description copied from class: Behavior

This method should return a number that denotes the priority of a behavior. By default, the priority is 0. Behaviors with lower priority values are executed before behaviors with higher priority values.

Overrides:

getPriority in class Behavior

Returns:

priority value

create

public static WakerBehavior create(long millis,
                                   java.lang.Runnable runnable)

Creates a new WakerBehavior which runs the specified Runnable once the specified delay expires.

Parameters:

millis - Delay in milliseconds.

runnable - Runnable to run.

Returns:

WakerBehavior