Package eu.bandm.tools.message
Messages and positions in documents,
see the user documentation.
-
Interface Summary Interface Description Locatable<D> Anything wich delivers aLocation
when asked for it by callingLocatable.getLocation()
MessageReceiver<M extends Message> Everything which can receive a Message. -
Class Summary Class Description Location<D> A reference to document parts.Location.Set<D> The third sub-class, representing regions with gaps, or even in different documents.LocationMap<D,E> Facility to translateLocation
s.Message Abstract base class of the metatools message architecture.MessageAsync<M extends Message> A sub-class ofSingleSender
which lets the drain's receive method run asynchronouously in a separate thread.MessageCatcher Executes some code (given explicitly as argument) and sends the first exception caught to its message drain.MessageCounter Counts all received messages, per kind, in total, and per critical/non-critical.MessageDemux<E extends java.lang.Enum<E>,M extends Message> Auxiliary class which concretizesPrimitiveMessageDemux
in so far it calculates a set of enum values for every message it receives, and then calls thePrimitiveMessageDemux.receive(Enum,Message)
method for all these.MessageDemux.All<E extends java.lang.Enum<E>,M extends Message> Trivial instantiation ofMessageDemux
which propagates each message to all receivers in the map, as it has been constructed byPrimitiveMessageDemux.setReceiver(Enum,MessageReceiver)
MessageDemux.ByKind<M extends Message> AMessageDemux
which sorts messages by their kind.MessageDisposer Does nothing with every message it receives.MessageFormatter<D> Interprets theSimpleMessage.args
values as arguments to string formatting and calls {@link String.format(String,Object...)}.MessageFormatter.Formandum Wraps any text as argument, which itself shall be translated and formatted.MessageKindFilter<M extends Message> A filter which propagates only those messages theMessage.Kind
of which is currently in the selection.MessageLocationFilter<D> A filter which propagates only those messages which lie in certain areas of locations.MessageMapper<M extends Message,N extends Message> A message receiver which receives a message of one type, and propagates the result of applying a function to this message, which may be of different type.MessagePasser<M extends Message> Simply passes every message it receives to a single target.MessagePrinter<M extends Message> Prints textual representations of all received messages to an output stream.MessagePrinter.Indenting<M extends Message> Specialization ofMessagePrinter
with addtional features.MessageStore<M extends Message> Storage for a sequence ofMessage
s with dynamic sorting, graphic interfaces and propagation facilities.MessageStore_<M extends Message> Common superclass for the two kinds of message storage,MessageStore
andMessageStore_sorted
.MessageStoreSorted<M extends Message> Storage for a sequence ofMessage
s in order of their arrival.MessageStripExceptions<M extends Message> A filter which strips off all exceptions, or at least the stack traces, for a slimmer appearance of print-outs.MessageSync<M extends Message> Can accept messages from many different parallel threads.MessageTee<M extends Message> Re-sends the message received sequentially to a multitude of current drains. The identical message object is sent to all receivers, so in most use cases it should be treated read-only by subsequent processing in the drains.MessageThrower<M extends Message> "Throws" each message it receives after wrapping it into aMessageException
.NoDocumentIdentifier Class without instances, used as type paramteter for locations which do not define a document identifier.OffsetIndicationPrinter Prints textual representations of all received messages to an output stream.Outstream2Log<D> Pipes every printed line (on its completion) into one "log" message sent to the messageOutstream2Log.receiver
.PrimitiveMessageDemux<E extends java.lang.Enum<E>,M extends Message> Auxiliary class administrating an enumeration type and a map from this type to optionalMessageReceiver
s.SimpleMessage<D> A minimal selection of message data which is useful in practice.SimpleMessage.Ping<D> Log message with not more informative content than "I am still alive".SimpleMessage.Sender<E> SingleSender<M extends Message> Common superclass of all which send messages to one single drain.Spectrum SwingMessageField<M extends Message> A one-line display for messages to be included in a Swing based GUI.SwingMessageTable<D> Multi-line rendering for message text.TrafficLight A graphic object showing a traffic light in different phases.TrafficMessageReceiver Graphic indication of received messages.XMLDocumentIdentifier Realizes a pair of identifiers ("system" and "public") as often required to identify an XML document. -
Enum Summary Enum Description Location.NumberMode Classification of (particular/pseudo) line and column numbersMessage.Kind Fundamental enum type for categorization of allMessage
objects.TrafficLight.State The states of aTrafficLight
and of aTrafficMessageReceiver
. -
Exception Summary Exception Description MessageException Wraps any kind of message to send it as an exception.