- Companion:
- object
Value members
Concrete methods
Returns whether the options enable comments. This method is mostly used by the config lib internally, not by applications.
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
Returns whether the options enable formatting. This method is mostly used by the config lib internally, not by applications.
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
Returns whether the options enable JSON. This method is mostly used by the config lib internally, not by applications.
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
Returns whether the options enable automated origin comments. This method is mostly used by the config lib internally, not by applications.
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
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]]
.
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 parameters:
- value
true to include comments in the render
- Returns:
options with requested setting for comments
Returns options with formatting toggled. Formatting means indentation and whitespace, enabling formatting makes things prettier but larger.
Returns options with formatting toggled. Formatting means indentation and whitespace, enabling formatting makes things prettier but larger.
- Value parameters:
- value
true to enable formatting
- Returns:
options with requested setting for formatting
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.
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 parameters:
- value
true to include non-JSON extensions in the render
- Returns:
options with requested setting for JSON
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.
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 parameters:
- value
true to include autogenerated setting-origin comments in the render
- Returns:
options with origin comments toggled