BetterHud/api/standard-api/kr.toxicity.hud.api.yaml/YamlObject

YamlObject

interface YamlObject : Iterable<Map.Entry<String, YamlElement>> , YamlElement

Yaml map.

Functions

asArray

@NotNull

open fun asArray(): @NotNull YamlArray

Gets this element as an array

asBoolean

open fun asBoolean(): Boolean

Gets this element as a boolean

asDouble

open fun asDouble(): Double

Gets this element as a double

asFloat

open fun asFloat(): Float

Gets this element as a float

asInt

open fun asInt(): Int

Gets this element as an int

asLong

open fun asLong(): Long

Gets this element as along

asObject

@NotNull

open fun asObject(): @NotNull YamlObject

Gets this element as an object

asString

@NotNull

open fun asString(): @NotNull String

Gets this element as a string

compareTo

abstract fun compareTo(p: T): Int

open fun compareTo(@NotNull o: @NotNull YamlConfiguration): Int

forEach

open fun forEach(action: Consumer<in T>)

get

@NotNull

abstract fun get(): @NotNull Map<String, Any>

Gets data as a map.

@Nullable

abstract fun get(@NotNull path: @NotNull String): @Nullable YamlElement

Gets YAML element by some key.

getAsBoolean

open fun getAsBoolean(@NotNull path: @NotNull String, defaultValue: Boolean): Boolean

Gets some value by some key as a boolean

getAsDouble

open fun getAsDouble(@NotNull path: @NotNull String, defaultValue: Double): Double

Gets some value by some key as a double

getAsFloat

open fun getAsFloat(@NotNull path: @NotNull String, defaultValue: Float): Float

Gets some value by some key as a float

getAsInt

open fun getAsInt(@NotNull path: @NotNull String, defaultValue: Int): Int

Gets some value by some key as an int

getAsLong

open fun getAsLong(@NotNull path: @NotNull String, defaultValue: Long): Long

Gets some value by some key as along

getAsString

@NotNull

open fun getAsString(@NotNull path: @NotNull String, @NotNull defaultValue: @NotNull String): @NotNull String

Gets some value by some key as a string

iterator

abstract fun iterator(): Iterator<T>

merge

abstract fun merge(@NotNull object: @NotNull YamlObject)

Merges data with another object.

path

@NotNull

abstract fun path(): @NotNull String

Gets this configuration's path

save

abstract fun save(@NotNull file: @NotNull File)

Saves YAML as a flat file.

spliterator

open fun spliterator(): Spliterator<T>