c

pureconfig

SimpleConfigCursor

case class SimpleConfigCursor(value: ConfigValue, pathElems: List[String]) extends ConfigCursor with Product with Serializable

A simple ConfigCursor providing no extra operations.

Linear Supertypes
Serializable, Serializable, Product, Equals, ConfigCursor, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SimpleConfigCursor
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. ConfigCursor
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SimpleConfigCursor(value: ConfigValue, pathElems: List[String])

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.

    Definition Classes
    ConfigCursor
  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.

    Definition Classes
    ConfigCursor
  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.

    Definition Classes
    ConfigCursor
  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.

    Definition Classes
    ConfigCursor
  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.

    Definition Classes
    ConfigCursor
  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.

    Definition Classes
    ConfigCursor
  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 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.

    Definition Classes
    ConfigCursor
  14. 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.

    Definition Classes
    ConfigCursor
  15. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. 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.

    Definition Classes
    ConfigCursor
  19. 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.

    Definition Classes
    ConfigCursor
  20. def location: Option[ConfigValueLocation]

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

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

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

    The path in the config to which this cursor points.

    The path in the config to which this cursor points.

    Definition Classes
    ConfigCursor
  25. val pathElems: List[String]
    Definition Classes
    SimpleConfigCursor → ConfigCursor
  26. 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.

    Definition Classes
    ConfigCursor
  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. val value: ConfigValue
    Definition Classes
    SimpleConfigCursor → ConfigCursor
  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
    @native() @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ConfigCursor

Inherited from AnyRef

Inherited from Any

Ungrouped