org.vishia.xmlSimple

Class XmlBeautificator

java.lang.Object

org.vishia.xmlSimple.XmlBeautificator

public class XmlBeautificator
extends java.lang.Object

This class presents a ready to use tool to beautify the view to XML files. Sometimes XML files are packed in zip and packed in one line to save storage. Then the content is hard readable. This file reads an XML file, shows for '<' etc. to detect the structure and writes it out with indentation and newline.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	bEof
(package private) char[]	buffer
(package private) java.lang.CharSequence	csBuffer
(package private) int	end
(package private) java.io.File	fin
(package private) java.io.File	fout
(package private) int	indent Indent for the next newline
(package private) int	len
(package private) int	pos
(package private) java.io.Reader	rin
(package private) java.lang.String	sEncoding
(package private) char[]	sNewline Newline chars, starts with '\n' then spaces.
(package private) java.lang.String	sPathInZip If not null fin is a zip file, read this content.
(package private) java.lang.String	sWhitespaces
(package private) java.util.Stack<java.lang.String>	tags
(package private) java.io.Writer	wout
(package private) java.util.zip.ZipEntry	zipEntry
(package private) java.util.zip.ZipFile	zipfin If not null the zip file is opened and should be closed.

Constructor Summary

Constructors

Constructor and Description
XmlBeautificator()

Method Summary

Modifier and Type	Method and Description
private boolean	evaluateContent() Looks for textual content between tag elements and writes the close if found.
private void	evaluateElement(int recursion) Evaluate one element and recursively all nested ones.
(package private) void	evaluateStartTag() Reads first the content with len character.
static void	main(java.lang.String[] args) Calls the beautification from command line.
(package private) void	openInput()
private void	read() Reads a part from the rin input file if the buffer pos is in the second half.
private void	rw(java.lang.String[] args) This is the main routine.
private void	writeCloseTag() Writes the closing tag "
private void	writeNewline()

Methods inherited from class java.lang.Object

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

Field Detail

len

int len

buffer

char[] buffer

pos

int pos

end

int end

bEof

boolean bEof

fin

java.io.File fin

fout

java.io.File fout

zipfin

java.util.zip.ZipFile zipfin

If not null the zip file is opened and should be closed.

zipEntry

java.util.zip.ZipEntry zipEntry

sPathInZip

java.lang.String sPathInZip

If not null fin is a zip file, read this content.

rin

java.io.Reader rin

wout

java.io.Writer wout

sEncoding

java.lang.String sEncoding

sWhitespaces

final java.lang.String sWhitespaces

See Also:

Constant Field Values

indent

int indent

Indent for the next newline

sNewline

char[] sNewline

Newline chars, starts with '\n' then spaces.

csBuffer

final java.lang.CharSequence csBuffer

tags

java.util.Stack<java.lang.String> tags

Constructor Detail

XmlBeautificator

public XmlBeautificator()

Method Detail

rw

private void rw(java.lang.String[] args)

This is the main routine. It opens first the input and calls evaluateStartTag(). If the encoding (contained in first element ) is not UTF-8 the input will be closed and opened again, done in evaluateStartTag().
Then it creates the output with the same encoding as the input. Then it calls evaluateElement(int) for the whole only one element of the top level. All other is recursively.

Parameters:

args - see main(String[])

openInput

void openInput()
        throws java.io.IOException

Throws:

java.io.IOException

evaluateStartTag

void evaluateStartTag()
               throws java.io.IOException

Reads first the content with len character. It looks for "encoding=\"". It his is not identically with the initial sEncoding ("UTF-8") then it closes the input file and reopens it with the given encoding.
The XML file should start immediately with "" before return.

Throws:

java.io.IOException

read

private void read()
           throws java.io.IOException

Reads a part from the rin input file if the buffer pos is in the second half. Then also it shifts to content in buffer, pos = 0.
If pos is in the first half, nothing is done. As effect at least the half buffer is filled and evaluatable from pos to end

Throws:

java.io.IOException

evaluateElement

private void evaluateElement(int recursion)
                      throws java.io.IOException

Evaluate one element and recursively all nested ones.

Parameters:

recursion -

Throws:

java.io.IOException

writeCloseTag

private void writeCloseTag()
                    throws java.io.IOException

Writes the closing tag "

Throws:

java.io.IOException

evaluateContent

private boolean evaluateContent()
                         throws java.io.IOException

Looks for textual content between tag elements and writes the close if found. If only white spaces are given between

Parameters:

bNestedBefore - true if an element is opened but not closed.

Returns:

false if the closing it has been detected and written. Else value of bNestedBefore.

Throws:

java.io.IOException

writeNewline

private void writeNewline()
                   throws java.io.IOException

Throws:

java.io.IOException

main

public static void main(java.lang.String[] args)

Calls the beautification from command line.

Parameters:

args - First argument is path/to/input.xml Second argument is path/to/output.xml