org.vishia.xmlSimple

Class XmlSequWriter

java.lang.Object

org.vishia.xmlSimple.XmlSequWriter

public class XmlSequWriter
extends java.lang.Object

This is a XML writer which does not store anything. It writes only. The usage is seen in the test files, #testWritetree2(File, StringBuilder) etc with following template:

    open(file, "US-ASCII", out);
    writeElement("root");
      writeText("contentRoot", true);
    writeElement("child1");
      writeAttribute("attr", "value");
      writeText("contentChild <???> special chars", false);
      writeElementEnd();
    writeElement("child2");
      writeAttribute("attr2", "text ? special chars");
    close();
 

The output for that is:

<?xml version="1.0" encoding="US-ASCII"?>
<root>
  contentRoot
  <child1 attr="value">contentChild &lt;&#xc4;&#xdc;&#xd6;&gt; special chars</child1>
  <child2 attr2="text &#x20ac; special chars"/>
</root>
 

Note: The source contains the transcription for Javadoc. See the original. Javadoc presents correctly.
Features:

• Supported encodings are all UTF-, US-ASCII and ISO-8859-1 yet. Other ISO-8859-x can be enhanced (needs a special solution, see CodeCharset
• Parallel to the file an Appendable can be written, for debug or Java-internal String usage of XML output.
• Namespaces should be written manually as attributes and as "ns:tag"
• Beatification on output: default 2 spaces for indent on any element, indent on text content is able to parametrize

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	XmlSequWriter.ElementInfo

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	bElementStart
(package private) boolean	bFullEncoding true then no reason to output transcription characters.
boolean	bTreeComment
(package private) XmlSequWriter.ElementInfo	elementCurr Info of the current element.
(package private) java.util.Stack<XmlSequWriter.ElementInfo>	elementsParent Store all parent elements, necessary for close etc.
(package private) java.nio.charset.Charset	encoding
(package private) CodeCharset	encodingCode It is null for UTF encoding
private java.io.OutputStream	fwr
(package private) int	indent
(package private) int	nColumn
(package private) int	nColumnMax
private byte[]	outBuffer
private java.lang.String	replaceBasics
(package private) java.lang.String	sEncoding
private static java.lang.String	sIndent
private static java.lang.String[]	stdReplacement
private java.lang.Appendable	twr
static java.lang.String	version Version, License and History: 2020-10-05 check encoding stuff, some better documented and changed.
private java.io.Writer	wr

Constructor Summary

Constructors

Constructor and Description
XmlSequWriter()

Method Summary

Modifier and Type	Method and Description
void	close() Writes closing elementsParent if necessary, then close the files.
void	fileclose()
void	flush()
java.lang.String	open(java.io.File file, java.lang.String encoding, java.lang.Appendable buffer) Opens for writing in a file, closes an opened file if any is open.
void	replaceNewline(boolean bReplace) Switch the mode for replacing a \n in texts or attribute values.
void	setDebugTextOut(java.lang.Appendable out) Sets an output for text output of the created XML.
void	setEncoding(java.lang.String sEncoding)
void	writeAttribute(java.lang.String name, java.lang.String value)
void	writeComment()
void	writeElement(java.lang.String sTag) Writes a new Element with its tag, without closing the element.
void	writeElementEnd() Writes a simple end "" or "/>" depending on invocation of #writeElementHeadEnd() before
void	writeElementHeadEnd(boolean bNewline) Writes a simple end ">" because child nodes may be added to the element.
private void	writeHead()
void	writeText(java.lang.CharSequence txt, boolean bNewline)
private void	wrNewline(int add)
private void	wrTxt(java.lang.CharSequence txt) Writes text with all replacements.
private void	wrTxtAscii(java.lang.String txt) Write as given, only ASCII (7 bit) especially for XML head.
private void	wrTxtEncoded(java.lang.CharSequence txt) Write a text, using #encoding2 to check write character immediately or as ģ for non encode able character.

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final java.lang.String version

Version, License and History:

• 2020-10-05 check encoding stuff, some better documented and changed. Hint: Introducing namespace processing is faulty here. The namespace can be written as normal attribute name string or tag, as given. Handling of namespaces should be done in the application. This class is in documentation yet. See https://vishia.org/Java/html/RWTrans/XmlSeqWriter.html
• 2019-12-24 created.

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

wr

private java.io.Writer wr

fwr

private java.io.OutputStream fwr

twr

private java.lang.Appendable twr

outBuffer

private byte[] outBuffer

sEncoding

java.lang.String sEncoding

encoding

java.nio.charset.Charset encoding

encodingCode

CodeCharset encodingCode

It is null for UTF encoding

bFullEncoding

boolean bFullEncoding

true then no reason to output transcription characters.

bElementStart

boolean bElementStart

nColumn

int nColumn

nColumnMax

int nColumnMax

elementCurr

XmlSequWriter.ElementInfo elementCurr

Info of the current element.

elementsParent

java.util.Stack<XmlSequWriter.ElementInfo> elementsParent

Store all parent elements, necessary for close etc. and also for parent namespaces.

indent

int indent

replaceBasics

private java.lang.String replaceBasics

bTreeComment

public boolean bTreeComment

sIndent

private static java.lang.String sIndent

stdReplacement

private static java.lang.String[] stdReplacement

Constructor Detail

XmlSequWriter

public XmlSequWriter()

Method Detail

setEncoding

public void setEncoding(java.lang.String sEncoding)
                 throws java.nio.charset.IllegalCharsetNameException

Throws:

java.nio.charset.IllegalCharsetNameException

open

public java.lang.String open(java.io.File file,
                             java.lang.String encoding,
                             java.lang.Appendable buffer)
                      throws java.io.IOException

Opens for writing in a file, closes an opened file if any is open.

Parameters:

file - can be null, then only the buffer is written.

encoding - can be null, then the last used or given setEncoding(String) is valid. Default is "UTF-8". If given the setEncoding(String) is called here.
If the encoding is "ISO-8859-x" or "US-ASCII" then non map able characters are written as 샞
On other encodings non mapable character are faulty written as defined by Writer(... Charset).

buffer - can be null, if given, the output is written there, the same as in setDebugTextOut(Appendable) The buffer is written with replaced characters by 샞 as in file.

Returns:

null on success, the error on error. It is either "Encoding ..." on unsupportedCharset or "File not able to create: ..." with the absolute path of the file.

Throws:

java.io.IOException - only on closing an opened file. Not expected.

close

public void close()
           throws java.io.IOException

Writes closing elementsParent if necessary, then close the files.

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Throws:

java.io.IOException

fileclose

public void fileclose()

setDebugTextOut

public void setDebugTextOut(java.lang.Appendable out)

Sets an output for text output of the created XML. If #open(File, String) is not used respectively close() is called before, the XML output is written only to this Appendable. If #open(File, String) is used too, the XML output is written twice, to this Appendable too. The Appendable instance can used outside of this XML write operations in any kind, it can be delete etc. Hence it may be used as debug check.

Parameters:

out - if null then this output is disabled.

replaceNewline

public void replaceNewline(boolean bReplace)

Switch the mode for replacing a \n in texts or attribute values.

Parameters:

bReplace - true, then do not output a \n (line break), instead output false then break the line with \n if it occurs in texts and attribute values.

writeHead

private void writeHead()
                throws java.io.IOException

Throws:

java.io.IOException

writeComment

public void writeComment()

writeElement

public void writeElement(java.lang.String sTag)
                  throws java.io.IOException

Writes a new Element with its tag, without closing the element. It is a child node of a non closed writeElement(String) before. After this call firstly writeAttribute(String, String) can be written, then writeElement(String) for child nodes or #writeText()

Parameters:

sTag -

Throws:

java.io.IOException

wrNewline

private void wrNewline(int add)
                throws java.io.IOException

Throws:

java.io.IOException

writeElementHeadEnd

public void writeElementHeadEnd(boolean bNewline)
                         throws java.io.IOException

Writes a simple end ">" because child nodes may be added to the element.

Throws:

java.io.IOException

writeElementEnd

public void writeElementEnd()
                     throws java.io.IOException

Writes a simple end "" or "/>" depending on invocation of #writeElementHeadEnd() before

Throws:

java.io.IOException

writeAttribute

public void writeAttribute(java.lang.String name,
                           java.lang.String value)
                    throws java.io.IOException

Throws:

java.io.IOException

writeText

public void writeText(java.lang.CharSequence txt,
                      boolean bNewline)
               throws java.io.IOException

Throws:

java.io.IOException

wrTxt

private void wrTxt(java.lang.CharSequence txt)
            throws java.io.IOException

Writes text with all replacements.

Parameters:

txt -

Throws:

java.io.IOException

wrTxtEncoded

private void wrTxtEncoded(java.lang.CharSequence txt)
                   throws java.io.IOException

Write a text, using #encoding2 to check write character immediately or as ģ for non encode able character. All character which are defined in the

Parameters:

txt -

Throws:

java.io.IOException

wrTxtAscii

private void wrTxtAscii(java.lang.String txt)
                 throws java.io.IOException

Write as given, only ASCII (7 bit) especially for XML head.

Parameters:

txt -

Throws:

java.io.IOException