ConfigRenderOptions

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[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

6. val comments: Boolean

   

7. final def eq(arg0: AnyRef): Boolean

   

   Definition Classes

   AnyRef

8. def equals(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

9. def finalize(): Unit

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( classOf[java.lang.Throwable] )

10. val formatted: Boolean

    

11. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

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

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

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

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

16. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

17. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

18. val json: Boolean

    

19. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

20. final def notify(): Unit

    

    Definition Classes

    AnyRef

21. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

22. val originComments: Boolean

    

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

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

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

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

27. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

28. def toString(): String

    

    Definition Classes

    ConfigRenderOptions → AnyRef → Any

29. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

30. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

31. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )