public class MessageTemplate
extends java.lang.Object
OperatingMessage.put(String, Object)
)
- `set(String, String)`, eine Variable, mit mit einer Menge von Objekten befüllt wird. Die doppelte Angabe eines Objekts wird automatisch
verhindert, Objekte werden in der Reihenfolge ausgegeben, wie sie eingefügt werden. Optional können hier 2 weitere Parameter angegeben
werden, mit denen ein Singular und Plural-Präfix definiert werden kann. (Siehe OperatingMessage.add(String, Object)
)
- `object()`, fügt eine Referenz auf das Systemobjekt ein, auf das sich die Meldung bezieht. (Siehe newMessage(SystemObject)
)
- `ids()`, Eine spezielle Mengen-Variable, die Kennungen der Betriebsmeldung enthält. Die IDs werden im MeldungsTypZusatz publiziert.
(Siehe OperatingMessage.addId(Object)
)
Diese Klasse sowie die hier definierten OperatingMessageParam-Instanzen sind unveränderlich und threadsafe.Modifier and Type | Class and Description |
---|---|
static class |
MessageTemplate.OperatingMessageParam
Abstrakte Klasse für einen Textbaustein
|
Constructor and Description |
---|
MessageTemplate(MessageGrade grade,
MessageType domain,
MessageTemplate.OperatingMessageParam... text)
Erzeugt eine neue Betriebsmeldungs-Text-Vorlage
|
Modifier and Type | Method and Description |
---|---|
static MessageTemplate.OperatingMessageParam |
fixed(java.lang.String s)
Erstellt einen festen String-Wert als Textbaustein
|
MessageType |
getDomain()
Gibt die Art der Meldung zurück
|
MessageGrade |
getGrade()
Gibt die Schwere der Meldung zurück
|
java.util.logging.Level |
getLevel()
Gibt den Level zurück, mit dem erzeugte Meldungen beim Versand über die Debug-Funktionen ausgegeben werden sollen.
|
java.util.List<MessageTemplate.OperatingMessageParam> |
getParams()
Gibt die Textbausteine dieses Objekts zurück
|
static MessageTemplate.OperatingMessageParam |
ids()
Erstellt einen neuen Platzhalter für die der Meldung zugeordneten Kennungen (MeldungsTypZusatz).
|
OperatingMessage |
newMessage(de.bsvrz.dav.daf.main.config.SystemObject systemObject)
Erstellt aus der Vorlage ein neues Betriebsmeldungs-Objekt, das mit konkreten Werten gefüllt und dann versand werden kann
|
static MessageTemplate.OperatingMessageParam |
object()
Erstellt einen neuen Platzhalter für das Objekt, auf das sich die Betriebsmeldung bezieht
|
static MessageTemplate.OperatingMessageParam |
set(java.lang.String variable,
java.lang.String joiner)
Erstellt einen neuen Platzhalter für eine Menge
|
static MessageTemplate.OperatingMessageParam |
set(java.lang.String variable,
java.lang.String joiner,
java.lang.String singular,
java.lang.String plural)
Erstellt einen neuen Platzhalter für eine Menge
|
java.lang.String |
toString() |
static MessageTemplate.OperatingMessageParam |
variable(java.lang.String variable)
Erstellt einen neuen Platzhalter für eine einfache Variable
|
MessageTemplate |
withDebugLevel(java.util.logging.Level level)
Gibt eine Kopie dieses Objekts zurück, welches den übergebenen Debug-Level für die Debug-Meldung verwendet (standardmäßig INFO)
|
MessageTemplate |
withIdFactory(MessageIdFactory factory)
Gibt eine Kopie dieses Objekts zurück, welches den übergebenen Lambda-Ausdruck zur Erzeugung einer Betriebsmeldungs-ID verwendet
|
public MessageTemplate(MessageGrade grade, MessageType domain, MessageTemplate.OperatingMessageParam... text)
grade
- Schwere der Meldungdomain
- Art der Meldungtext
- Textbestandteile, die verkettet werden. Zur Erzeugung der einzelnen MessageTemplate.OperatingMessageParam
-Instanzen können die statischen Methoden
in dieser Klasse benutzt werden.public static MessageTemplate.OperatingMessageParam set(java.lang.String variable, java.lang.String joiner)
variable
- Variablennamejoiner
- Verbinder zwischen dem zweitletzen un dem letzten Eintrag. Sinnvoll sind z. B. ", ", " und ", " sowie ", ...public static MessageTemplate.OperatingMessageParam set(java.lang.String variable, java.lang.String joiner, java.lang.String singular, java.lang.String plural)
variable
- Variablennamejoiner
- Verbinder zwischen dem zweitletzten un dem letzten Eintrag. Sinnvoll sind z. B. ", ", " und ", " sowie ", ...singular
- Singular-Präfixplural
- Plural-Präfixpublic static MessageTemplate.OperatingMessageParam fixed(java.lang.String s)
s
- Textpublic static MessageTemplate.OperatingMessageParam variable(java.lang.String variable)
variable
- Variablennamepublic static MessageTemplate.OperatingMessageParam object()
public static MessageTemplate.OperatingMessageParam ids()
public MessageTemplate withIdFactory(MessageIdFactory factory)
factory
- Lambda-Ausdruck o.ä. zur Erzeugung der Meldungs-IDpublic MessageTemplate withDebugLevel(java.util.logging.Level level)
level
- Debug-Levelpublic java.util.List<MessageTemplate.OperatingMessageParam> getParams()
public MessageGrade getGrade()
public MessageType getDomain()
public OperatingMessage newMessage(de.bsvrz.dav.daf.main.config.SystemObject systemObject)
systemObject
- Objekt, auf das sich die Meldung bezieht (null ist erlaubt wodurch es dann kein Bezugsobjekt gibt)public java.util.logging.Level getLevel()
Mit Debug.OFF
kann die Ausgabe über Debug deaktiviert werden, dann wird nur die Meldung über den Datenverteiler versendet
public java.lang.String toString()
toString
in class java.lang.Object