javax.realtime.device

Class InterruptDescriptor

java.lang.Object

javax.realtime.device.InterruptDescriptor

public class InterruptDescriptor
extends java.lang.Object

A class to manage valid interrupts and provide names for them. It provides both lookup and enumeration via a visitor. Both the names and the values are implementation dependent.

Method Summary

Modifier and Type	Method and Description
static InterruptDescriptor	create(long id, java.lang.String name) Create a new interrupt descriptor.
static InterruptDescriptor	get(java.lang.String name) Get a memory interrupt descriptor by name.
long	getID() Obtains the id of this interrupt descriptor.
java.lang.String	getName() Obtains the name of this interrupt descriptor.
static boolean	isInterrupt(java.lang.String name) Ask whether or not there is a memory interrupt descriptor of a given name.
java.lang.String	toString() Gets a printable representation for a descriptor.
static void	visitInterrupts(java.util.function.Consumer<InterruptDescriptor> visitor) Visit all valid interrupt identifiers.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static InterruptDescriptor create(long id,
                                         java.lang.String name)
                                  throws StaticIllegalArgumentException,
                                         StaticIllegalStateException

Create a new interrupt descriptor.

Parameters:

id - the numerical ID of the new descriptor.

name - of the descriptor

Returns:

the corresponding interrupt descriptor object.

Throws:

StaticIllegalArgumentException - when name is null.

StaticIllegalStateException - when a descriptor with name already exists.

get

public static InterruptDescriptor get(java.lang.String name)
                               throws StaticIllegalArgumentException

Get a memory interrupt descriptor by name.

Parameters:

name - of the descriptor

Returns:

the interrupt descriptor object or null, when none with name exists.

Throws:

StaticIllegalArgumentException - when name is null.

isInterrupt

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

Ask whether or not there is a memory interrupt descriptor of a given name.

Parameters:

name - for which to search

Returns:

true when there is one and false otherwise.

visitInterrupts

public static void visitInterrupts(java.util.function.Consumer<InterruptDescriptor> visitor)

Visit all valid interrupt identifiers. Each valid interrupt identifier corresponds to hardware interrupt line. Their values are system dependent.

Parameters:

visitor - the code to execute on each descriptor.

getName

public final java.lang.String getName()

Obtains the name of this interrupt descriptor.

Returns:

the interrupt descriptors name

getID

public final long getID()

Obtains the id of this interrupt descriptor.

Returns:

the interrupt descriptors name

toString

public final java.lang.String toString()

Gets a printable representation for a descriptor.

Overrides:

toString in class java.lang.Object

Returns:

the printable form of this memory interrupt descriptor.