javax.realtime

Enum PhasingPolicy

java.lang.Object

java.lang.Enum<PhasingPolicy>

javax.realtime.PhasingPolicy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PhasingPolicy>

public enum PhasingPolicy
extends java.lang.Enum<PhasingPolicy>

This class defines a set of constants that specify the supported policies for starting a periodic thread or periodic timer, when it is started later than the assigned absolute time. The following table specifies the effective start time, that is, the first release time of a periodic realtime thread. The effective start time of a periodic timer is similar; where the first firing is equivalent to the first release, and a call to the constructor is equivalent to a call to RealtimeThread.start().

PhasingPolicy Effect on First Release of a RealtimeThread with PeriodicParameters

	ADJUST IMMEDIATE	ADJUST FORWARD	ADJUST BACKWARD	STRICT PHASING
RelativeTime	The time of start method invocation plus start time.	The time of start method invocation plus start time.	The time of start method invocation plus start time.	The time of start method invocation plus start time.
AbsoluteTime, earlier than call to start	Release immediately and set next release time to be at the time the start method was invoked plus period.	All releases before the time start is called are ignored. The first release is at the start time plus the smallest multiple of period whose time is after the time start was called.	The first release occurs immediately and the next release is at the start time plus the smallest multiple of period whose time is after the time start was called.	The start method throws an exception.
AbsoluteTime, later than call to start	First release is at time passed to start.	First release is at time passed to start.	First release is at time passed to start.	First release is at time passed to start.
Without Time	First release is at time of start method invocation	First release is at time of start method invocation	First release is at time of start method invocation	First release is at time of start method invocation

Since:

RTSJ 2.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADJUST_BACKWARD Indicates that a periodic thread started after the absolute time given for its start time should be released immediately with the next release at the next multiple of its period from its start time.
ADJUST_FORWARD Indicates that a periodic thread started after the absolute time given for its start time should be released at the next multiple of its period from its start time.
ADJUST_IMMEDIATE Indicates that a periodic thread started after the absolute time given for its start time should be released immediately with the next release one period later.
STRICT_PHASING Indicates that a periodic thread started after the absolute time given for its start time should throw the LateStartException exception instead of being released.

Method Summary

Modifier and Type	Method and Description
static PhasingPolicy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PhasingPolicy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ADJUST_IMMEDIATE

public static final PhasingPolicy ADJUST_IMMEDIATE

Indicates that a periodic thread started after the absolute time given for its start time should be released immediately with the next release one period later.

ADJUST_FORWARD

public static final PhasingPolicy ADJUST_FORWARD

Indicates that a periodic thread started after the absolute time given for its start time should be released at the next multiple of its period from its start time.

ADJUST_BACKWARD

public static final PhasingPolicy ADJUST_BACKWARD

Indicates that a periodic thread started after the absolute time given for its start time should be released immediately with the next release at the next multiple of its period from its start time.

STRICT_PHASING

public static final PhasingPolicy STRICT_PHASING

Indicates that a periodic thread started after the absolute time given for its start time should throw the LateStartException exception instead of being released.

Method Detail

values

public static PhasingPolicy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PhasingPolicy c : PhasingPolicy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PhasingPolicy valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null