org.ujorm.tools.xml.config.impl

Class DefaultXmlConfig

java.lang.Object

org.ujorm.tools.xml.config.impl.DefaultXmlConfig

All Implemented Interfaces:

XmlConfig

Direct Known Subclasses:

DefaultHtmlConfig

public class DefaultXmlConfig
extends Object
implements XmlConfig

Configuraion of HtmlPage

Author:

Pavel Ponec

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_FIRST_LEVEL Default first level of intendation
static String	DEFAULT_INTENDATION Default intendation per level
static String	DEFAULT_NEW_LINE Default string or the new line
protected @Nullable CharSequence	doctype A header declaration of the document or a doctype
static String	EMPTY An empty String
static String	REQUIRED_MSG Assertion message template

Constructor Summary

Constructors

Constructor and Description
DefaultXmlConfig()
DefaultXmlConfig(@NotNull XmlConfig config) Copy attributes from other config

Method Summary

Modifier and Type	Method and Description
CharSequence	getDefaultValue() A replacement text instead of the null value
@NotNull CharSequence	getDoctype() A header declaration of the document or a doctype
int	getFirstLevel() Level of the root element, the value may be negative.
@NotNull Formatter	getFormatter() A default implementation is: String.valueOf(value)
@NotNull Charset	getCharset() Charset
@NotNull CharSequence	getIndentation() An indentation space for elements of the next level, where default value is an empty `String`
CharSequence	getNewLine() A new line sequence
boolean	isCacheAllowed() HTTP cache is allowed
protected <T> T	nonnull(T value, T defaultValue)
DefaultXmlConfig	setCacheAllowed(boolean cacheAllowed)
DefaultXmlConfig	setCompressedFormat() Assign parameters for a compressed format of the HTML result
DefaultXmlConfig	setDefaultValue(@NotNull String defaultValue) A replacement text instead of the null value
DefaultXmlConfig	setDoctype(@Nullable CharSequence doctype) A header declaration of the document or a doctype
DefaultXmlConfig	setFirstLevel(int firstLevel) Level of the root element, the value may be negative.
DefaultXmlConfig	setFormatter(@NotNull Formatter formatter) A default value formatter is implemented by the method String.valueOf(value)
DefaultXmlConfig	setCharset(@NotNull Charset charset) Charset
DefaultXmlConfig	setIndentationSpace(@NotNull CharSequence indentation) An indentation space for elements of the next level, where default value is an empty `String`
DefaultXmlConfig	setNewLine(@NotNull CharSequence newLine) A new line sequence
<T extends DefaultXmlConfig> T	setNiceFormat() Assign parameters for a nice format of the HTML result
<T extends DefaultXmlConfig> T	setNiceFormat(@Nullable CharSequence indentation) Assign parameters for a nice format of the HTML result

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ujorm.tools.xml.config.XmlConfig

ofDefault, ofDoctype

Field Detail

DEFAULT_INTENDATION

public static final String DEFAULT_INTENDATION

Default intendation per level

See Also:

Constant Field Values

DEFAULT_NEW_LINE

public static final String DEFAULT_NEW_LINE

Default string or the new line

See Also:

Constant Field Values

DEFAULT_FIRST_LEVEL

public static final int DEFAULT_FIRST_LEVEL

Default first level of intendation

See Also:

Constant Field Values

REQUIRED_MSG

public static final String REQUIRED_MSG

Assertion message template

See Also:

Constant Field Values

EMPTY

public static final String EMPTY

An empty String

See Also:

Constant Field Values

doctype

@Nullable
protected @Nullable CharSequence doctype

A header declaration of the document or a doctype

Constructor Detail

DefaultXmlConfig

public DefaultXmlConfig()

DefaultXmlConfig

public DefaultXmlConfig(@NotNull
                        @NotNull XmlConfig config)

Copy attributes from other config

Method Detail

getDoctype

@NotNull
public @NotNull CharSequence getDoctype()

A header declaration of the document or a doctype

Specified by:

getDoctype in interface XmlConfig

nonnull

@NotNull
protected final <T> T nonnull(@Nullable
                                       T value,
                                       @NotNull
                                       T defaultValue)

setDoctype

public DefaultXmlConfig setDoctype(@Nullable
                                   @Nullable CharSequence doctype)

A header declaration of the document or a doctype

getCharset

@NotNull
public @NotNull Charset getCharset()

Charset

Specified by:

getCharset in interface XmlConfig

Returns:

the charset

setCharset

public DefaultXmlConfig setCharset(@NotNull
                                   @NotNull Charset charset)

Charset

Parameters:

charset - the charset to set

setNiceFormat

public final <T extends DefaultXmlConfig> T setNiceFormat()

Assign parameters for a nice format of the HTML result

setNiceFormat

public final <T extends DefaultXmlConfig> T setNiceFormat(@Nullable
                                                          @Nullable CharSequence indentation)

Assign parameters for a nice format of the HTML result

Parameters:

indentation - An empty String is replaced by a default intendation.

setCompressedFormat

public final DefaultXmlConfig setCompressedFormat()

Assign parameters for a compressed format of the HTML result

getFirstLevel

public int getFirstLevel()

Level of the root element, the value may be negative.

Specified by:

getFirstLevel in interface XmlConfig

Returns:

the firstLevel

setFirstLevel

public DefaultXmlConfig setFirstLevel(int firstLevel)

Level of the root element, the value may be negative.

Parameters:

firstLevel - the firstLevel to set

getIndentation

@NotNull
public @NotNull CharSequence getIndentation()

An indentation space for elements of the next level, where default value is an empty `String`

Specified by:

getIndentation in interface XmlConfig

Returns:

the newLine

setIndentationSpace

public DefaultXmlConfig setIndentationSpace(@NotNull
                                            @NotNull CharSequence indentation)

An indentation space for elements of the next level, where default value is an empty `String`

getDefaultValue

public CharSequence getDefaultValue()

A replacement text instead of the null value

Specified by:

getDefaultValue in interface XmlConfig

getFormatter

@NotNull
public @NotNull Formatter getFormatter()

A default implementation is: String.valueOf(value)

Specified by:

getFormatter in interface XmlConfig

setDefaultValue

public DefaultXmlConfig setDefaultValue(@NotNull
                                        @NotNull String defaultValue)

A replacement text instead of the null value

isCacheAllowed

public boolean isCacheAllowed()

Description copied from interface: XmlConfig

HTTP cache is allowed

Specified by:

isCacheAllowed in interface XmlConfig

Returns:

setCacheAllowed

public DefaultXmlConfig setCacheAllowed(boolean cacheAllowed)

getNewLine

public CharSequence getNewLine()

A new line sequence

Specified by:

getNewLine in interface XmlConfig

setNewLine

public DefaultXmlConfig setNewLine(@NotNull
                                   @NotNull CharSequence newLine)

A new line sequence

setFormatter

public DefaultXmlConfig setFormatter(@NotNull
                                     @NotNull Formatter formatter)

A default value formatter is implemented by the method String.valueOf(value)