javax.realtime

Class PriorityParameters

java.lang.Object

javax.realtime.SchedulingParameters

javax.realtime.PriorityParameters

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Subsumable<SchedulingParameters>

Direct Known Subclasses:

FirstInFirstOutParameters, ImportanceParameters

public class PriorityParameters
extends SchedulingParameters

Instances of this class should be assigned to schedulables that are managed by schedulers which use a single integer to determine execution order. The base scheduler required by this specification and represented by the class PriorityScheduler is such a scheduler.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	getPriority() Gets the priority value.
boolean	isCompatible(Scheduler scheduler) Determines whether this scheduling parameters can be used by tasks scheduled by scheduler.
PriorityParameters	setPriority(int priority) Deprecated. since RTSJ 2.0
boolean	subsumes(SchedulingParameters other) Determines whether this parameters is more eligible than another.
java.lang.String	toString() Converts the priority value to a string.

Methods inherited from class javax.realtime.SchedulingParameters

clone, getAffinity

Methods inherited from class java.lang.Object

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

Constructor Detail

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

PriorityParameters

public PriorityParameters(int priority)

Creates an instance of PriorityParameters with the default affinity.

Parameters:

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

Method Detail

getPriority

public int getPriority()

Gets the priority value.

Returns:

the priority.

setPriority

@Deprecated
public PriorityParameters setPriority(int priority)

Deprecated. since RTSJ 2.0

Sets the priority value. When this parameter object is associated with any schedulable (by being passed through the schedulable's constructor or set with a method such as RealtimeThread.setSchedulingParameters(SchedulingParameters)) the base priority of those schedulables is altered as specified by each schedulable's scheduler.

Parameters:

priority - The value to which priority is set.

Returns:

this

Throws:

StaticIllegalArgumentException - when the given priority value is incompatible with the scheduler for any of the schedulables which are presently using this parameter object.

isCompatible

public boolean isCompatible(Scheduler scheduler)

Description copied from class: SchedulingParameters

Determines whether this scheduling parameters can be used by tasks scheduled by scheduler.

Overrides:

isCompatible in class SchedulingParameters

Parameters:

scheduler - The scheduler to check against

Returns:

true when and only when this can be used with scheduler as the scheduler.

subsumes

public boolean subsumes(SchedulingParameters other)

Description copied from class: SchedulingParameters

Determines whether this parameters is more eligible than another.

Specified by:

subsumes in interface Subsumable<SchedulingParameters>

Overrides:

subsumes in class SchedulingParameters

Parameters:

other - The other parameters object to be compared with.

Returns:

true when and only when this parameters is more eligible than the other parameters.

toString

public java.lang.String toString()

Converts the priority value to a string.

Overrides:

toString in class java.lang.Object

Returns:

a string representing the value of priority.