|
2.17.2: 2011-06-17 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.basedb.core.signal.Signal
public class Signal
Represents a signal that can be sent to a class implementing the
SignalTarget
interface. Signals must be registered before they
can be used. Use getSignals()
to get a list of signals
that have been registered. A signal can only be registered once.
Field Summary | |
---|---|
static Signal |
ABORT
The ABORT signal, that requests that the receiver should clean up and die. |
private String |
description
|
private String |
id
|
private String |
name
|
static Signal |
SHUTDOWN
The SHUTDOWN signal, that requests that the receiver should clean up and die. |
private static Map<String,Signal> |
signals
Holds all registered signals. |
Constructor Summary | |
---|---|
private |
Signal(String id,
String name,
String description)
|
Method Summary | |
---|---|
boolean |
equals(Object other)
Two signals are equal if they have the same ID. |
String |
getDescription()
Get the description of the what the signal means and how receivers should behave when the signal is sent to them |
String |
getId()
Get the signal ID. |
String |
getName()
Get the short name of the signal. |
static Signal |
getSignal(String id)
Get the signal with a given ID. |
static Collection<Signal> |
getSignals()
Get all registered signals. |
int |
hashCode()
The hashcode for a signal is the same as the hashcode for the ID. |
static Signal |
registerSignal(String id,
String name,
String description)
Register a signal. |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final Signal ABORT
SHUTDOWN
signal.
public static final Signal SHUTDOWN
ABORT
.
private static Map<String,Signal> signals
private final String id
private final String name
private final String description
Constructor Detail |
---|
private Signal(String id, String name, String description)
Method Detail |
---|
public static Signal registerSignal(String id, String name, String description)
id
- The ID of the signal. This must be unique. If another signal
with the same ID already exists, this method does nothing.name
- The short name of the signaldescription
- A description of the what the signal means and how
receivers should behave when the signal is sent to them
public static Signal getSignal(String id)
id
- The signal ID.
getSignals()
public static Collection<Signal> getSignals()
getSignal(String)
public String toString()
toString
in class Object
public boolean equals(Object other)
equals
in class Object
public int hashCode()
hashCode
in class Object
public String getId()
public String getName()
public String getDescription()
|
2.17.2: 2011-06-17 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |