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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static JSWriterSettingscreateCloneOnDemand(IJSWriterSettings aSettings)JSWriterSettingsgetClone()StringgetIndent()com.helger.commons.system.ENewLineModegetNewLineMode()StringgetNewLineString()booleanisGenerateComments()booleanisIndentAndAlign()JSWriterSettingssetGenerateComments(boolean bGenerateComments)JSWriterSettingssetIndent(String sIndent)JSWriterSettingssetIndentAndAlign(boolean bIndentAndAlign)JSWriterSettingssetMinimumCodeSize(boolean bMinimumCodeSize)This is a wrapper aroundsetIndentAndAlign(boolean), { andsetGenerateComments(boolean)JSWriterSettingssetNewLineMode(com.helger.commons.system.ENewLineMode eNewLineMode)StringtoString()
-
-
-
Constructor Detail
-
JSWriterSettings
public JSWriterSettings()
-
JSWriterSettings
public JSWriterSettings(@Nonnull IJSWriterSettings aOther)
-
-
Method Detail
-
isIndentAndAlign
public boolean isIndentAndAlign()
- Specified by:
isIndentAndAlignin interfaceIJSWriterSettings- Returns:
trueif the code should be indented and aligned.
-
setIndentAndAlign
@Nonnull public JSWriterSettings setIndentAndAlign(boolean bIndentAndAlign)
-
isGenerateComments
public boolean isGenerateComments()
- Specified by:
isGenerateCommentsin interfaceIJSWriterSettings- Returns:
trueif comments should be generated at all.
-
setGenerateComments
@Nonnull public JSWriterSettings setGenerateComments(boolean bGenerateComments)
-
setMinimumCodeSize
@Nonnull public JSWriterSettings setMinimumCodeSize(boolean bMinimumCodeSize)
This is a wrapper aroundsetIndentAndAlign(boolean), { andsetGenerateComments(boolean)- Parameters:
bMinimumCodeSize- true for minimum code size- Returns:
- this
-
getIndent
@Nonnull @Nonempty public String getIndent()
- Specified by:
getIndentin interfaceIJSWriterSettings- 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:
getNewLineModein interfaceIJSWriterSettings- 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:
getNewLineStringin interfaceIJSWriterSettings- Returns:
- The string representing the new line mode. A shortcut for
.IJSWriterSettings.getNewLineMode().getText()
-
getClone
@Nonnull @ReturnsMutableCopy public JSWriterSettings getClone()
- Specified by:
getClonein interfacecom.helger.commons.lang.ICloneable<JSWriterSettings>
-
createCloneOnDemand
@Nonnull @ReturnsMutableCopy public static JSWriterSettings createCloneOnDemand(@Nullable IJSWriterSettings aSettings)
-
-