sealed trait ConfigCursor extends AnyRef

A wrapper for a ConfigValue providing safe navigation through the config and holding positional data for better error handling.

Linear Supertypes
AnyRef, Any
Known Subclasses
ConfigListCursor, ConfigObjectCursor, SimpleConfigCursor
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConfigCursor
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def pathElems: List[String]

    The path in the config to which this cursor points as a list of keys in reverse order (deepest key first).

  2. abstract def value: ConfigValue

    The ConfigValue to which this cursor points to.

Concrete 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. def asCollectionCursor: Either[ConfigReaderFailures, Either[ConfigListCursor, ConfigObjectCursor]]

    Casts this cursor as either a ConfigListCursor or a ConfigObjectCursor.

    Casts this cursor as either a ConfigListCursor or a ConfigObjectCursor.

    returns

    a Right with this cursor as a list or object cursor if the cast can be done, Left with a list of failures otherwise.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def asList: Either[ConfigReaderFailures, List[ConfigCursor]]

    Casts this cursor to a list of cursors.

    Casts this cursor to a list of cursors.

    returns

    a Right with the list pointed to by this cursor if the cast can be done, Left with a list of failures otherwise.

  7. def asListCursor: Either[ConfigReaderFailures, ConfigListCursor]

    Casts this cursor to a ConfigListCursor.

    Casts this cursor to a ConfigListCursor.

    returns

    a Right with this cursor as a list cursor if the cast can be done, Left with a list of failures otherwise.

  8. def asMap: Either[ConfigReaderFailures, Map[String, ConfigCursor]]

    Casts this cursor to a map from config keys to cursors.

    Casts this cursor to a map from config keys to cursors.

    returns

    a Right with the map pointed to by this cursor if the cast can be done, Left with a list of failures otherwise.

  9. def asObjectCursor: Either[ConfigReaderFailures, ConfigObjectCursor]

    Casts this cursor to a ConfigObjectCursor.

    Casts this cursor to a ConfigObjectCursor.

    returns

    a Right with this cursor as an object cursor if it points to an object, Left with a list of failures otherwise.

  10. def asString: Either[ConfigReaderFailures, String]

    Casts this cursor to a string.

    Casts this cursor to a string.

    returns

    a Right with the string value pointed to by this cursor if the cast can be done, Left with a list of failures otherwise.

  11. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def failed[A](reason: FailureReason): Either[ConfigReaderFailures, A]

    Returns a failed ConfigReader result resulting from scoping a FailureReason into the context of this cursor.

    Returns a failed ConfigReader result resulting from scoping a FailureReason into the context of this cursor.

    This operation is the easiest way to return a failure from a ConfigReader.

    A

    the returning type of the ConfigReader

    reason

    the reason of the failure

    returns

    a failed ConfigReader result built by scoping reason into the context of this cursor.

  15. def failureFor(reason: FailureReason): ConfigReaderFailure

    Returns a ConfigReaderFailure resulting from scoping a FailureReason into the context of this cursor.

    Returns a ConfigReaderFailure resulting from scoping a FailureReason into the context of this cursor.

    This operation is useful for constructing ConfigReaderFailures when there are multiple FailureReasons.

    reason

    the reason of the failure

    returns

    a ConfigReaderFailure built by scoping reason into the context of this cursor.

  16. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def isNull: Boolean

    Returns whether this cursor points to a null config value.

    Returns whether this cursor points to a null config value. An explicit null value is different than a missing value - isUndefined can be used to check for the latter.

    returns

    true if this cursor points to a null value, false otherwise.

  21. def isUndefined: Boolean

    Returns whether this cursor points to an undefined value.

    Returns whether this cursor points to an undefined value. A cursor can point to an undefined value when a missing config key is requested or when a null ConfigValue is provided, among other reasons.

    returns

    true if this cursor points to an undefined value, false otherwise.

  22. def location: Option[ConfigValueLocation]

    The file system location of the config to which this cursor points.

  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. def path: String

    The path in the config to which this cursor points.

  27. def scopeFailure[A](result: Either[FailureReason, A]): Either[ConfigReaderFailures, A]

    Returns a failed ConfigReader result resulting from scoping a Either[FailureReason, A] into the context of this cursor.

    Returns a failed ConfigReader result resulting from scoping a Either[FailureReason, A] into the context of this cursor.

    This operation is needed when control of the reading process is passed to a place without a ConfigCursor instance providing the nexessary context (for example, when ConfigReader.fromString is used. In those scenarios, the call should be wrapped in this method in order to turn FailureReason instances into ConfigReaderFailures.

    A

    the returning type of the ConfigReader

    result

    the result of a config reading operation

    returns

    a ConfigReader result built by scoping reason into the context of this cursor.

  28. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped