org.ujorm.tools.dom

Class XmlWriter

java.lang.Object

org.ujorm.tools.dom.XmlWriter

public class XmlWriter
extends Object

If you need special formatting, overwrite responsible methods.

Since:

1.88

See Also:

XmlElement

Field Summary

Fields

Modifier and Type	Field and Description
static String	CDATA_BEG A CDATA beg markup sequence
static String	CDATA_END A CDATA end markup sequence
static String	COMMENT_BEG A comment beg sequence
static String	COMMENT_END A comment end sequence
static char	FORWARD_SLASH A forward slash character
static char	CHAR_NEW_LINE A new line character
static char	CHAR_SPACE A special XML character
protected boolean	offsetEnabled An element offset is enabled
protected String	offsetSpace An offset space
protected Writer	out Writer
static char	XML_2QUOT A special XML character
static char	XML_AMP A special XML character
static char	XML_GT A special XML character
static char	XML_LT A special XML character
static char	XML_QUOT A special XML character

Constructor Summary

Constructors

Constructor and Description
XmlWriter() Default constructor a zero offset
XmlWriter(Writer out) Writer constructor with a zero offset
XmlWriter(Writer out, String offsetSpace) A writer constructor

Method Summary

Modifier and Type	Method and Description
protected void	newLine(int level) Write a new line with an offset
String	toString()
protected XmlWriter	write(int level, CharSequence name, Map<String,Object> attributes, List<Object> children, XmlElement element) Render the XML code without header
XmlWriter	write(int level, XmlElement element) Render the XML code without header
protected void	writeValue(Object value, XmlElement element, String attribute, Writer out) Write escaped value to the output

Methods inherited from class java.lang.Object

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

Field Detail

XML_GT

public static final char XML_GT

A special XML character

See Also:

Constant Field Values

XML_LT

public static final char XML_LT

A special XML character

See Also:

Constant Field Values

XML_AMP

public static final char XML_AMP

A special XML character

See Also:

Constant Field Values

XML_QUOT

public static final char XML_QUOT

A special XML character

See Also:

Constant Field Values

XML_2QUOT

public static final char XML_2QUOT

A special XML character

See Also:

Constant Field Values

CHAR_SPACE

public static final char CHAR_SPACE

A special XML character

See Also:

Constant Field Values

CHAR_NEW_LINE

public static final char CHAR_NEW_LINE

A new line character

See Also:

Constant Field Values

FORWARD_SLASH

public static final char FORWARD_SLASH

A forward slash character

See Also:

Constant Field Values

CDATA_BEG

public static final String CDATA_BEG

A CDATA beg markup sequence

See Also:

Constant Field Values

CDATA_END

public static final String CDATA_END

A CDATA end markup sequence

See Also:

Constant Field Values

COMMENT_BEG

public static final String COMMENT_BEG

A comment beg sequence

See Also:

Constant Field Values

COMMENT_END

public static final String COMMENT_END

A comment end sequence

See Also:

Constant Field Values

out

@Nonnull
protected final Writer out

Writer

offsetEnabled

protected final boolean offsetEnabled

An element offset is enabled

offsetSpace

@Nullable
protected final String offsetSpace

An offset space

Constructor Detail

XmlWriter

public XmlWriter()

Default constructor a zero offset

XmlWriter

public XmlWriter(@Nonnull
                 Writer out)

Writer constructor with a zero offset

XmlWriter

public XmlWriter(@Nonnull
                 Writer out,
                 @Nullable
                 String offsetSpace)

A writer constructor

Parameters:

out - A writer

offsetSpace - String for a one level offset.

Method Detail

write

@Nonnull
public XmlWriter write(int level,
                                @Nonnull
                                XmlElement element)
                         throws IOException

Render the XML code without header

Throws:

IOException

write

@Nonnull
protected XmlWriter write(int level,
                                   @Nonnull
                                   CharSequence name,
                                   @Nullable
                                   Map<String,Object> attributes,
                                   @Nullable
                                   List<Object> children,
                                   @Nonnull
                                   XmlElement element)
                            throws IOException

Render the XML code without header

Parameters:

level - Element nesting level.

name - Name of element

attributes - Attributes of the element

children - Childern of the element

element - Original element

Returns:

This

Throws:

IOException

newLine

protected void newLine(int level)
                throws IOException

Write a new line with an offset

Throws:

IOException

writeValue

protected void writeValue(@Nonnull
                          Object value,
                          @Nonnull
                          XmlElement element,
                          @Nullable
                          String attribute,
                          @Nonnull
                          Writer out)
                   throws IOException

Write escaped value to the output

Parameters:

value - A value to write

element - The element

attribute - A name of the XML attribute of null value for a XML text.

out - An output writer

Throws:

IOException

toString

@Nonnull
public String toString()

Overrides:

toString in class Object