public final class OperatingMessage extends java.lang.Object implements OperatingMessageInterface
MessageTemplate
erzeugt,
diese Klasse bietet jedoch auch statische Methoden, mit denen simple Meldungen einfacher erzeugt werden, z. B. info(MessageType, Object,
Object...)
oder create(MessageGrade, MessageType, Object, Object...)
.Modifier and Type | Method and Description |
---|---|
void |
add(java.lang.String variable,
java.lang.Object value)
Fügt einer Variable, die als Menge verwendet wird, ein Element hinzu.
|
void |
add(java.lang.String variable,
java.lang.Object value,
boolean forcePlural)
Fügt einer Variable, die als Menge verwendet wird, ein Element hinzu.
|
void |
addId(java.lang.Object value)
Fügt ein Element für den MeldungTypZusatz hinzu.
|
static OperatingMessage |
create(MessageGrade messageGrade,
MessageType messageType,
java.lang.Object message,
java.lang.Object... messageAddOn)
Erzeugt eine neue Betriebsmeldung mit angegebenem Level und Typ.
|
static OperatingMessage |
error(MessageType type,
java.lang.Object message,
java.lang.Object... messageAddOn)
Erzeugt eine neue Betriebsmeldung mit Level ERROR.
|
static OperatingMessage |
fatal(MessageType type,
java.lang.Object message,
java.lang.Object... messageAddOn)
Erzeugt eine neue Betriebsmeldung mit Level FATAL.
|
static java.lang.CharSequence |
formatCollection(java.util.Collection<?> param,
java.lang.String joiner,
java.lang.String singular,
java.lang.String plural)
Hilfsfunktion zur Formatierung einer Menge
|
java.lang.Object |
get(java.lang.String variable)
Gibt den aktuellen Wert einer Variablen zurück
|
MessageType |
getDomain()
Gibt die Art der Meldung zurück
|
java.lang.Throwable |
getException()
Gibt die Exception zurück
|
MessageGrade |
getGrade()
Gibt den Grad der Meldung zurück
|
java.lang.String |
getId()
Deprecated.
|
java.util.Set<java.lang.Object> |
getIds()
Gibt die mit
addId(Object) bisher hinzugefügten IDs zurück. |
java.util.logging.Level |
getLevel() |
java.lang.String |
getMessage()
Gibt den Meldungstext zurück
|
java.lang.String |
getMessageId()
Gibt die ID der Betriebsmeldung zurück
Ist die Meldungs-ID ein leerer String, wird eine zufällige eindeutige ID beim Versand der Meldung erzeugt.
|
java.lang.String |
getMessageTypeAddOn()
Gibt den MeldungsTypZusatz zurück
|
de.bsvrz.dav.daf.main.config.SystemObject |
getObject()
Gibt das Systemobjekt, auf das sich die Meldung bezieht, zurück
|
MessageState |
getState()
Gibt den Zustand der Meldung zurück
|
static OperatingMessage |
info(MessageType type,
java.lang.Object message,
java.lang.Object... messageAddOn)
Erzeugt eine neue Betriebsmeldung mit Level INFO.
|
boolean |
isDefined()
Gibt
true zurück, wenn alle Variablen und ähnliches definiert sind |
PersistentOperatingMessage |
newPersistentMessage()
Sendet diese Betriebsmeldung als neue Meldung und gibt ein Objekt zurück, über das die Betriebsmeldung geändert und ggf. wieder gutgemeldet
werden kann.
|
PersistentOperatingMessage |
newPersistentMessage(java.lang.String id)
Sendet diese Betriebsmeldung als neue Meldung und gibt ein Objekt zurück, über das die Betriebsmeldung geändert und ggf. wieder gutgemeldet
werden kann.
|
void |
put(java.lang.String variable,
java.lang.Object value)
Setzt eine Variable
|
void |
send()
Sendet diese Betriebsmeldung einmal (falls sie definiert ist), sonst passiert nichts.
|
void |
setException(java.lang.Throwable exception)
Setzt bei Bedarf eine Exception, die die Ursache dieser Betriebsmeldung ist
|
void |
setMessageId(java.lang.String messageId)
Setzt die ID der Betriebsmeldung, die dem Zuordnen von Gutmeldung zur Betriebsmeldung dient und auch Grundlage für die Pid des
Nachrichten-Objekts sein kann.
|
java.lang.String |
toString()
Gibt den Text der Betriebsmeldung zurück.
|
static OperatingMessage |
warning(MessageType type,
java.lang.Object message,
java.lang.Object... messageAddOn)
Erzeugt eine neue Betriebsmeldung mit Level WARNING.
|
public static OperatingMessage info(MessageType type, java.lang.Object message, java.lang.Object... messageAddOn)
Debug.info(String, Object)
,
es muss aber zusätzlich als ersten Parameter die Meldungsart angegeben werden. Außerdem erlaubt diese Klasse beliebig viele Parameter, so kann
z. B. eine Exception gleichzeitig zu einem oder mehreren Objekten ausgegeben werden.
Diese Methode ist eine Convenience-Methode, die anhand der übergebenen Parameter verschiedene Werte der Betriebsmeldung automatisch errät. So
wird beispielsweise das erste übergebene SystemObject als Bezugsobjekt für die Betriebsmeldung interpretiert. Ist ein anderes Verhalten
gewünscht, sollte ein MessageTemplate
verwendet werden.
Erkannte Objekt-Typen:
MessageTemplate.OperatingMessageParam
siehe
MessageTemplate.MessageTemplate(MessageGrade, MessageType, OperatingMessageParam...)
String.valueOf(Object)
in einen String konvertierttype
- Typmessage
- MeldungstextmessageAddOn
- Weiterer Meldungstextpublic static OperatingMessage warning(MessageType type, java.lang.Object message, java.lang.Object... messageAddOn)
Debug.warning(String)
, es
muss aber zusätzlich als ersten Parameter die Meldungsart angegeben werden. Außerdem erlaubt diese Klasse beliebig viele Parameter, so kann z.
B. eine Exception gleichzeitig zu einem oder mehreren Objekten ausgegeben werden.
Diese Methode ist eine Convenience-Methode, die anhand der übergebenen Parameter verschiedene Werte der Betriebsmeldung automatisch errät. So
wird beispielsweise das erste übergebene SystemObject als Bezugsobjekt für die Betriebsmeldung interpretiert. Ist ein anderes Verhalten
gewünscht, sollte ein MessageTemplate
verwendet werden.
Erkannte Objekt-Typen:
MessageTemplate.OperatingMessageParam
siehe
MessageTemplate.MessageTemplate(MessageGrade, MessageType, OperatingMessageParam...)
String.valueOf(Object)
in einen String konvertierttype
- Typmessage
- MeldungstextmessageAddOn
- Weiterer Meldungstextpublic static OperatingMessage error(MessageType type, java.lang.Object message, java.lang.Object... messageAddOn)
Debug.error(String)
, es muss
aber zusätzlich als ersten Parameter die Meldungsart angegeben werden. Außerdem erlaubt diese Klasse beliebig viele Parameter, so kann z. B.
eine Exception gleichzeitig zu einem oder mehreren Objekten ausgegeben werden.
Diese Methode ist eine Convenience-Methode, die anhand der übergebenen Parameter verschiedene Werte der Betriebsmeldung automatisch errät. So
wird beispielsweise das erste übergebene SystemObject als Bezugsobjekt für die Betriebsmeldung interpretiert. Ist ein anderes Verhalten
gewünscht, sollte ein MessageTemplate
verwendet werden.
Erkannte Objekt-Typen:
MessageTemplate.OperatingMessageParam
siehe
MessageTemplate.MessageTemplate(MessageGrade, MessageType, OperatingMessageParam...)
String.valueOf(Object)
in einen String konvertierttype
- Typmessage
- MeldungstextmessageAddOn
- Weiterer Meldungstextpublic static OperatingMessage fatal(MessageType type, java.lang.Object message, java.lang.Object... messageAddOn)
Debug.error(String)
, es muss
aber zusätzlich als ersten Parameter die Meldungsart angegeben werden. Außerdem erlaubt diese Klasse beliebig viele Parameter, so kann z. B.
eine Exception gleichzeitig zu einem oder mehreren Objekten ausgegeben werden.
Diese Methode ist eine Convenience-Methode, die anhand der übergebenen Parameter verschiedene Werte der Betriebsmeldung automatisch errät. So
wird beispielsweise das erste übergebene SystemObject als Bezugsobjekt für die Betriebsmeldung interpretiert. Ist ein anderes Verhalten
gewünscht, sollte ein MessageTemplate
verwendet werden.
Erkannte Objekt-Typen:
MessageTemplate.OperatingMessageParam
siehe
MessageTemplate.MessageTemplate(MessageGrade, MessageType, OperatingMessageParam...)
String.valueOf(Object)
in einen String konvertierttype
- Typmessage
- MeldungstextmessageAddOn
- Weiterer Meldungstextpublic static OperatingMessage create(MessageGrade messageGrade, MessageType messageType, java.lang.Object message, java.lang.Object... messageAddOn)
Diese Methode ist eine Convenience-Methode, die anhand der übergebenen Parameter verschiedene Werte der Betriebsmeldung automatisch errät. So
wird beispielsweise das erste übergebene SystemObject als Bezugsobjekt für die Betriebsmeldung interpretiert. Ist ein anderes Verhalten
gewünscht, sollte ein MessageTemplate
verwendet werden.
Erkannte Objekt-Typen:
MessageTemplate.OperatingMessageParam
siehe
MessageTemplate.MessageTemplate(MessageGrade, MessageType, OperatingMessageParam...)
String.valueOf(Object)
in einen String konvertiertmessageGrade
- Schwere der MeldungmessageType
- Typmessage
- MeldungstextmessageAddOn
- Weiterer Meldungstextpublic static java.lang.CharSequence formatCollection(java.util.Collection<?> param, java.lang.String joiner, java.lang.String singular, java.lang.String plural)
param
- Mengejoiner
- Verbinder zwischen dem zweitletzten un dem letzten Eintrag. Sinnvoll sind z. B. ", ", " und ", " sowie ", ...singular
- Singular-Präfixplural
- Plural-Präfixpublic java.lang.Object get(java.lang.String variable)
variable
- Variablen-Namepublic void put(java.lang.String variable, java.lang.Object value)
variable
- Variablen-Namevalue
- Wert (wird zur Ausgabe ggf. mit String.valueOf(Object)
in einen String konvertiert)public void add(java.lang.String variable, java.lang.Object value)
variable
- Variablen-Namevalue
- Wert (wird zur Ausgabe ggf. mit String.valueOf(Object)
in einen String konvertiert)public void add(java.lang.String variable, java.lang.Object value, boolean forcePlural)
variable
- Variablen-Namevalue
- Wert (wird zur Ausgabe ggf. mit String.valueOf(Object)
in einen String konvertiert)forcePlural
- Soll die Menge auf jeden Fall im Plural ausgegeben werden? (ist sinnvoll, wenn value bereits mehrere Objekte repräsentiert)public void addId(java.lang.Object value)
IDs
), die zur
Verknüpfung von mehreren zusammengehörigen Betriebsmeldungen verwendet werden.value
- Beliebige MeldungTypZusatz-ID (wird zur Ausgabe ggf. mit String.valueOf(Object)
in einen String konvertiert)public java.util.Set<java.lang.Object> getIds()
addId(Object)
bisher hinzugefügten IDs zurück.public java.lang.String toString()
toString
in class java.lang.Object
public boolean isDefined()
true
zurück, wenn alle Variablen und ähnliches definiert sindtrue
, wenn alle Variablen und ähnliches definiert sind, sonst false
public java.lang.String getMessage()
OperatingMessageInterface
getMessage
in interface OperatingMessageInterface
public MessageGrade getGrade()
OperatingMessageInterface
getGrade
in interface OperatingMessageInterface
@Deprecated public java.lang.String getId()
OperatingMessageInterface
getId
in interface OperatingMessageInterface
public MessageType getDomain()
OperatingMessageInterface
getDomain
in interface OperatingMessageInterface
public java.lang.String getMessageTypeAddOn()
OperatingMessageInterface
getMessageTypeAddOn
in interface OperatingMessageInterface
public de.bsvrz.dav.daf.main.config.SystemObject getObject()
OperatingMessageInterface
getObject
in interface OperatingMessageInterface
public MessageState getState()
OperatingMessageInterface
getState
in interface OperatingMessageInterface
public void send()
public PersistentOperatingMessage newPersistentMessage()
public PersistentOperatingMessage newPersistentMessage(java.lang.String id)
id
- ID zur Identifizierung der Meldungpublic java.lang.Throwable getException()
getException
in interface OperatingMessageInterface
public void setException(java.lang.Throwable exception)
exception
- Exceptionpublic java.lang.String getMessageId()
Ist die Meldungs-ID ein leerer String, wird eine zufällige eindeutige ID beim Versand der Meldung erzeugt.
getMessageId
in interface OperatingMessageInterface
public void setMessageId(java.lang.String messageId)
Ist die Meldungs-ID ein leerer String, wird eine zufällige eindeutige ID beim Versand der Meldung erzeugt.
messageId
- Meldungs-IDpublic java.util.logging.Level getLevel()
getLevel
in interface OperatingMessageInterface