javax.realtime.memory

Class ScopedConfigurationParameters

java.lang.Object

javax.realtime.ConfigurationParameters

javax.realtime.memory.ScopedConfigurationParameters

All Implemented Interfaces:

Serializable, Cloneable

public class ScopedConfigurationParameters
extends ConfigurationParameters

This is the same as ConfigurationParameters except an instance of BoundSchedulable that uses this parameters object may not access the heap and one that uses the super type may.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ScopedConfigurationParameters(int messageLength, int stackTraceDepth, int classNameLength, int methodNameLength, int fileNameLength, long[] sizes) Similar to ConfigurationParameters.ConfigurationParameters(int, int, int, int, int, long[]), except the receiver may not use the heap.

Method Summary

Modifier and Type	Method and Description
static ConfigurationParameters	getDefault() Set the parameters object to be used when none is provided for an instance of Schedulable.
ReleaseRunner	getDefaultRunner() Gets the system default release runner.
boolean	mayUseHeap() Determines whether or not this schedulable may use the heap.
static void	setDefault(ConfigurationParameters config) Set the parameters object to be used when none is provided for an instance of Schedulable.
static void	setDefaultRunner(ReleaseRunner runner) Sets the system default release runner.

Methods inherited from class javax.realtime.ConfigurationParameters

getClassNameLength, getFileNameLength, getMessageLength, getMethodNameLength, getSizes, getStackTraceDepth

Methods inherited from class java.lang.Object

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

Constructor Detail

ScopedConfigurationParameters

public ScopedConfigurationParameters(int messageLength,
                                     int stackTraceDepth,
                                     int classNameLength,
                                     int methodNameLength,
                                     int fileNameLength,
                                     long[] sizes)
                              throws StaticIllegalStateException

Similar to ConfigurationParameters.ConfigurationParameters(int, int, int, int, int, long[]), except the receiver may not use the heap.

Throws:

StaticIllegalStateException - when the current memory context is a heap memory.

Method Detail

setDefault

public static void setDefault(ConfigurationParameters config)

Set the parameters object to be used when none is provided for an instance of Schedulable. Setting to null restores the default values.

Throws:

StaticIllegalArgumentException - when config supports heap memory allocation.

Parameters:

config - the new default parameter object.

getDefault

public static ConfigurationParameters getDefault()

Set the parameters object to be used when none is provided for an instance of Schedulable.

Returns:

the default parameter object.

setDefaultRunner

public static void setDefaultRunner(ReleaseRunner runner)
                             throws StaticIllegalArgumentException

Sets the system default release runner.

Throws:

StaticIllegalArgumentException - when runner is not allocated in immortal memory or its configuration parameters are not ScopedConfigurationParameters.

Parameters:

runner - The runner to be used when none is set. When null, the default release runner is set to the original system default.

mayUseHeap

public boolean mayUseHeap()

Description copied from class: ConfigurationParameters

Determines whether or not this schedulable may use the heap.

Overrides:

mayUseHeap in class ConfigurationParameters

Returns:

true only when this configuration may allocate on the heap and may enter the Heap.

getDefaultRunner

public ReleaseRunner getDefaultRunner()

Gets the system default release runner.

Overrides:

getDefaultRunner in class ConfigurationParameters

Returns:

a general runner to be used when none is set.