Package org.ujorm.tools.xml

Class AbstractWriter

java.lang.Object

org.ujorm.tools.xml.AbstractWriter

Direct Known Subclasses:

XmlPrinter, XmlWriter

public abstract class AbstractWriter
extends Object

A generic writer

Author:

Pavel Ponec

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CDATA_BEG	A CDATA beg markup sequence
static final String	CDATA_END	A CDATA end markup sequence
static final String	COMMENT_BEG	A comment beg sequence
static final String	COMMENT_END	A comment end sequence
protected final @NotNull XmlConfig	config	XML configuration
static final MsgFormatter	FORMATTER	Common formatter
static final char	FORWARD_SLASH	A forward slash character
static final String	HTML_DOCTYPE	Default DOCTYPE of HTML-5
protected final boolean	indentationEnabled	An indentation request
static final char	NBSP	Non-breaking space character
protected final @NotNull Appendable	out	Output
static final char	SPACE	A special XML character
static final char	XML_2QUOT	A special XML character
static final char	XML_AMPERSAND	A special XML character
static final char	XML_APOSTROPHE	A special XML character
static final char	XML_GT	A special XML character
static final String	XML_HEADER	Default XML declaration
static final char	XML_LT	A special XML character

Constructor Summary

Constructors

Constructor	Description
AbstractWriter(@NotNull Appendable out, @NotNull XmlConfig config)	A writer constructor

Method Summary

Modifier and Type	Method	Description
static @NotNull Appendable	createWriter(@NotNull Object httpServletResponse, @NotNull Charset charset, boolean noCache)	Assign a no-cache and an Edge compatibility mode and returns a writer from HttpServletResponse
@NotNull Appendable	getWriter()	For internal usage only
@NotNull Appendable	getWriterEscaped()	Get Writer to escape HTML characters.
String	toString()
final void	write(@NotNull CharSequence text, boolean attribute)	Write escaped value to the output
void	writeNewLine(int level)	Write a new line with an offset by the current level
final void	writeRawValue(@NotNull CharSequence rawValue, @NotNull ApiElement element)	Write the content of an envelope
void	writeValue(@Nullable Object value, @NotNull ApiElement element, @Nullable String attributeName)	Write escaped value to the output

Methods inherited from class java.lang.Object

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

Field Details

XML_HEADER

public static final String XML_HEADER

Default XML declaration

See Also:

• Constant Field Values

HTML_DOCTYPE

public static final String HTML_DOCTYPE

Default DOCTYPE of HTML-5

See Also:

• Constant Field Values

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_AMPERSAND

public static final char XML_AMPERSAND

A special XML character

See Also:

• Constant Field Values

XML_APOSTROPHE

public static final char XML_APOSTROPHE

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

SPACE

public static final char SPACE

A special XML character

See Also:

• Constant Field Values

NBSP

public static final char NBSP

Non-breaking space 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

FORMATTER

public static final MsgFormatter FORMATTER

Common formatter

out

@NotNull
protected final @NotNull Appendable out

Output

config

@NotNull
protected final @NotNull XmlConfig config

XML configuration

indentationEnabled

protected final boolean indentationEnabled

An indentation request

Constructor Details

AbstractWriter

public AbstractWriter(@NotNull
 @NotNull Appendable out,
 @NotNull
 @NotNull XmlConfig config)

A writer constructor

Parameters:

out - A writer

config - XML configuration

Method Details

write

public final void write(@NotNull
 @NotNull CharSequence text,
 boolean attribute)
                 throws IOException

Write escaped value to the output

Parameters:

text - A value to write

attribute - Write an attribute value

Throws:

IOException

writeValue

public void writeValue(@Nullable
 @Nullable Object value,
 @NotNull
 @NotNull ApiElement element,
 @Nullable
 @Nullable String attributeName)
                throws IOException

Write escaped value to the output

Parameters:

value - A value to write, where the null value is ignored silently.

element - The element

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

Throws:

IOException

writeRawValue

public final void writeRawValue(@NotNull
 @NotNull CharSequence rawValue,
 @NotNull
 @NotNull ApiElement element)
                         throws IOException

Write the content of an envelope

Parameters:

rawValue - A raw value to print

element - An original element

Throws:

IOException

writeNewLine

public void writeNewLine(int level)
                  throws IOException

Write a new line with an offset by the current level

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

getWriter

@NotNull
public @NotNull Appendable getWriter()

For internal usage only

getWriterEscaped

@NotNull
public @NotNull Appendable getWriterEscaped()

Get Writer to escape HTML characters.

createWriter

@NotNull
public static @NotNull Appendable createWriter(@NotNull
 @NotNull Object httpServletResponse,
 @NotNull
 @NotNull Charset charset,
 boolean noCache)
                                        throws ReflectiveOperationException

Assign a no-cache and an Edge compatibility mode and returns a writer from HttpServletResponse

Throws:

ReflectiveOperationException