Class

pureconfig

SimpleConfigCursor

Related Doc: package pureconfig

Permalink

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

A simple ConfigCursor providing no extra operations.

Linear Supertypes
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])

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def asBoolean: Result[Boolean]

    Permalink

    Casts this cursor to a boolean.

    Casts this cursor to a boolean.

    returns

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

    Definition Classes
    ConfigCursor
  5. def asDouble: Result[Double]

    Permalink

    Casts this cursor to a double.

    Casts this cursor to a double.

    returns

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

    Definition Classes
    ConfigCursor
  6. def asFloat: Result[Float]

    Permalink

    Casts this cursor to a float.

    Casts this cursor to a float.

    returns

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

    Definition Classes
    ConfigCursor
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def asInt: Result[Int]

    Permalink

    Casts this cursor to an int.

    Casts this cursor to an int.

    returns

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

    Definition Classes
    ConfigCursor
  9. def asList: Result[List[ConfigCursor]]

    Permalink

    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
  10. def asListCursor: Result[ConfigListCursor]

    Permalink

    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
  11. def asLong: Result[Long]

    Permalink

    Casts this cursor to a long.

    Casts this cursor to a long.

    returns

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

    Definition Classes
    ConfigCursor
  12. def asMap: Result[Map[String, ConfigCursor]]

    Permalink

    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
  13. def asObjectCursor: Result[ConfigObjectCursor]

    Permalink

    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
  14. def asShort: Result[Short]

    Permalink

    Casts this cursor to a short.

    Casts this cursor to a short.

    returns

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

    Definition Classes
    ConfigCursor
  15. def asString: Result[String]

    Permalink

    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
  16. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. def failed[A](reason: FailureReason): Result[A]

    Permalink

    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
  19. def failureFor(reason: FailureReason): ConfigReaderFailure

    Permalink

    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
  20. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. def fluent: FluentConfigCursor

    Permalink
    Definition Classes
    ConfigCursor
  22. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  23. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  24. def isNull: Boolean

    Permalink

    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
  25. def isUndefined: Boolean

    Permalink

    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
  26. def location: Option[ConfigValueLocation]

    Permalink

    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
  27. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  28. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  30. def path: String

    Permalink

    The path in the config to which this cursor points.

    The path in the config to which this cursor points.

    Definition Classes
    ConfigCursor
  31. val pathElems: List[String]

    Permalink

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

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

    Definition Classes
    SimpleConfigCursorConfigCursor
  32. def scopeFailure[A](result: Either[FailureReason, A]): Result[A]

    Permalink

    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
  33. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  34. val value: ConfigValue

    Permalink

    The ConfigValue to which this cursor points to.

    The ConfigValue to which this cursor points to.

    Definition Classes
    SimpleConfigCursorConfigCursor
  35. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def asCollectionCursor: Result[Either[ConfigListCursor, ConfigObjectCursor]]

    Permalink

    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
    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.1) Use asListCursor and/or asObjectCursor instead

  2. final def atPath(pathSegments: PathSegment*): Result[ConfigCursor]

    Permalink

    Returns a cursor to the config at the path composed of given path segments.

    Returns a cursor to the config at the path composed of given path segments.

    pathSegments

    the path of the config for which a cursor should be returned

    returns

    a Right with a cursor to the config at pathSegments if such a config exists, a Left with a list of failures otherwise.

    Definition Classes
    ConfigCursor
    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.2) Use .fluent.at(pathSegments).cursor instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ConfigCursor

Inherited from AnyRef

Inherited from Any

Ungrouped