com.oracle.deviceaccess.mmio

Interface RawRegister<T extends java.lang.Number>

Type Parameters:

T - the type of the value held by the register.

All Superinterfaces:

RawMemory

public interface RawRegister<T extends java.lang.Number>
extends RawMemory

The RawRegister interface provides methods for setting and getting the value of a register or memory area holding a value of type byte, short, int or long. A RawRegister instance can be obtained from a MMIODevice instance.

Developers should be aware when using this API of the potential performance and memory allocation penalty induced by primitive auto-boxing. For intensive reading and writing of registers such as data input and data output registers, the use of the RawBlock returned by MMIODevice.getAsRawBlock() should be preferred.

Method Summary

Methods

Modifier and Type	Method and Description
void	and(T value) Sets the value at the memory area associated with this object to the result of performing a logical AND of the value at the memory area with the argument value.
void	clearBit(int index) Clears (sets to 0) the designated bit value at the memory area associated with this object.
void	clearBits(T mask) Clears (sets to 0) the specified bits at the memory area associated with this object.
T	get() Gets the value at the memory area associated with this object.
java.lang.Class<T>	getType() Returns the type of the value this RawRegister instance can hold.
boolean	isBitSet(int index) Checks whether the designated bit value at the memory area associated with this object is set (equal to 1 )
void	or(T value) Sets the value at the memory area associated with this object to the result of performing a logical OR of the value at the memory area with the argument value.
void	set(T value) Sets the value at the memory area associated with this object.
void	setBit(int index) Sets (to 1) the designated bit value at the memory area associated with this object.
void	setBits(T mask) Sets (to 1) the specified bits at the memory area associated with this object.
void	xor(T value) Sets the value at the memory area associated with this object to the result of performing a logical XOR of the value at the memory area with the argument value.

Methods inherited from interface com.oracle.deviceaccess.mmio.RawMemory

getName

Method Detail

and

void and(T value)
         throws java.io.IOException,
                UnavailablePeripheralException,
                ClosedPeripheralException

Sets the value at the memory area associated with this object to the result of performing a logical AND of the value at the memory area with the argument value.

Parameters:

value - the value to perform a logical AND with.

Throws:

java.io.IOException - if the associated memory area is not writable.

UnavailablePeripheralException - if this peripheral is not currently available - such as it is locked by another application.

ClosedPeripheralException - if the peripheral has been closed.

clearBit

void clearBit(int index)
              throws java.io.IOException,
                     UnavailablePeripheralException,
                     ClosedPeripheralException

Clears (sets to 0) the designated bit value at the memory area associated with this object.

Parameters:

index - the index of the bit.

Throws:

java.io.IOException - if the associated memory area is not writable.

UnavailablePeripheralException - if this peripheral is not currently available - such as it is locked by another application.

ClosedPeripheralException - if the peripheral has been closed.

java.lang.IllegalArgumentException - if index is less than 0 or greater or equal to the size in bits of the value at the memory area associated with this object.

clearBits

void clearBits(T mask)
               throws java.io.IOException,
                      UnavailablePeripheralException,
                      ClosedPeripheralException

Clears (sets to 0) the specified bits at the memory area associated with this object.

Parameters:

mask - the bit mask.

Throws:

java.io.IOException - if the associated memory area is not writable.

UnavailablePeripheralException - if this peripheral is not currently available - such as it is locked by another application.

ClosedPeripheralException - if the peripheral has been closed.

get

T get()
                               throws java.io.IOException,
                                      UnavailablePeripheralException,
                                      ClosedPeripheralException

Gets the value at the memory area associated with this object.

Returns:

the value.

Throws:

java.io.IOException - if the associated memory area is not readable.

UnavailablePeripheralException - if this peripheral is not currently available - such as it is locked by another application.

ClosedPeripheralException - if the peripheral has been closed.

getType

java.lang.Class<T> getType()

Returns the type of the value this RawRegister instance can hold.

Returns:

this RawRegister instance's value type.

isBitSet

boolean isBitSet(int index)
                 throws java.io.IOException,
                        UnavailablePeripheralException,
                        ClosedPeripheralException

Checks whether the designated bit value at the memory area associated with this object is set (equal to 1 )

Parameters:

index - the index of the bit.

Returns:

the bit value.

Throws:

java.io.IOException - if the associated memory area is not readable.

UnavailablePeripheralException - if this peripheral is not currently available - such as it is locked by another application.

ClosedPeripheralException - if the peripheral has been closed.

java.lang.IllegalArgumentException - if index is less than 0 or greater or equal to the size in bits of the value at the memory area associated with this object.

or

void or(T value)
        throws java.io.IOException,
               UnavailablePeripheralException,
               ClosedPeripheralException

Sets the value at the memory area associated with this object to the result of performing a logical OR of the value at the memory area with the argument value.

Parameters:

value - the value to perform a logical OR with.

Throws:

java.io.IOException - if the associated memory area is not writable.

UnavailablePeripheralException - if this peripheral is not currently available - such as it is locked by another application.

ClosedPeripheralException - if the peripheral has been closed.

set

void set(T value)
         throws java.io.IOException,
                UnavailablePeripheralException,
                ClosedPeripheralException

Sets the value at the memory area associated with this object.

Parameters:

value - the value to set.

Throws:

java.io.IOException - if the associated memory area is not writable.

UnavailablePeripheralException - if this peripheral is not currently available - such as it is locked by another application.

ClosedPeripheralException - if the peripheral has been closed.

setBit

void setBit(int index)
            throws java.io.IOException,
                   UnavailablePeripheralException,
                   ClosedPeripheralException

Sets (to 1) the designated bit value at the memory area associated with this object.

Parameters:

index - the index of the bit.

Throws:

java.io.IOException - if the associated memory area is not writable.

UnavailablePeripheralException - if this peripheral is not currently available - such as it is locked by another application.

ClosedPeripheralException - if the peripheral has been closed.

java.lang.IllegalArgumentException - if index is less than 0 or greater or equal to the size in bits of the value at the memory area associated with this object.

setBits

void setBits(T mask)
             throws java.io.IOException,
                    UnavailablePeripheralException,
                    ClosedPeripheralException

Sets (to 1) the specified bits at the memory area associated with this object.

Parameters:

mask - the bit mask.

Throws:

java.io.IOException - if the associated memory area is not writable.

UnavailablePeripheralException - if this peripheral is not currently available - such as it is locked by another application.

ClosedPeripheralException - if the peripheral has been closed.

xor

void xor(T value)
         throws java.io.IOException,
                UnavailablePeripheralException,
                ClosedPeripheralException

Sets the value at the memory area associated with this object to the result of performing a logical XOR of the value at the memory area with the argument value.

Parameters:

value - the value to perform a logical XOR with.

Throws:

java.io.IOException - if the associated memory area is not writable.

UnavailablePeripheralException - if this peripheral is not currently available - such as it is locked by another application.

ClosedPeripheralException - if the peripheral has been closed.