final class ConfigRenderOptions extends AnyRef

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConfigRenderOptions
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. 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

  10. 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

  11. 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

  12. 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

  13. 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

  14. 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

  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  20. 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

  21. 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

  22. 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

  23. 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

  24. 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

  25. 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

  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    ConfigRenderOptions → AnyRef → Any
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def comments: Boolean
    Annotations
    @deprecated
    Deprecated

    (Since version Since 1.12.0, will remove in 1.14.0) Use getComments

  2. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  3. def formatted: Boolean
    Annotations
    @deprecated
    Deprecated

    (Since version Since 1.12.0, will remove in 1.14.0) Use getFormatted

  4. def formattingOptions: FormattingOptions
    Annotations
    @deprecated
    Deprecated

    (Since version Since 1.12.0, will remove in 1.14.0) Use getConfigFormatOptions

  5. def getFormattingOptions: FormattingOptions
    Annotations
    @deprecated
    Deprecated

    (Since version Since 1.12.0, will remove in 1.14.0) Use getConfigFormatOptions

  6. def json: Boolean
    Annotations
    @deprecated
    Deprecated

    (Since version Since 1.12.0, will remove in 1.14.0) Use getJson

  7. def originComments: Boolean
    Annotations
    @deprecated
    Deprecated

    (Since version Since 1.12.0, will remove in 1.14.0) Use getOriginComments

  8. 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

  9. def showEnvVariableValues: Boolean
    Annotations
    @deprecated
    Deprecated

    (Since version Since 1.12.0, will remove in 1.14.0) Use getShowEnvVariableValues

Inherited from AnyRef

Inherited from Any

Ungrouped