Because this object is immutable, it is safe to use from multiple threads and there's no need for "defensive copies."
Do not implement interface ConfigDocument; it should only be
implemented by the config library. Arbitrary implementations will not work
because the library internals assume a specific concrete implementation.
Also, this interface is likely to grow new methods over time, so third-party
implementations will break.
| Modifier and Type | Method and Description |
|---|---|
| public boolean | |
| public String | Returns: the modified original textThe original text of the input, modified if necessary with any replaced or added values. |
| public ConfigDocument | Returns: a copy of the ConfigDocument with the desired value removed from the document.the path to remove from the document path)Returns a new ConfigDocument that is a copy of the current ConfigDocument, but with all values at the desired path removed. |
| public ConfigDocument | Returns: a copy of the ConfigDocument with the desired value at the desired paththe path at which to set the desired value path, ConfigValue the value to set at the desired path, represented as a ConfigValue.
The rendered text of the ConfigValue will be inserted into the
ConfigDocument. newValue)Returns a new ConfigDocument that is a copy of the current ConfigDocument, but with the desired value set at the desired path. |
| public ConfigDocument | Returns: a copy of the ConfigDocument with the desired value at the desired paththe path at which to set the desired value path, String the value to set at the desired path, represented as a string. This
string will be parsed into a ConfigNode using the same options used to
parse the entire document, and the text will be inserted
as-is into the document. Leading and trailing comments, whitespace, or
newlines are not allowed, and if present an exception will be thrown.
If a concatenation is passed in for newValue but the document was parsed
with JSON, the first value in the concatenation will be parsed and inserted
into the ConfigDocument. newValue)Returns a new ConfigDocument that is a copy of the current ConfigDocument, but with the desired value set at the desired path. |
| hasPath | back to summary |
|---|---|
| public boolean hasPath(String path) Returns a boolean indicating whether or not a ConfigDocument has a value at the desired path. null counts as a value for purposes of this check.
| |
| render | back to summary |
|---|---|
| public String render() The original text of the input, modified if necessary with any replaced or added values.
| |
| withoutPath | back to summary |
|---|---|
| public ConfigDocument withoutPath(String path) Returns a new ConfigDocument that is a copy of the current ConfigDocument, but with all values at the desired path removed. If the path does not exist in the document, a copy of the current document will be returned. If there is an array at the root, an exception will be thrown.
| |
| withValue | back to summary |
|---|---|
| public ConfigDocument withValue(String path, ConfigValue newValue) Returns a new ConfigDocument that is a copy of the current
ConfigDocument, but with the desired value set at the
desired path. Works like
| |
| withValueText | back to summary |
|---|---|
| public ConfigDocument withValueText(String path, String newValue) Returns a new ConfigDocument that is a copy of the current ConfigDocument, but with the desired value set at the desired path. If the path exists, it will remove all duplicates before the final occurrence of the path, and replace the value at the final occurrence of the path. If the path does not exist, it will be added. If the document has an array as the root value, an exception will be thrown.
| |