org.vishia.xmlSimple

Class SimpleXmlOutputter

java.lang.Object

org.vishia.xmlSimple.SimpleXmlOutputter

public class SimpleXmlOutputter
extends java.lang.Object

This class writes any XmlNode to a textual output. Because the interface XmlNode may be used for several Xml tree representation, for example via org.vishia.xml.XmlNodeJdom for a www.jdom.org XML tree, it is universal to use.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	SimpleXmlOutputter.ModeBits

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	mode
(package private) java.lang.String	newline
(package private) java.lang.String	sIdent
static int	version Version, history and license.

Constructor Summary

Constructors

Constructor and Description
SimpleXmlOutputter()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	attribute(java.lang.String name, java.lang.String value)
private static void	convert(java.lang.StringBuilder[] buffer, java.lang.String[] text, int pos1, char cc, java.lang.String sNew)
static java.lang.CharSequence	convertString(java.lang.String textP) Replaces XML special character.
static java.lang.String	elementEnd(java.lang.String name)
static java.lang.String	elementShortEnd()
static java.lang.String	elementStart(java.lang.String name)
static java.lang.String	elementTagEnd()
void	write(java.io.OutputStreamWriter out, XmlNode xmlNode) Writes the XML tree into a byte stream and closes after them.
void	write(java.io.Writer out, java.lang.CharSequence sEncoding, XmlNode xmlNode) Writes the XML tree into a character stream and closes after them.
protected void	writeNode(java.io.Writer out, XmlNode xmlNode, int nIndent)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

version

public static final int version

Version, history and license.

• 2020-02-12 new write(Writer, CharSequence, XmlNode) especially for test outputs which should stored only locally without a File using.
• 2013-07-28: Hartmut chg: Uses a BufferedWriter internally. The BufferedWriter.newLine() is not invoked therefore the platform depending line separator is not used. The line separator is still a simple '\n'. But the output may be faster, or not because the Writer outside may have a buffer too. That BufferedWriter is included as debug helper primary. The output String should be seen. Some comments and test features added.
• 2013-07-28: Hartmut new The convertString(String) is now public.
• 2009-05-24: Hartmut The out arg for write is a OutputSteamWriter, not a basic Writer. Because: The charset of the writer is got and written in the head line. The write routine should used to write a byte stream only.
• 2008-04-02: Hartmut some changes
• 2008-01-15: Hartmut www.vishia.de creation

known bugs and necessary features:

• 2008-05-24: Hartmut if US-ASCII-encoding is used, '?' is written on unknown chars yet.

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

mode

int mode

newline

java.lang.String newline

sIdent

java.lang.String sIdent

Constructor Detail

SimpleXmlOutputter

public SimpleXmlOutputter()

Method Detail

write

public void write(java.io.OutputStreamWriter out,
                  XmlNode xmlNode)
           throws java.io.IOException

Writes the XML tree into a byte stream and closes after them. Uses the encoding from the given OutputStreamWriter to show the encoding in the file.

Parameters:

out - A Writer to convert in a Byte stream.

xmlNode - The top level node

Throws:

java.io.IOException

write

public void write(java.io.Writer out,
                  java.lang.CharSequence sEncoding,
                  XmlNode xmlNode)
           throws java.io.IOException

Writes the XML tree into a character stream and closes after them. Uses the given encoding to show the encoding in the file.

Parameters:

out - A Writer better for String output in comparison to the Stream (byte, encoded) output.

sEncoding - the encoding String stored in the XML file. Note: It should be matching to the Writer.

xmlNode - The top level node

Throws:

java.io.IOException

writeNode

protected void writeNode(java.io.Writer out,
                         XmlNode xmlNode,
                         int nIndent)
                  throws java.io.IOException

Throws:

java.io.IOException

elementStart

public static java.lang.String elementStart(java.lang.String name)

elementTagEnd

public static java.lang.String elementTagEnd()

elementShortEnd

public static java.lang.String elementShortEnd()

elementEnd

public static java.lang.String elementEnd(java.lang.String name)

attribute

public static java.lang.String attribute(java.lang.String name,
                                         java.lang.String value)

convertString

public static java.lang.CharSequence convertString(java.lang.String textP)

Replaces XML special character.

Parameters:

textP -

Returns:

textP without effort if such special character are not present, elsewhere a prepared string in a StringBuilder.

convert

private static void convert(java.lang.StringBuilder[] buffer,
                            java.lang.String[] text,
                            int pos1,
                            char cc,
                            java.lang.String sNew)