jhelp.util.xml

Class DynamicWriteXML

java.lang.Object

jhelp.util.xml.DynamicWriteXML

public class DynamicWriteXML
extends java.lang.Object

Write dynamically an XML to a stream.
No need to create a XML structure for writing it.

Author:

JHelp

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.BufferedWriter	bufferedWriter Buffer writer use to write on the stream
private boolean	closeWriterAtEnd Indicates if have to close writer when finish
private static java.lang.String	COMMENT_END End of comment
private static java.lang.String	COMMENT_START Start of comment
private java.util.Stack<java.lang.String>	markups Current stack of markups
private int	status Current status
private static int	STATUS_HAVE_TO_OPEN_MARKUP Status indicate that a markup have to be open
private static int	STATUS_MARKUP_CLOSED Status indicates that a markup just be closed
private static int	STATUS_MARKUP_OPENED Status indicates that a markup is open
private static int	STATUS_TERMINATE Status indicates that all is finsish
private static int	STATUS_TEXT_WRITEN Status indicates that a text just writen
private int	tab Current number of tabulation
private static java.lang.String	TAB Tabulation characters
private boolean	textSameLine Indicates if the text is on same line as the markup that contains it
private static java.lang.String	UTF8_FORMAT UTF 8 header

Constructor Summary

Constructors

Constructor and Description
DynamicWriteXML(java.io.OutputStream outputStream) Create a new instance of DynamicWriteXML not compact and text in separate line
DynamicWriteXML(java.io.OutputStream outputStream, boolean textSameLine) Create a new instance of DynamicWriteXML not compact
DynamicWriteXML(java.io.OutputStream outputStream, boolean compact, boolean textSameLine) Create a new instance of DynamicWriteXML
DynamicWriteXML(java.io.OutputStream outputStream, boolean compact, boolean textSameLine, boolean closeWriterAtEnd) Create a new instance of DynamicWriteXML

Method Summary

Methods

Modifier and Type	Method and Description
void	appendComment(java.lang.String comment) Add a comment
void	appendParameter(java.lang.String name, boolean value) Append a boolean parameter at current markup
void	appendParameter(java.lang.String name, int value) Append a int parameter at current markup
void	appendParameter(java.lang.String name, java.lang.String value) Append a string parameter to current markup
boolean	closeMarkup() Close current markup
void	openMarkup(java.lang.String markup) Open a markup
void	setText(java.lang.String text) Append a text to current markup

Methods inherited from class java.lang.Object

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

Field Detail

COMMENT_END

private static final java.lang.String COMMENT_END

End of comment

See Also:

Constant Field Values

COMMENT_START

private static final java.lang.String COMMENT_START

Start of comment

See Also:

Constant Field Values

STATUS_HAVE_TO_OPEN_MARKUP

private static final int STATUS_HAVE_TO_OPEN_MARKUP

Status indicate that a markup have to be open

See Also:

Constant Field Values

STATUS_MARKUP_CLOSED

private static final int STATUS_MARKUP_CLOSED

Status indicates that a markup just be closed

See Also:

Constant Field Values

STATUS_MARKUP_OPENED

private static final int STATUS_MARKUP_OPENED

Status indicates that a markup is open

See Also:

Constant Field Values

STATUS_TERMINATE

private static final int STATUS_TERMINATE

Status indicates that all is finsish

See Also:

Constant Field Values

STATUS_TEXT_WRITEN

private static final int STATUS_TEXT_WRITEN

Status indicates that a text just writen

See Also:

Constant Field Values

TAB

private static final java.lang.String TAB

Tabulation characters

See Also:

Constant Field Values

UTF8_FORMAT

private static final java.lang.String UTF8_FORMAT

UTF 8 header

See Also:

Constant Field Values

bufferedWriter

private final java.io.BufferedWriter bufferedWriter

Buffer writer use to write on the stream

closeWriterAtEnd

private final boolean closeWriterAtEnd

Indicates if have to close writer when finish

markups

private final java.util.Stack<java.lang.String> markups

Current stack of markups

status

private int status

Current status

tab

private int tab

Current number of tabulation

textSameLine

private final boolean textSameLine

Indicates if the text is on same line as the markup that contains it

Constructor Detail

DynamicWriteXML

public DynamicWriteXML(java.io.OutputStream outputStream)
                throws java.io.IOException

Create a new instance of DynamicWriteXML not compact and text in separate line

Parameters:

outputStream - Stream where write

Throws:

java.io.IOException - On writing header issue

DynamicWriteXML

public DynamicWriteXML(java.io.OutputStream outputStream,
               boolean textSameLine)
                throws java.io.IOException

Create a new instance of DynamicWriteXML not compact

Parameters:

outputStream - Stream where write

textSameLine - Indicates if text have to be in same line

Throws:

java.io.IOException - On writing header issue

DynamicWriteXML

public DynamicWriteXML(java.io.OutputStream outputStream,
               boolean compact,
               boolean textSameLine)
                throws java.io.IOException

Create a new instance of DynamicWriteXML

Parameters:

outputStream - Stream where write

compact - Indicates if use compact mode

textSameLine - Indicates if text at same line as its markup. Text will be forced in same line if compact mode is true

Throws:

java.io.IOException - On writing header issue

DynamicWriteXML

public DynamicWriteXML(java.io.OutputStream outputStream,
               boolean compact,
               boolean textSameLine,
               boolean closeWriterAtEnd)
                throws java.io.IOException

Create a new instance of DynamicWriteXML

Parameters:

outputStream - Stream where write

compact - Indicates if use compact mode

textSameLine - Indicates if text at same line as its markup. Text will be forced in same line if compact mode is true

closeWriterAtEnd - Indicates if have to close the stream when finish

Throws:

java.io.IOException - On writing header issue

Method Detail

appendComment

public void appendComment(java.lang.String comment)
                   throws java.io.IOException

Add a comment

Parameters:

comment - Comment to add

Throws:

java.io.IOException - On writing issue

appendParameter

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

Append a boolean parameter at current markup

Parameters:

name - Parameter name

value - Parameter value

Throws:

java.io.IOException - On writing issue

appendParameter

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

Append a int parameter at current markup

Parameters:

name - Parameter name

value - Parameter value

Throws:

java.io.IOException - On writing issue

appendParameter

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

Append a string parameter to current markup

Parameters:

name - Parameter name

value - Parameter value

Throws:

java.io.IOException - On writing issue

closeMarkup

public boolean closeMarkup()
                    throws java.io.IOException

Close current markup

Returns:

true if there are more markup to close. false if this is the last markup close and the the XML writing is finish

Throws:

java.io.IOException - On writing issue

openMarkup

public void openMarkup(java.lang.String markup)
                throws java.io.IOException

Open a markup

Parameters:

markup - Markup name

Throws:

java.io.IOException - On writing issue

setText

public void setText(java.lang.String text)
             throws java.io.IOException

Append a text to current markup

Parameters:

text - Text to write

Throws:

java.io.IOException - On writing issue