Shampoo
0.2.1
API
Generated with
Shampoo/shampoo.yaml/YamlSequence

YamlSequence

shampoo.yaml.YamlSequence
sealed trait YamlSequence extends YamlCollection

Defines YAML sequence.

Attributes

See also
Graph
Supertypes
trait YamlNode
class Object
trait Matchable
class Any
Known subtypes

Members list

Value members

Abstract methods

def apply(index: Int): YamlNode

Gets node.

Gets node.

Value parameters

index

sequence index

Attributes

Throws
java.lang.IndexOutOfBoundsException

if index is out of bounds

def toSeq: Seq[YamlNode]

Gets node sequence.

Gets node sequence.

Attributes

Concrete methods

def getBigDecimal(index: Int): BigDecimal

Gets node as BigDecimal.

Gets node as BigDecimal.

Value parameters

index

sequence index

Attributes

Throws
java.lang.IndexOutOfBoundsException

if index is out of bounds

java.lang.NullPointerException

if node is null

def getBigInt(index: Int): BigInt

Gets node as BigInt.

Gets node as BigInt.

Value parameters

index

sequence index

Attributes

Throws
java.lang.IndexOutOfBoundsException

if index is out of bounds

java.lang.NullPointerException

if node is null

def getBoolean(index: Int): Boolean

Gets node as Boolean.

Gets node as Boolean.

Value parameters

index

sequence index

Attributes

Throws
java.lang.IndexOutOfBoundsException

if index is out of bounds

java.lang.NullPointerException

if node is null

def getDouble(index: Int): Double

Gets node as Double.

Gets node as Double.

Value parameters

index

sequence index

Attributes

Throws
java.lang.IndexOutOfBoundsException

if index is out of bounds

java.lang.NullPointerException

if node is null

def getFloat(index: Int): Float

Gets node as Float.

Gets node as Float.

Value parameters

index

sequence index

Attributes

Throws
java.lang.IndexOutOfBoundsException

if index is out of bounds

java.lang.NullPointerException

if node is null

def getInt(index: Int): Int

Gets node as Int.

Gets node as Int.

Value parameters

index

sequence index

Attributes

Throws
java.lang.IndexOutOfBoundsException

if index is out of bounds

java.lang.NullPointerException

if node is null

def getLong(index: Int): Long

Gets node as Long.

Gets node as Long.

Value parameters

index

sequence index

Attributes

Throws
java.lang.IndexOutOfBoundsException

if index is out of bounds

java.lang.NullPointerException

if node is null

def getMapping(index: Int): YamlMapping

Gets node as YamlMapping.

Gets node as YamlMapping.

Value parameters

index

sequence index

Attributes

Throws
java.lang.IndexOutOfBoundsException

if index is out of bounds

java.lang.NullPointerException

if node is null

def getSequence(index: Int): YamlSequence

Gets node as YamlSequence.

Gets node as YamlSequence.

Value parameters

index

sequence index

Attributes

Throws
java.lang.IndexOutOfBoundsException

if index is out of bounds

java.lang.NullPointerException

if node is null

def getString(index: Int): String

Gets node as String.

Gets node as String.

Value parameters

index

sequence index

Attributes

Throws
java.lang.IndexOutOfBoundsException

if index is out of bounds

java.lang.NullPointerException

if node is null

def isNull(index: Int): Boolean

Tests for null.

Tests for null.

Value parameters

index

sequence index

Attributes

Throws
java.lang.IndexOutOfBoundsException

if index is out of bounds

def read[T](index: Int)(using constructor: YamlConstructor[T]): T

Reads constructed data.

Reads constructed data.

Value parameters

index

sequence index

Attributes

Throws
java.lang.IndexOutOfBoundsException

if index is out of bounds

java.lang.NullPointerException

if node is null

def readOption[T](index: Int)(using constructor: YamlConstructor[T]): Option[T]

Optionally reads constructed data.

Optionally reads constructed data.

Value parameters

constructor

data constructor

index

sequence index

Attributes

Returns

Some constructed data, or None if node is null

Throws
java.lang.IndexOutOfBoundsException

if index is out of bounds

def readOrElse[T](index: Int, default: => T)(using constructor: YamlConstructor[T]): T

Reads constructed data or returns default value.

Reads constructed data or returns default value.

Value parameters

constructor

data constructor

index

sequence index

Attributes

Returns

constructed data, or default value if node is null

Throws
java.lang.IndexOutOfBoundsException

if index is out of bounds

Inherited methods

def as[T](using constructor: YamlConstructor[T]): T

Constructs data.

Constructs data.

Value parameters

constructor

data constructor

Attributes

Inherited from:
YamlNode
def isEmpty: Boolean

Tests for empty.

Tests for empty.

Attributes

Inherited from:
YamlCollection
def nonEmpty: Boolean

Tests for non-empty.

Tests for non-empty.

Attributes

Inherited from:
YamlCollection
def size: Int

Gets collection size.

Gets collection size.

Attributes

Inherited from:
YamlCollection
Generated with