javax.realtime.device

Class RawMemoryRegion

java.lang.Object

javax.realtime.device.RawMemoryRegion

public class RawMemoryRegion
extends java.lang.Object

RawMemoryRegion is a tagging interface for objects that identify raw memory _regions_. It is returned by the RawMemoryRegionFactory.getRegion() methods of the raw memory region factory classes, and it is used with methods such as RawMemoryFactory.createRawByte(RawMemoryRegion, long, int, int) and RawMemoryFactory.createRawDouble(RawMemoryRegion, long, int, int) methods to identify the region from which the application wants to get an accessor instance.

This is distinct from the, similarly named PhysicalMemoryName class, which is used with memory area classes, specifically ImmortalPhysicalMemory and LTPhysicalMemory.

Since:

RTSJ 2.0

Method Summary

Modifier and Type	Method and Description
static RawMemoryRegion	get(java.lang.String name) Get the raw memory region with given name.
java.lang.String	getName() Obtain the name of this raw memory region.
static boolean	isRawMemoryRegion(java.lang.String name) A predicate on names for raw memory regions
java.lang.String	toString() Obtain a string representation of this.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static RawMemoryRegion get(java.lang.String name)

Get the raw memory region with given name.

Parameters:

name - of the region

Returns:

the requested region

Throws:

StaticIllegalArgumentException - when name is null.

isRawMemoryRegion

public static boolean isRawMemoryRegion(java.lang.String name)

A predicate on names for raw memory regions

Parameters:

name - is the name to check

Returns:

true when name names an existing raw memory region.

getName

public final java.lang.String getName()

Obtain the name of this raw memory region.

Returns:

the regions name

toString

public final java.lang.String toString()

Obtain a string representation of this.

Overrides:

toString in class java.lang.Object

Returns:

the string representation of this.