javax.realtime

Class PriorityParameters

java.lang.Object

javax.realtime.SchedulingParameters

javax.realtime.PriorityParameters

All Implemented Interfaces:

Serializable, Cloneable, Subsumable<SchedulingParameters>

Direct Known Subclasses:

ImportanceParameters

public class PriorityParameters
extends SchedulingParameters
implements Cloneable

Jamaica Real-Time Specification for Java class PriorityParameters.

The default scheduler, PriorityScheduler, uses the priority value provided in the PriorityParameters associated to a schedulable object to determine the execution eligibility.

If two schedulable objects with different current priority values are ready to run, the schedulable object with the higher current priority will always be executed in precedence to the one with lower actual priority.

The current priority is equal to the base priority if no priority inversion avoidance mechanism has increased the priority to a higher value.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PriorityParameters(int priority) Constructor to create instance of PriorityParameters with the given initial priority value.
PriorityParameters(int priority, Affinity affinity) Creates an instance of PriorityParameters with the given features.

Method Summary

Modifier and Type	Method and Description
Object	clone() clone creates a clone of this object with the same parameters but without association to any schedulable object
int	getPriority() getPriority returns the current priority value
PriorityParameters	setPriority(int priority) setPriority changes the priority value of this and the current base priority of all schedulable objects that are associated with this.
boolean	subsumes(SchedulingParameters other) Indicates that some set represented by other is subsumed by the set represented by this object.
String	toString() toString creates a string of the form "PriorityParameters(" + priority + ")"

Methods inherited from class javax.realtime.SchedulingParameters

getAffinity

Methods inherited from class java.lang.Object

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

Constructor Detail

PriorityParameters

public PriorityParameters(int priority)

Constructor to create instance of PriorityParameters with the given initial priority value.

Parameters:

priority - the initial priority value.

PriorityParameters

public PriorityParameters(int priority,
                          Affinity affinity)

Creates an instance of PriorityParameters with the given features.

Parameters:

priority - The priority assigned to schedulables that use this parameter instance.

affinity - The affinity assigned to schedulables that use this parameter instance.

Since:

RTSJ 2.0

Method Detail

getPriority

public int getPriority()

getPriority returns the current priority value

Returns:

the current priority value.

setPriority

public PriorityParameters setPriority(int priority)
                               throws StaticIllegalArgumentException

setPriority changes the priority value of this and the current base priority of all schedulable objects that are associated with this.

Throws:

StaticIllegalArgumentException - when priority is not applicable to any scheduler of the associated schedulable objects

Parameters:

priority - the new priority value.

subsumes

public boolean subsumes(SchedulingParameters other)

Description copied from interface: Subsumable

Indicates that some set represented by other is subsumed by the set represented by this object.

Specified by:

subsumes in interface Subsumable<SchedulingParameters>

Overrides:

subsumes in class SchedulingParameters

Parameters:

other - The object to be compared with.

Returns:

true when and only when the set represented by other is subsumed by the set represented by this object.

toString

public String toString()

toString creates a string of the form "PriorityParameters(" + priority + ")"

Overrides:

toString in class Object

Returns:

the string representation of this.

clone

public Object clone()

clone creates a clone of this object with the same parameters but without association to any schedulable object

Overrides:

clone in class SchedulingParameters

Returns:

a new instance of PriorityParameters with equal priority argument.

Since:

RTSJ V1.0.1

See Also:

Cloneable