Package com.helger.html.js

Class JSWriterSettings

java.lang.Object

com.helger.html.js.JSWriterSettings

All Implemented Interfaces:

com.helger.commons.lang.ICloneable<JSWriterSettings>, IJSWriterSettings, Serializable

@NotThreadSafe
public class JSWriterSettings
extends Object
implements IJSWriterSettings, com.helger.commons.lang.ICloneable<JSWriterSettings>

Settings for the textual representation of JSDOM objects

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
JSWriterSettings()
JSWriterSettings(IJSWriterSettings aOther)

Method Summary

Modifier and Type	Method	Description
static JSWriterSettings	createCloneOnDemand(IJSWriterSettings aSettings)
JSWriterSettings	getClone()
String	getIndent()
com.helger.commons.system.ENewLineMode	getNewLineMode()
String	getNewLineString()
boolean	isGenerateComments()
boolean	isIndentAndAlign()
JSWriterSettings	setGenerateComments(boolean bGenerateComments)
JSWriterSettings	setIndent(String sIndent)
JSWriterSettings	setIndentAndAlign(boolean bIndentAndAlign)
JSWriterSettings	setMinimumCodeSize(boolean bMinimumCodeSize)	This is a wrapper around setIndentAndAlign(boolean), { and setGenerateComments(boolean)
JSWriterSettings	setNewLineMode(com.helger.commons.system.ENewLineMode eNewLineMode)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JSWriterSettings

public JSWriterSettings()

JSWriterSettings

public JSWriterSettings(@Nonnull
                        IJSWriterSettings aOther)

Method Detail

isIndentAndAlign

public boolean isIndentAndAlign()

Specified by:

isIndentAndAlign in interface IJSWriterSettings

Returns:

true if the code should be indented and aligned.

setIndentAndAlign

@Nonnull
public JSWriterSettings setIndentAndAlign(boolean bIndentAndAlign)

isGenerateComments

public boolean isGenerateComments()

Specified by:

isGenerateComments in interface IJSWriterSettings

Returns:

true if comments should be generated at all.

setGenerateComments

@Nonnull
public JSWriterSettings setGenerateComments(boolean bGenerateComments)

setMinimumCodeSize

@Nonnull
public JSWriterSettings setMinimumCodeSize(boolean bMinimumCodeSize)

This is a wrapper around setIndentAndAlign(boolean), { and setGenerateComments(boolean)

Parameters:

bMinimumCodeSize - true for minimum code size

Returns:

this

getIndent

@Nonnull
@Nonempty
public String getIndent()

Specified by:

getIndent in interface IJSWriterSettings

Returns:

The string used for indenting a single level. By default it is 2 spaces.

setIndent

@Nonnull
public JSWriterSettings setIndent(@Nonnull @Nonempty
                                  String sIndent)

setNewLineMode

@Nonnull
public JSWriterSettings setNewLineMode(@Nonnull
                                       com.helger.commons.system.ENewLineMode eNewLineMode)

getNewLineMode

@Nonnull
public com.helger.commons.system.ENewLineMode getNewLineMode()

Specified by:

getNewLineMode in interface IJSWriterSettings

Returns:

The newline mode to be used. By default it is the platform specific new line mode. Never null.

getNewLineString

@Nonnull
@Nonempty
public String getNewLineString()

Specified by:

getNewLineString in interface IJSWriterSettings

Returns:

The string representing the new line mode. A shortcut for IJSWriterSettings.getNewLineMode().getText().

getClone

@Nonnull
@ReturnsMutableCopy
public JSWriterSettings getClone()

Specified by:

getClone in interface com.helger.commons.lang.ICloneable<JSWriterSettings>

toString

public String toString()

Overrides:

toString in class Object

createCloneOnDemand

@Nonnull
@ReturnsMutableCopy
public static JSWriterSettings createCloneOnDemand(@Nullable
                                                   IJSWriterSettings aSettings)