c

org.ekrich.config.impl

SimpleConfigDocument

final class SimpleConfigDocument extends ConfigDocument

Linear Supertypes
ConfigDocument, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SimpleConfigDocument
  2. ConfigDocument
  3. AnyRef
  4. 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. var configNodeTree: ConfigNodeRoot
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(other: Any): Boolean
    Definition Classes
    SimpleConfigDocument → AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. def hasPath(path: String): Boolean

    Returns a boolean indicating whether or not a ConfigDocument has a value at the desired 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.

    path

    the path to check

    returns

    true if the path exists in the document, otherwise false

    Definition Classes
    SimpleConfigDocument → ConfigDocument
  11. def hashCode(): Int
    Definition Classes
    SimpleConfigDocument → AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  16. var parseOptions: ConfigParseOptions
  17. def render: String

    The original text of the input, modified if necessary with any replaced or added values.

    The original text of the input, modified if necessary with any replaced or added values.

    returns

    the modified original text

    Definition Classes
    SimpleConfigDocument → ConfigDocument
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. def withValue(path: String, newValue: ConfigValue): ConfigDocument

    Returns a new ConfigDocument that is a copy of the current ConfigDocument, but with the desired value set at the desired path.

    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, but takes a ConfigValue instead of a string.

    path

    the path at which to set the desired value

    newValue

    the value to set at the desired path, represented as a ConfigValue. The rendered text of the ConfigValue will be inserted into the ConfigDocument.

    returns

    a copy of the ConfigDocument with the desired value at the desired path

    Definition Classes
    SimpleConfigDocument → ConfigDocument
  24. def withValueText(path: String, newValue: String): ConfigDocument

    Returns a new ConfigDocument that is a copy of the current ConfigDocument, but with the desired value set at the desired path.

    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.

    path

    the path at which to set the desired value

    newValue

    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.

    returns

    a copy of the ConfigDocument with the desired value at the desired path

    Definition Classes
    SimpleConfigDocument → ConfigDocument
  25. def withoutPath(path: String): ConfigDocument

    Returns a new ConfigDocument that is a copy of the current ConfigDocument, but with all values at the desired path removed.

    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.

    path

    the path to remove from the document

    returns

    a copy of the ConfigDocument with the desired value removed from the document.

    Definition Classes
    SimpleConfigDocument → ConfigDocument

Deprecated Value Members

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

    (Since version 9)

Inherited from ConfigDocument

Inherited from AnyRef

Inherited from Any

Ungrouped