sealed trait ConfigCursor extends AnyRef
A wrapper for a ConfigValue providing safe navigation through the config and holding positional data for better
error handling.
- Alphabetic
- By Inheritance
- ConfigCursor
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def asBoolean: Result[Boolean]
Casts this cursor to a boolean.
Casts this cursor to a boolean.
- returns
a
Rightwith the boolean value pointed to by this cursor if the cast can be done,Leftwith a list of failures otherwise.
- def asByte: Result[Byte]
Casts this cursor to a byte.
Casts this cursor to a byte.
- returns
a
Rightwith the byte value pointed to by this cursor if the cast can be done,Leftwith a list of failures otherwise.
- def asConfigValue: Result[ConfigValue]
Casts this cursor to a
ConfigValue.Casts this cursor to a
ConfigValue.- returns
a
Rightwith the config value pointed to by this cursor if the value is defined,Leftwith a list of failures otherwise.
- def asDouble: Result[Double]
Casts this cursor to a double.
Casts this cursor to a double.
- returns
a
Rightwith the double value pointed to by this cursor if the cast can be done,Leftwith a list of failures otherwise.
- def asFloat: Result[Float]
Casts this cursor to a float.
Casts this cursor to a float.
- returns
a
Rightwith the float value pointed to by this cursor if the cast can be done,Leftwith a list of failures otherwise.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def asInt: Result[Int]
Casts this cursor to an int.
Casts this cursor to an int.
- returns
a
Rightwith the int value pointed to by this cursor if the cast can be done,Leftwith a list of failures otherwise.
- def asList: Result[List[ConfigCursor]]
Casts this cursor to a list of cursors.
Casts this cursor to a list of cursors.
- returns
a
Rightwith the list pointed to by this cursor if the cast can be done,Leftwith a list of failures otherwise.
- def asListCursor: Result[ConfigListCursor]
Casts this cursor to a
ConfigListCursor.Casts this cursor to a
ConfigListCursor.- returns
a
Rightwith this cursor as a list cursor if the cast can be done,Leftwith a list of failures otherwise.
- def asLong: Result[Long]
Casts this cursor to a long.
Casts this cursor to a long.
- returns
a
Rightwith the long value pointed to by this cursor if the cast can be done,Leftwith a list of failures otherwise.
- def asMap: Result[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
Rightwith the map pointed to by this cursor if the cast can be done,Leftwith a list of failures otherwise.
- def asObjectCursor: Result[ConfigObjectCursor]
Casts this cursor to a
ConfigObjectCursor.Casts this cursor to a
ConfigObjectCursor.- returns
a
Rightwith this cursor as an object cursor if it points to an object,Leftwith a list of failures otherwise.
- def asShort: Result[Short]
Casts this cursor to a short.
Casts this cursor to a short.
- returns
a
Rightwith the short value pointed to by this cursor if the cast can be done,Leftwith a list of failures otherwise.
- def asString: Result[String]
Casts this cursor to a string.
Casts this cursor to a string.
- returns
a
Rightwith the string value pointed to by this cursor if the cast can be done,Leftwith a list of failures otherwise.
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def failed[A](reason: FailureReason): Result[A]
Returns a failed
ConfigReaderresult resulting from scoping aFailureReasoninto the context of this cursor.Returns a failed
ConfigReaderresult resulting from scoping aFailureReasoninto 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
ConfigReaderresult built by scopingreasoninto the context of this cursor.
- def failureFor(reason: FailureReason): ConfigReaderFailure
Returns a
ConfigReaderFailureresulting from scoping aFailureReasoninto the context of this cursor.Returns a
ConfigReaderFailureresulting from scoping aFailureReasoninto the context of this cursor.This operation is useful for constructing
ConfigReaderFailureswhen there are multipleFailureReasons.- reason
the reason of the failure
- returns
a
ConfigReaderFailurebuilt by scopingreasoninto the context of this cursor.
- def fluent: FluentConfigCursor
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isNull: Boolean
Returns whether this cursor points to a
nullconfig value.Returns whether this cursor points to a
nullconfig value. An explicitnullvalue is different than a missing value -isUndefinedcan be used to check for the latter.- returns
trueif this cursor points to anullvalue,falseotherwise.
- 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
nullConfigValueis provided, among other reasons.- returns
trueif this cursor points to an undefined value,falseotherwise.
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def origin: Option[ConfigOrigin]
The file system location of the config to which this cursor points.
- def path: String
The path in the config to which this cursor points.
- def scopeFailure[A](result: Either[FailureReason, A]): Result[A]
Returns a failed
ConfigReaderresult resulting from scoping aEither[FailureReason, A]into the context of this cursor.Returns a failed
ConfigReaderresult resulting from scoping aEither[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
ConfigCursorinstance providing the nexessary context (for example, whenConfigReader.fromStringis used. In those scenarios, the call should be wrapped in this method in order to turnFailureReasoninstances intoConfigReaderFailures.- A
the returning type of the
ConfigReader- result
the result of a config reading operation
- returns
a
ConfigReaderresult built by scopingreasoninto the context of this cursor.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])