Package gdv.xport.util
Class AbstractFormatter
java.lang.Object
gdv.xport.util.AbstractFormatter
- All Implemented Interfaces:
ImportListener
,AutoCloseable
,EventListener
- Direct Known Subclasses:
CsvFormatter
,GdvXmlFormatter
,HtmlFormatter
,JsonFormatter
,NullFormatter
,XmlFormatter
Dies ist das gemeinsame Oberklasse der verschiedenen Formatter. Es wird
z.B. von der Main-Klasse fuer die Ausgabe verwendet.
Seit 5.0 wird das AutoCloseable
-Interface implementiert.
- Since:
- 0.5.0 (29.11.2010)
- Author:
- oliver (ob@aosd.de)
-
Constructor Summary
ConstructorsModifierConstructorDescriptionDefault-Konstruktor, der als Standard-Ausgabekanal stdout einstellt.AbstractFormatter
(OutputStream ostream) Instantiiert einen neuen Formatter.AbstractFormatter
(Writer writer) Instantiiert einen neuen Formatter.protected
AbstractFormatter
(Writer writer, Config config) Legt einen neuen Formatter an. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Schliesst die Writer-Resource.protected final Config
Liefert die Konfiguratipn zurueck.final Writer
Liefert den eingestellten Writer.void
Sobald diese Methode aufgerufen, wird der uebergebene Satz formattiert ausgegeben.void
setWriter
(OutputStream ostream) Setzt den Ausgabekanal auf den uebergebenen OutputStream.void
Setzt den Ausgabekanal auf den uebergebenen Writer.void
write
(Datenpaket datenpaket) Ausgabe eines kompletten Datenpakets.void
Wenn ein Formatter alsImportListener
eingesetzt werden soll, muss er diese Methode ueberschreiben.void
Ausgabe des uebergebenen Strings.
-
Constructor Details
-
AbstractFormatter
public AbstractFormatter()Default-Konstruktor, der als Standard-Ausgabekanal stdout einstellt. -
AbstractFormatter
Instantiiert einen neuen Formatter.- Parameters:
writer
- the writer
-
AbstractFormatter
Legt einen neuen Formatter an.- Parameters:
writer
- Writerconfig
- Konfiguration
-
AbstractFormatter
Instantiiert einen neuen Formatter.- Parameters:
ostream
- the ostream
-
-
Method Details
-
getConfig
Liefert die Konfiguratipn zurueck.- Returns:
- Konfiguration
-
getWriter
Liefert den eingestellten Writer.- Returns:
- the writer
-
setWriter
Setzt den Ausgabekanal auf den uebergebenen Writer.- Parameters:
writer
- Ausgabekanal
-
setWriter
Setzt den Ausgabekanal auf den uebergebenen OutputStream.- Parameters:
ostream
- OutputStream als Ausgabekanal
-
notice
Sobald diese Methode aufgerufen, wird der uebergebene Satz formattiert ausgegeben.- Specified by:
notice
in interfaceImportListener
- Parameters:
satz
- der soeben importierte Satz- See Also:
-
write
Wenn ein Formatter alsImportListener
eingesetzt werden soll, muss er diese Methode ueberschreiben.- Parameters:
satz
- Satz, der ausgegeben werden soll- Throws:
IOException
- Signals that an I/O exception has occurred.- See Also:
-
write
Ausgabe eines kompletten Datenpakets. Diese Methode war urspruenglich abstrakt, ist aber jetzt nicht mehr unbedingt noetig, wennwrite(Satz)
ueberschrieben wurde.- Parameters:
datenpaket
- Datenpaket, das formattiert ausgegeben werden soll- Throws:
IOException
- bei Problemen mit der Generierung- See Also:
-
write
Ausgabe des uebergebenen Strings.- Parameters:
content
- the content- Throws:
IOException
- Signals that an I/O exception has occurred.
-
close
Schliesst die Writer-Resource.- Specified by:
close
in interfaceAutoCloseable
- Throws:
IOException
- falls was schief geht- Since:
- 5.0
-