case class ConfigListCursor(listValue: ConfigList, pathElems: List[String], offset: Int = 0) extends ConfigCursor with Product with Serializable
A ConfigCursor
pointing to a config list.
- Alphabetic
- By Inheritance
- ConfigListCursor
- Serializable
- Serializable
- Product
- Equals
- ConfigCursor
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
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
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
-
def
asByte: Result[Byte]
Casts this cursor to a byte.
Casts this cursor to a byte.
- returns
a
Right
with the byte value pointed to by this cursor if the cast can be done,Left
with a list of failures otherwise.
- Definition Classes
- ConfigCursor
-
def
asConfigValue: Result[ConfigList]
Casts this cursor to a
ConfigValue
.Casts this cursor to a
ConfigValue
.- returns
a
Right
with the config value pointed to by this cursor if the value is defined,Left
with a list of failures otherwise.
- Definition Classes
- ConfigListCursor → ConfigCursor
-
def
asDouble: Result[Double]
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
-
def
asFloat: Result[Float]
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
-
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
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
-
def
asList: Result[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
-
def
asListCursor: Result[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
- ConfigListCursor → ConfigCursor
-
def
asLong: Result[Long]
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
-
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
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
-
def
asObjectCursor: Result[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
-
def
asShort: Result[Short]
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
-
def
asString: Result[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
-
def
atIndex(idx: Int): Result[ConfigCursor]
Returns a cursor to the config at a given index.
Returns a cursor to the config at a given index.
- idx
the index of the config for which a cursor should be returned
- returns
a
Right
with a cursor to the config atidx
if such a config exists, aLeft
with a list of failures otherwise.
-
def
atIndexOrUndefined(idx: Int): ConfigCursor
Returns a cursor to the config at a given index.
Returns a cursor to the config at a given index. An out of range index will return a cursor to an undefined value.
- idx
the index of the config for which a cursor should be returned
- returns
a cursor to the config at
idx
if such a config exists, a cursor to an undefined value otherwise.
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
failed[A](reason: FailureReason): Result[A]
Returns a failed
ConfigReader
result resulting from scoping aFailureReason
into the context of this cursor.Returns a failed
ConfigReader
result resulting from scoping aFailureReason
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 scopingreason
into the context of this cursor.
- Definition Classes
- ConfigCursor
-
def
failureFor(reason: FailureReason): ConfigReaderFailure
Returns a
ConfigReaderFailure
resulting from scoping aFailureReason
into the context of this cursor.Returns a
ConfigReaderFailure
resulting from scoping aFailureReason
into the context of this cursor.This operation is useful for constructing
ConfigReaderFailures
when there are multipleFailureReason
s.- reason
the reason of the failure
- returns
a
ConfigReaderFailure
built by scopingreason
into the context of this cursor.
- Definition Classes
- ConfigCursor
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
fluent: FluentConfigCursor
- Definition Classes
- ConfigCursor
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
isEmpty: Boolean
Returns whether the config list pointed to by this cursor is empty.
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isNull: Boolean
Returns whether this cursor points to a
null
config value.Returns whether this cursor points to a
null
config value. An explicitnull
value is different than a missing value -isUndefined
can be used to check for the latter.- returns
true
if this cursor points to anull
value,false
otherwise.
- Definition Classes
- ConfigCursor
-
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
-
def
list: List[ConfigCursor]
Returns a list of cursors to the elements of the config list pointed to by this cursor.
Returns a list of cursors to the elements of the config list pointed to by this cursor.
- returns
a list of cursors to the elements of the config list pointed to by this cursor.
- val listValue: ConfigList
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val offset: Int
-
def
origin: Option[ConfigOrigin]
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
-
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
-
val
pathElems: List[String]
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
- ConfigListCursor → ConfigCursor
-
def
scopeFailure[A](result: Either[FailureReason, A]): Result[A]
Returns a failed
ConfigReader
result resulting from scoping aEither[FailureReason, A]
into the context of this cursor.Returns a failed
ConfigReader
result 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
ConfigCursor
instance providing the nexessary context (for example, whenConfigReader.fromString
is used. In those scenarios, the call should be wrapped in this method in order to turnFailureReason
instances intoConfigReaderFailures
.- A
the returning type of the
ConfigReader
- result
the result of a config reading operation
- returns
a
ConfigReader
result built by scopingreason
into the context of this cursor.
- Definition Classes
- ConfigCursor
-
def
size: Int
Returns the size of the config list pointed to by this cursor.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
tailOption: Option[ConfigListCursor]
Returns a cursor to the tail of the config list pointed to by this cursor if non-empty.
Returns a cursor to the tail of the config list pointed to by this cursor if non-empty.
- returns
a
Some
with the tail of the config list if the list is not empty,None
otherwise.
-
def
valueOpt: Option[ConfigList]
The optional
ConfigValue
which this cursor points to.The optional
ConfigValue
which this cursor points to.- Definition Classes
- ConfigListCursor → ConfigCursor
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
Deprecated Value Members
-
def
asCollectionCursor: Result[Either[ConfigListCursor, ConfigObjectCursor]]
Casts this cursor as either a
ConfigListCursor
or aConfigObjectCursor
.Casts this cursor as either a
ConfigListCursor
or aConfigObjectCursor
.- 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/orasObjectCursor
instead
-
final
def
atPath(pathSegments: PathSegment*): Result[ConfigCursor]
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 atpathSegments
if such a config exists, aLeft
with a list of failures otherwise.
- Definition Classes
- ConfigCursor
- Annotations
- @deprecated
- Deprecated
(Since version 0.10.2) Use
.fluent.at(pathSegments).cursor
instead