simbot-api/love.forte.simbot/CharSequenceID

CharSequenceID

@SerialName(value = "ID.CharSequence")

@Serializable(with = CharSequenceID.Serializer::class)

data class CharSequenceID(val value: CharSequence) : ID(source)

以字符序列作为字面值的 ID.

// Kotlin
val id = "forte".ID

// Java
StringID id = Identifies.ID("forte");

可变字符序列

注意，尽可能避免将 StringBuilder 等可变序列作为参数提供, 除非你明确的知道你在做什么。 CharSequenceID 的 value 目前将会直接使用其引用而非瞬时值作为属性。

转化

所有的ID都拥有转化为字符序列ID的能力。

构建

获取 CharSequenceID:

val id: CharSequenceID = "Hello".ID

转化 CharSequenceID

val otherId: IntID = 123.ID
val newId: CharSequenceID = otherId.toCharSequenceID()

Constructors

CharSequenceID

constructor(value: CharSequence)

Types

Companion

object Companion

Serializer

object Serializer : KSerializer<CharSequenceID>

CharSequenceID 的字面值序列化器。

Properties

length

val length: Int

当前字符序列长度。

literal

val ID.literal: String

ID的字面值。等同于 ID.toString.

value

val value: CharSequence

用于代表当前ID值的字符序列。

Functions

clone

protected open override fun clone(): CharSequenceID

compareTo

open operator override fun compareTo(other: ID): Int

ID之间应当是可以排序的。

doEquals

protected open override fun doEquals(other: ID): Boolean

直接通过 ID.equals 的最后逻辑进行toString判断。

equals

operator override fun equals(other: Any?): Boolean

toCharSequenceID

fun ID.toCharSequenceID(): CharSequenceID

所有的ID都拥有转化为字符序列ID的能力。

toString

open override fun toString(): String

ID 的 toString 结果必须是当前ID所对应的字面值。

tryToLong

fun ID.tryToLong(): Long

尝试将当前ID转化为一个 Long。

tryToLongID

fun ID.tryToLongID(): LongID

尝试将当前ID转为一个 LongID.

tryToNumericalID

@JvmOverloads

@ConfusedIDType

fun ID.tryToNumericalID(intAsLong: Boolean = true): NumericalID<*>

尝试将当前ID转为一个 NumericalID。

CharSequenceID

可变字符序列

转化

构建

See also

Constructors

Types

Properties

Functions