javax.realtime

Enum MinimumInterarrivalPolicy

java.lang.Object

java.lang.Enum<MinimumInterarrivalPolicy>

javax.realtime.MinimumInterarrivalPolicy

All Implemented Interfaces:

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

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

Defines the set of policies for handling interarrival time violations in SporadicParameters. Each policy governs every instance of Schedulable which has SporadicParameters with that minimum interarrival time policy.

Since:

RTSJ 2.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXCEPT Represents the "EXCEPT" policy for minimum interarrival time.
IGNORE Represents the "IGNORE" policy for minimum interarrival time.
REPLACE Represents the "REPLACE" policy for minimum interarrival time.
SAVE Represents the "SAVE" policy for minimum interarrival time.

Method Summary

Modifier and Type	Method and Description
static MinimumInterarrivalPolicy	value(java.lang.String value) Converts a string into a policy type.
static MinimumInterarrivalPolicy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MinimumInterarrivalPolicy[]	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

EXCEPT

public static final MinimumInterarrivalPolicy EXCEPT

Represents the "EXCEPT" policy for minimum interarrival time. Under this policy, when an arrival time of a release occurs at a time less than the last release time plus its minimum interarrival time, the fire() method shall throw a preallocated instance of MITViolationException.

IGNORE

public static final MinimumInterarrivalPolicy IGNORE

Represents the "IGNORE" policy for minimum interarrival time. Under this policy, when an arrival time of a release occurs at a time less than the last release time plus its minimum interarrival time, the new arrival time is ignored.

REPLACE

public static final MinimumInterarrivalPolicy REPLACE

Represents the "REPLACE" policy for minimum interarrival time. Under this policy, when an arrival time of a release occurs at a time less than the last release time plus its minimum interarrival time, the information for this arrival replaces a previous arrival. For cases when the previous event has already been released or the event queue has a length of zero, the arrival is ignored as with the IGNORE policy.

SAVE

public static final MinimumInterarrivalPolicy SAVE

Represents the "SAVE" policy for minimum interarrival time. Under this policy, when an arrival time of a release occurs at a time less than the last release time plus its minimum interarrival time, the new release is queued until the last release time plus its minimum interarrival time is reached, but its deadline is not changed.

Method Detail

values

public static MinimumInterarrivalPolicy[] 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 (MinimumInterarrivalPolicy c : MinimumInterarrivalPolicy.values())
    System.out.println(c);

Returns:

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

valueOf

public static MinimumInterarrivalPolicy 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

value

public static MinimumInterarrivalPolicy value(java.lang.String value)

Converts a string into a policy type.

Parameters:

value - is the string to convert.

Returns:

the corresponding policy type.