final class ConfigRenderOptions extends AnyRef
- Alphabetic
- By Inheritance
- ConfigRenderOptions
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def getComments: Boolean
Returns whether the options enable comments.
Returns whether the options enable comments. This method is mostly used by the config lib internally, not by applications.
- returns
true if comments should be rendered
- def getConfigFormatOptions: ConfigFormatOptions
Returns options used to format the config.
Returns options used to format the config.
- returns
the config format option
- Since
1.12.0
- def getFormatted: Boolean
Returns whether the options enable formatting.
Returns whether the options enable formatting. This method is mostly used by the config lib internally, not by applications.
- returns
true if the options enable formatting
- def getJson: Boolean
Returns whether the options enable JSON.
Returns whether the options enable JSON. This method is mostly used by the config lib internally, not by applications.
- returns
true if only JSON should be rendered
- def getOriginComments: Boolean
Returns whether the options enable automated origin comments.
Returns whether the options enable automated origin comments. This method is mostly used by the config lib internally, not by applications.
- returns
true if origin comments should be rendered
- def getShowEnvVariableValues: Boolean
Returns whether the options enable rendering of environment variable values.
Returns whether the options enable rendering of environment variable values. This method is mostly used by the config lib internally, not by applications.
- returns
true if environment variable values should be rendered
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def setComments(value: Boolean): ConfigRenderOptions
Returns options with comments toggled.
Returns options with comments toggled. This controls human-written comments but not the autogenerated "origin of this setting" comments, which are controlled by ConfigRenderOptions#setOriginComments.
- value
true to include comments in the render
- returns
options with requested setting for comments
- def setConfigFormatOptions(value: ConfigFormatOptions): ConfigRenderOptions
Set the config format options.
Set the config format options. Formatting is dependant on formatted flag.
- value
the new ConfigFormatOptions object
- returns
the new ConfigRenderOptions object with the new formatting setting
- Since
1.12.0
- def setFormatted(value: Boolean): ConfigRenderOptions
Returns options with formatting toggled.
Returns options with formatting toggled. Formatting means indentation and whitespace, enabling formatting makes things prettier but larger.
- value
true to enable formatting
- returns
options with requested setting for formatting
- def setJson(value: Boolean): ConfigRenderOptions
Returns options with JSON toggled.
Returns options with JSON toggled. JSON means that HOCON extensions (omitting commas, quotes for example) won't be used. However, whether to use comments is controlled by the separate #setComments and #setOriginComments options. So if you enable comments you will get invalid JSON despite setting this to true.
- value
true to include non-JSON extensions in the render
- returns
options with requested setting for JSON
- def setOriginComments(value: Boolean): ConfigRenderOptions
Returns options with origin comments toggled.
Returns options with origin comments toggled. If this is enabled, the library generates comments for each setting based on the ConfigValue#origin of that setting's value. For example these comments might tell you which file a setting comes from.
setOriginComments(Boolean)controls only these autogenerated "origin of this setting" comments, to toggle regular comments use ConfigRenderOptions#setComments.- value
true to include autogenerated setting-origin comments in the render
- returns
options with origin comments toggled
- def setShowEnvVariableValues(value: Boolean): ConfigRenderOptions
Returns options with showEnvVariableValues toggled.
Returns options with showEnvVariableValues toggled. This controls if values set from environment variables are included in the rendered string.
- value
true to include environment variable values in the render
- returns
options with requested setting for environment variables
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- ConfigRenderOptions → AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def comments: Boolean
- Annotations
- @deprecated
- Deprecated
(Since version Since 1.12.0, will remove in 1.14.0) Use getComments
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted: Boolean
- Annotations
- @deprecated
- Deprecated
(Since version Since 1.12.0, will remove in 1.14.0) Use getFormatted
- def formattingOptions: FormattingOptions
- Annotations
- @deprecated
- Deprecated
(Since version Since 1.12.0, will remove in 1.14.0) Use getConfigFormatOptions
- def getFormattingOptions: FormattingOptions
- Annotations
- @deprecated
- Deprecated
(Since version Since 1.12.0, will remove in 1.14.0) Use getConfigFormatOptions
- def json: Boolean
- Annotations
- @deprecated
- Deprecated
(Since version Since 1.12.0, will remove in 1.14.0) Use getJson
- def originComments: Boolean
- Annotations
- @deprecated
- Deprecated
(Since version Since 1.12.0, will remove in 1.14.0) Use getOriginComments
- def setFormattingOptions(value: FormattingOptions): ConfigRenderOptions
Returns new render options with formatting options set.
Returns new render options with formatting options set. Formatting is dependant on formatted flag.
- value
true to enable formatting
- returns
options with requested setting for formatting
- Annotations
- @deprecated
- Deprecated
(Since version Since 1.12.0, will remove in 1.14.0) Use setConfigFormatOptions
- def showEnvVariableValues: Boolean
- Annotations
- @deprecated
- Deprecated
(Since version Since 1.12.0, will remove in 1.14.0) Use getShowEnvVariableValues