javax.realtime.device

Interface RawMemoryRegionFactory

public interface RawMemoryRegionFactory

A means of giving an application the ability to provide support for a RawMemoryRegion that is not already provided by the standard. An instance of this interface can be registered with a RawMemoryFactory and provide the object that that factory should return for with a given RawMemoryRegion. It is responsible for checking all requests and throwing the proper exception when a request is invalid or the requester is not authorized to make the request.

Since:

RTSJ 2.0

Method Summary

Modifier and Type	Method and Description
RawByte	createRawByte(long base, int count, int stride) Creates an instance of a class that implements RawByte and accesses memory of getRegion() in the address range described by base, stride, and count.
RawByteReader	createRawByteReader(long base, int count, int stride) Creates an instance of a class that implements RawByteReader and accesses memory of getRegion() in the address range described by base, stride, and count.
RawByteWriter	createRawByteWriter(long base, int count, int stride) Creates an instance of a class that implements RawByteWriter and accesses memory of getRegion() in the address range described by base, stride, and count.
RawDouble	createRawDouble(long base, int count, int stride) Creates an instance of a class that implements RawDouble and accesses memory of getRegion() in the address range described by base, stride, and count.
RawDoubleReader	createRawDoubleReader(long base, int count, int stride) Creates an instance of a class that implements RawDoubleReader and accesses memory of getRegion() in the address range described by base, stride, and count.
RawDoubleWriter	createRawDoubleWriter(long base, int count, int stride) Creates an instance of a class that implements RawDoubleWriter and accesses memory of getRegion() in the address range described by base, stride, and count.
RawFloat	createRawFloat(long base, int count, int stride) Creates an instance of a class that implements RawFloat and accesses memory of getRegion() in the address range described by base, stride, and count.
RawFloatReader	createRawFloatReader(long base, int count, int stride) Creates an instance of a class that implements RawFloatReader and accesses memory of getRegion() in the address range described by base, stride, and count.
RawFloatWriter	createRawFloatWriter(long base, int count, int stride) Creates an instance of a class that implements RawFloatWriter and accesses memory of getRegion() in the address range described by base, stride, and count.
RawInt	createRawInt(long base, int count, int stride) Creates an instance of a class that implements RawInt and accesses memory of getRegion() in the address range described by base, stride, and count.
RawIntReader	createRawIntReader(long base, int count, int stride) Creates an instance of a class that implements RawIntReader and accesses memory of getRegion() in the address range described by base, stride, and count.
RawIntWriter	createRawIntWriter(long base, int count, int stride) Creates an instance of a class that implements RawIntWriter and accesses memory of getRegion() in the address range described by base, stride, and count.
RawLong	createRawLong(long base, int count, int stride) Creates an instance of a class that implements RawLong and accesses memory of getRegion() in the address range described by base, stride, and count.
RawLongReader	createRawLongReader(long base, int count, int stride) Creates an instance of a class that implements RawLongReader and accesses memory of getRegion() in the address range described by base, stride, and count.
RawLongWriter	createRawLongWriter(long base, int count, int stride) Creates an instance of a class that implements RawLongWriter and accesses memory of getRegion() in the address range described by base, stride, and count.
RawShort	createRawShort(long base, int count, int stride) Creates an instance of a class that implements RawShort and accesses memory of getRegion() in the address range described by base, stride, and count.
RawShortReader	createRawShortReader(long base, int count, int stride) Creates an instance of a class that implements RawShortReader and accesses memory of getRegion() in the address range described by base, stride, and count.
RawShortWriter	createRawShortWriter(long base, int count, int stride) Creates an instance of a class that implements RawShortWriter and accesses memory of getRegion() in the address range described by base, stride, and count.
java.lang.String	getName() Determines the name of the region for which this factory creates raw memory objects.
RawMemoryRegion	getRegion() Determines for what region this factory creates raw memory objects.

Method Detail

getRegion

RawMemoryRegion getRegion()

Determines for what region this factory creates raw memory objects.

Returns:

the region of this factory.

createRawByte

RawByte createRawByte(long base,
                      int count,
                      int stride)
               throws java.lang.SecurityException,
                      java.lang.IllegalArgumentException,
                      OffsetOutOfBoundsException,
                      SizeOutOfBoundsException

Creates an instance of a class that implements RawByte and accesses memory of getRegion() in the address range described by base, stride, and count. The actual extent of the memory addressed by the object is stride × size of byte × count. The object is allocated in the current memory area of the calling thread.

Parameters:

base - The starting physical address accessible through the returned instance.

count - The number of memory elements accessible through the returned instance.

stride - The distance to the next element in mulitple of element count, where a value of 1 means the elements are adjacent in memory.

Returns:

an object that implements RawByte and supports access to the specified range in the memory region.

Throws:

java.lang.SecurityException - when the caller does not have permissions to access the given memory region or the specified range of addresses.

java.lang.IllegalArgumentException - when base is negative, count is not greater than zero, or stride is not greater than zero.

OffsetOutOfBoundsException - when base is invalid.

SizeOutOfBoundsException - when the memory addressed by the object would extend into an invalid range of memory.

createRawByteReader

RawByteReader createRawByteReader(long base,
                                  int count,
                                  int stride)
                           throws java.lang.SecurityException,
                                  java.lang.IllegalArgumentException,
                                  OffsetOutOfBoundsException,
                                  SizeOutOfBoundsException

Creates an instance of a class that implements RawByteReader and accesses memory of getRegion() in the address range described by base, stride, and count. The actual extent of the memory addressed by the object is stride × size of byte × count. The object is allocated in the current memory area of the calling thread.

Parameters:

base - The starting physical address accessible through the returned instance.

count - The number of memory elements accessible through the returned instance.

stride - The distance to the next element in mulitple of element count, where a value of 1 means the elements are adjacent in memory.

Returns:

an object that implements RawByteReader and supports access to the specified range in the memory region.

Throws:

java.lang.SecurityException - when the caller does not have permissions to access the given memory region or the specified range of addresses.

java.lang.IllegalArgumentException - when base is negative, count is not greater than zero, or stride is not greater than zero.

OffsetOutOfBoundsException - when base is invalid.

SizeOutOfBoundsException - when the memory addressed by the object would extend into an invalid range of memory.

createRawByteWriter

RawByteWriter createRawByteWriter(long base,
                                  int count,
                                  int stride)
                           throws java.lang.SecurityException,
                                  java.lang.IllegalArgumentException,
                                  OffsetOutOfBoundsException,
                                  SizeOutOfBoundsException

Creates an instance of a class that implements RawByteWriter and accesses memory of getRegion() in the address range described by base, stride, and count. The actual extent of the memory addressed by the object is stride × size of byte × count. The object is allocated in the current memory area of the calling thread.

Parameters:

base - The starting physical address accessible through the returned instance.

count - The number of memory elements accessible through the returned instance.

stride - The distance to the next element in mulitple of element count, where a value of 1 means the elements are adjacent in memory.

Returns:

an object that implements RawByteWriter and supports access to the specified range in the memory region.

Throws:

java.lang.SecurityException - when the caller does not have permissions to access the given memory region or the specified range of addresses.

java.lang.IllegalArgumentException - when base is negative, count is not greater than zero, or stride is not greater than zero.

OffsetOutOfBoundsException - when base is invalid.

SizeOutOfBoundsException - when the memory addressed by the object would extend into an invalid range of memory.

createRawShort

RawShort createRawShort(long base,
                        int count,
                        int stride)
                 throws java.lang.SecurityException,
                        java.lang.IllegalArgumentException,
                        OffsetOutOfBoundsException,
                        SizeOutOfBoundsException

Creates an instance of a class that implements RawShort and accesses memory of getRegion() in the address range described by base, stride, and count. The actual extent of the memory addressed by the object is stride × size of short × count. The object is allocated in the current memory area of the calling thread.

Parameters:

base - The starting physical address accessible through the returned instance.

count - The number of memory elements accessible through the returned instance.

stride - The distance to the next element in mulitple of element count, where a value of 1 means the elements are adjacent in memory.

Returns:

an object that implements RawShort and supports access to the specified range in the memory region.

Throws:

java.lang.SecurityException - when the caller does not have permissions to access the given memory region or the specified range of addresses.

java.lang.IllegalArgumentException - when base is negative, count is not greater than zero, or stride is not greater than zero.

OffsetOutOfBoundsException - when base is invalid.

SizeOutOfBoundsException - when the memory addressed by the object would extend into an invalid range of memory.

createRawShortReader

RawShortReader createRawShortReader(long base,
                                    int count,
                                    int stride)
                             throws java.lang.SecurityException,
                                    java.lang.IllegalArgumentException,
                                    OffsetOutOfBoundsException,
                                    SizeOutOfBoundsException

Creates an instance of a class that implements RawShortReader and accesses memory of getRegion() in the address range described by base, stride, and count. The actual extent of the memory addressed by the object is stride × size of short × count. The object is allocated in the current memory area of the calling thread.

Parameters:

base - The starting physical address accessible through the returned instance.

count - The number of memory elements accessible through the returned instance.

stride - The distance to the next element in mulitple of element count, where a value of 1 means the elements are adjacent in memory.

Returns:

an object that implements RawShortReader and supports access to the specified range in the memory region.

Throws:

java.lang.SecurityException - when the caller does not have permissions to access the given memory region or the specified range of addresses.

java.lang.IllegalArgumentException - when base is negative, count is not greater than zero, or stride is not greater than zero.

OffsetOutOfBoundsException - when base is invalid.

SizeOutOfBoundsException - when the memory addressed by the object would extend into an invalid range of memory.

createRawShortWriter

RawShortWriter createRawShortWriter(long base,
                                    int count,
                                    int stride)
                             throws java.lang.SecurityException,
                                    java.lang.IllegalArgumentException,
                                    OffsetOutOfBoundsException,
                                    SizeOutOfBoundsException

Creates an instance of a class that implements RawShortWriter and accesses memory of getRegion() in the address range described by base, stride, and count. The actual extent of the memory addressed by the object is stride × size of short × count. The object is allocated in the current memory area of the calling thread.

Parameters:

base - The starting physical address accessible through the returned instance.

count - The number of memory elements accessible through the returned instance.

stride - The distance to the next element in mulitple of element count, where a value of 1 means the elements are adjacent in memory.

Returns:

an object that implements RawShortWriter and supports access to the specified range in the memory region.

Throws:

java.lang.SecurityException - when the caller does not have permissions to access the given memory region or the specified range of addresses.

java.lang.IllegalArgumentException - when base is negative, count is not greater than zero, or stride is not greater than zero.

OffsetOutOfBoundsException - when base is invalid.

SizeOutOfBoundsException - when the memory addressed by the object would extend into an invalid range of memory.

createRawInt

RawInt createRawInt(long base,
                    int count,
                    int stride)
             throws java.lang.SecurityException,
                    java.lang.IllegalArgumentException,
                    OffsetOutOfBoundsException,
                    SizeOutOfBoundsException

Creates an instance of a class that implements RawInt and accesses memory of getRegion() in the address range described by base, stride, and count. The actual extent of the memory addressed by the object is stride × size of int × count. The object is allocated in the current memory area of the calling thread.

Parameters:

base - The starting physical address accessible through the returned instance.

count - The number of memory elements accessible through the returned instance.

stride - The distance to the next element in mulitple of element count, where a value of 1 means the elements are adjacent in memory.

Returns:

an object that implements RawInt and supports access to the specified range in the memory region.

Throws:

java.lang.SecurityException - when the caller does not have permissions to access the given memory region or the specified range of addresses.

java.lang.IllegalArgumentException - when base is negative, count is not greater than zero, or stride is not greater than zero.

OffsetOutOfBoundsException - when base is invalid.

SizeOutOfBoundsException - when the memory addressed by the object would extend into an invalid range of memory.

createRawIntReader

RawIntReader createRawIntReader(long base,
                                int count,
                                int stride)
                         throws java.lang.SecurityException,
                                java.lang.IllegalArgumentException,
                                OffsetOutOfBoundsException,
                                SizeOutOfBoundsException

Creates an instance of a class that implements RawIntReader and accesses memory of getRegion() in the address range described by base, stride, and count. The actual extent of the memory addressed by the object is stride × size of int × count. The object is allocated in the current memory area of the calling thread.

Parameters:

base - The starting physical address accessible through the returned instance.

count - The number of memory elements accessible through the returned instance.

stride - The distance to the next element in mulitple of element count, where a value of 1 means the elements are adjacent in memory.

Returns:

an object that implements RawIntReader and supports access to the specified range in the memory region.

Throws:

java.lang.SecurityException - when the caller does not have permissions to access the given memory region or the specified range of addresses.

java.lang.IllegalArgumentException - when base is negative, count is not greater than zero, or stride is not greater than zero.

OffsetOutOfBoundsException - when base is invalid.

SizeOutOfBoundsException - when the memory addressed by the object would extend into an invalid range of memory.

createRawIntWriter

RawIntWriter createRawIntWriter(long base,
                                int count,
                                int stride)
                         throws java.lang.SecurityException,
                                java.lang.IllegalArgumentException,
                                OffsetOutOfBoundsException,
                                SizeOutOfBoundsException

Creates an instance of a class that implements RawIntWriter and accesses memory of getRegion() in the address range described by base, stride, and count. The actual extent of the memory addressed by the object is stride × size of int × count. The object is allocated in the current memory area of the calling thread.

Parameters:

base - The starting physical address accessible through the returned instance.

count - The number of memory elements accessible through the returned instance.

stride - The distance to the next element in mulitple of element count, where a value of 1 means the elements are adjacent in memory.

Returns:

an object that implements RawIntWriter and supports access to the specified range in the memory region.

Throws:

java.lang.SecurityException - when the caller does not have permissions to access the given memory region or the specified range of addresses.

java.lang.IllegalArgumentException - when base is negative, count is not greater than zero, or stride is not greater than zero.

OffsetOutOfBoundsException - when base is invalid.

SizeOutOfBoundsException - when the memory addressed by the object would extend into an invalid range of memory.

createRawLong

RawLong createRawLong(long base,
                      int count,
                      int stride)
               throws java.lang.SecurityException,
                      java.lang.IllegalArgumentException,
                      OffsetOutOfBoundsException,
                      SizeOutOfBoundsException

Creates an instance of a class that implements RawLong and accesses memory of getRegion() in the address range described by base, stride, and count. The actual extent of the memory addressed by the object is stride × size of long × count. The object is allocated in the current memory area of the calling thread.

Parameters:

base - The starting physical address accessible through the returned instance.

count - The number of memory elements accessible through the returned instance.

stride - The distance to the next element in mulitple of element count, where a value of 1 means the elements are adjacent in memory.

Returns:

an object that implements RawLong and supports access to the specified range in the memory region.

Throws:

java.lang.SecurityException - when the caller does not have permissions to access the given memory region or the specified range of addresses.

java.lang.IllegalArgumentException - when base is negative, count is not greater than zero, or stride is not greater than zero.

OffsetOutOfBoundsException - when base is invalid.

SizeOutOfBoundsException - when the memory addressed by the object would extend into an invalid range of memory.

createRawLongReader

RawLongReader createRawLongReader(long base,
                                  int count,
                                  int stride)
                           throws java.lang.SecurityException,
                                  java.lang.IllegalArgumentException,
                                  OffsetOutOfBoundsException,
                                  SizeOutOfBoundsException

Creates an instance of a class that implements RawLongReader and accesses memory of getRegion() in the address range described by base, stride, and count. The actual extent of the memory addressed by the object is stride × size of long × count. The object is allocated in the current memory area of the calling thread.

Parameters:

base - The starting physical address accessible through the returned instance.

count - The number of memory elements accessible through the returned instance.

stride - The distance to the next element in mulitple of element count, where a value of 1 means the elements are adjacent in memory.

Returns:

an object that implements RawLongReader and supports access to the specified range in the memory region.

Throws:

java.lang.SecurityException - when the caller does not have permissions to access the given memory region or the specified range of addresses.

java.lang.IllegalArgumentException - when base is negative, count is not greater than zero, or stride is not greater than zero.

OffsetOutOfBoundsException - when base is invalid.

SizeOutOfBoundsException - when the memory addressed by the object would extend into an invalid range of memory.

createRawLongWriter

RawLongWriter createRawLongWriter(long base,
                                  int count,
                                  int stride)
                           throws java.lang.SecurityException,
                                  java.lang.IllegalArgumentException,
                                  OffsetOutOfBoundsException,
                                  SizeOutOfBoundsException

Creates an instance of a class that implements RawLongWriter and accesses memory of getRegion() in the address range described by base, stride, and count. The actual extent of the memory addressed by the object is stride × size of long × count. The object is allocated in the current memory area of the calling thread.

Parameters:

base - The starting physical address accessible through the returned instance.

count - The number of memory elements accessible through the returned instance.

stride - The distance to the next element in mulitple of element count, where a value of 1 means the elements are adjacent in memory.

Returns:

an object that implements RawLongWriter and supports access to the specified range in the memory region.

Throws:

java.lang.SecurityException - when the caller does not have permissions to access the given memory region or the specified range of addresses.

java.lang.IllegalArgumentException - when base is negative, count is not greater than zero, or stride is not greater than zero.

OffsetOutOfBoundsException - when base is invalid.

SizeOutOfBoundsException - when the memory addressed by the object would extend into an invalid range of memory.

createRawFloat

RawFloat createRawFloat(long base,
                        int count,
                        int stride)
                 throws java.lang.SecurityException,
                        java.lang.IllegalArgumentException,
                        OffsetOutOfBoundsException,
                        SizeOutOfBoundsException

Creates an instance of a class that implements RawFloat and accesses memory of getRegion() in the address range described by base, stride, and count. The actual extent of the memory addressed by the object is stride × size of float × count. The object is allocated in the current memory area of the calling thread.

Parameters:

base - The starting physical address accessible through the returned instance.

count - The number of memory elements accessible through the returned instance.

stride - The distance to the next element in mulitple of element count, where a value of 1 means the elements are adjacent in memory.

Returns:

an object that implements RawFloat and supports access to the specified range in the memory region.

Throws:

java.lang.SecurityException - when the caller does not have permissions to access the given memory region or the specified range of addresses.

java.lang.IllegalArgumentException - when base is negative, count is not greater than zero, or stride is not greater than zero.

OffsetOutOfBoundsException - when base is invalid.

SizeOutOfBoundsException - when the memory addressed by the object would extend into an invalid range of memory.

createRawFloatReader

RawFloatReader createRawFloatReader(long base,
                                    int count,
                                    int stride)
                             throws java.lang.SecurityException,
                                    java.lang.IllegalArgumentException,
                                    OffsetOutOfBoundsException,
                                    SizeOutOfBoundsException

Creates an instance of a class that implements RawFloatReader and accesses memory of getRegion() in the address range described by base, stride, and count. The actual extent of the memory addressed by the object is stride × size of float × count. The object is allocated in the current memory area of the calling thread.

Parameters:

base - The starting physical address accessible through the returned instance.

count - The number of memory elements accessible through the returned instance.

stride - The distance to the next element in mulitple of element count, where a value of 1 means the elements are adjacent in memory.

Returns:

an object that implements RawFloatReader and supports access to the specified range in the memory region.

Throws:

java.lang.SecurityException - when the caller does not have permissions to access the given memory region or the specified range of addresses.

java.lang.IllegalArgumentException - when base is negative, count is not greater than zero, or stride is not greater than zero.

OffsetOutOfBoundsException - when base is invalid.

SizeOutOfBoundsException - when the memory addressed by the object would extend into an invalid range of memory.

createRawFloatWriter

RawFloatWriter createRawFloatWriter(long base,
                                    int count,
                                    int stride)
                             throws java.lang.SecurityException,
                                    java.lang.IllegalArgumentException,
                                    OffsetOutOfBoundsException,
                                    SizeOutOfBoundsException

Creates an instance of a class that implements RawFloatWriter and accesses memory of getRegion() in the address range described by base, stride, and count. The actual extent of the memory addressed by the object is stride × size of float × count. The object is allocated in the current memory area of the calling thread.

Parameters:

base - The starting physical address accessible through the returned instance.

count - The number of memory elements accessible through the returned instance.

stride - The distance to the next element in mulitple of element count, where a value of 1 means the elements are adjacent in memory.

Returns:

an object that implements RawFloatWriter and supports access to the specified range in the memory region.

Throws:

java.lang.SecurityException - when the caller does not have permissions to access the given memory region or the specified range of addresses.

java.lang.IllegalArgumentException - when base is negative, count is not greater than zero, or stride is not greater than zero.

OffsetOutOfBoundsException - when base is invalid.

SizeOutOfBoundsException - when the memory addressed by the object would extend into an invalid range of memory.

createRawDouble

RawDouble createRawDouble(long base,
                          int count,
                          int stride)
                   throws java.lang.SecurityException,
                          java.lang.IllegalArgumentException,
                          OffsetOutOfBoundsException,
                          SizeOutOfBoundsException

Creates an instance of a class that implements RawDouble and accesses memory of getRegion() in the address range described by base, stride, and count. The actual extent of the memory addressed by the object is stride × size of double × count. The object is allocated in the current memory area of the calling thread.

Parameters:

base - The starting physical address accessible through the returned instance.

count - The number of memory elements accessible through the returned instance.

stride - The distance to the next element in mulitple of element count, where a value of 1 means the elements are adjacent in memory.

Returns:

an object that implements RawDouble and supports access to the specified range in the memory region.

Throws:

java.lang.SecurityException - when the caller does not have permissions to access the given memory region or the specified range of addresses.

java.lang.IllegalArgumentException - when base is negative, count is not greater than zero, or stride is not greater than zero.

OffsetOutOfBoundsException - when base is invalid.

SizeOutOfBoundsException - when the memory addressed by the object would extend into an invalid range of memory.

createRawDoubleReader

RawDoubleReader createRawDoubleReader(long base,
                                      int count,
                                      int stride)
                               throws java.lang.SecurityException,
                                      java.lang.IllegalArgumentException,
                                      OffsetOutOfBoundsException,
                                      SizeOutOfBoundsException

Creates an instance of a class that implements RawDoubleReader and accesses memory of getRegion() in the address range described by base, stride, and count. The actual extent of the memory addressed by the object is stride × size of double × count. The object is allocated in the current memory area of the calling thread.

Parameters:

base - The starting physical address accessible through the returned instance.

count - The number of memory elements accessible through the returned instance.

stride - The distance to the next element in mulitple of element count, where a value of 1 means the elements are adjacent in memory.

Returns:

an object that implements RawDoubleReader and supports access to the specified range in the memory region.

Throws:

java.lang.SecurityException - when the caller does not have permissions to access the given memory region or the specified range of addresses.

java.lang.IllegalArgumentException - when base is negative, count is not greater than zero, or stride is not greater than zero.

OffsetOutOfBoundsException - when base is invalid.

SizeOutOfBoundsException - when the memory addressed by the object would extend into an invalid range of memory.

createRawDoubleWriter

RawDoubleWriter createRawDoubleWriter(long base,
                                      int count,
                                      int stride)
                               throws java.lang.SecurityException,
                                      java.lang.IllegalArgumentException,
                                      OffsetOutOfBoundsException,
                                      SizeOutOfBoundsException

Creates an instance of a class that implements RawDoubleWriter and accesses memory of getRegion() in the address range described by base, stride, and count. The actual extent of the memory addressed by the object is stride × size of double × count. The object is allocated in the current memory area of the calling thread.

Parameters:

base - The starting physical address accessible through the returned instance.

count - The number of memory elements accessible through the returned instance.

stride - The distance to the next element in mulitple of element count, where a value of 1 means the elements are adjacent in memory.

Returns:

an object that implements RawDoubleWriter and supports access to the specified range in the memory region.

Throws:

java.lang.SecurityException - when the caller does not have permissions to access the given memory region or the specified range of addresses.

java.lang.IllegalArgumentException - when base is negative, count is not greater than zero, or stride is not greater than zero.

OffsetOutOfBoundsException - when base is invalid.

SizeOutOfBoundsException - when the memory addressed by the object would extend into an invalid range of memory.

getName

java.lang.String getName()

Determines the name of the region for which this factory creates raw memory objects.

Returns:

the name of the region of this factory.