org.ujorm.tools.xml.model

Class XmlWriter

java.lang.Object

org.ujorm.tools.xml.AbstractWriter

org.ujorm.tools.xml.model.XmlWriter

public class XmlWriter
extends AbstractWriter

If you need special formatting, overwrite responsible methods.

Since:

1.88

Author:

Pavel Ponec

See Also:

XmlModel

Field Summary

Fields inherited from class org.ujorm.tools.xml.AbstractWriter

CDATA_BEG, CDATA_END, COMMENT_BEG, COMMENT_END, config, FORMATTER, FORWARD_SLASH, HTML_DOCTYPE, indentationEnabled, NBSP, out, SPACE, XML_2QUOT, XML_AMPERSAND, XML_APOSTROPHE, XML_GT, XML_HEADER, XML_LT

Constructor Summary

Constructors

Constructor and Description
XmlWriter() Default constructor a zero offset
XmlWriter(@NotNull Appendable out) Writer constructor with a zero offset
XmlWriter(@NotNull Appendable out, @NotNull CharSequence indentationSpace) A writer constructor

Method Summary

Modifier and Type	Method and Description
protected @NotNull XmlWriter	write(int level, @Nullable CharSequence name, @Nullable Map<String,Object> attributes, @Nullable List<Object> children, @NotNull XmlModel element) Render the XML code without header
@NotNull XmlWriter	write(int level, @NotNull XmlModel element) Render the XML code without header

Methods inherited from class org.ujorm.tools.xml.AbstractWriter

createWriter, getWriter, getWriterEscaped, toString, write, writeNewLine, writeRawValue, writeValue

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlWriter

public XmlWriter()

Default constructor a zero offset

XmlWriter

public XmlWriter(@NotNull
                 @NotNull Appendable out)

Writer constructor with a zero offset

XmlWriter

public XmlWriter(@NotNull
                 @NotNull Appendable out,
                 @NotNull
                 @NotNull CharSequence indentationSpace)

A writer constructor

Parameters:

out - A writer

indentationSpace - String for a one level offset.

Method Detail

write

@NotNull
public final @NotNull XmlWriter write(int level,
                                               @NotNull
                                               @NotNull XmlModel element)
                                        throws IOException

Render the XML code without header

Throws:

IOException

write

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

Render the XML code without header

Parameters:

level - Element nesting level.

name - Name of element where the null is allowed for an AJAX responses

attributes - Attributes of the element

children - Childern of the element including null items

element - Original element

Returns:

This

Throws:

IOException