Oggetti companion

Alcuni membri appartengono alla classe nel suo insieme anziché a una singola istanza. Kotlin li inserisce in un companion object all'interno della classe e li richiami tramite il nome della classe:

class Temperature(val celsius: Double) {
    companion object {
        fun fromFahrenheit(f: Double) = Temperature((f - 32) * 5 / 9)
    }
}

All'interno di main:

val boiling = Temperature.fromFahrenheit(212.0)
println(boiling.celsius)

Output:

100.0

fromFahrenheit è una funzione factory: una funzione che crea istanze. A differenza di un costruttore, ha un nome descrittivo e può restituire null invece di un oggetto. Con un private constructor, la factory è l’unico modo per accedere, quindi può prima controllare e ripulire l’input:

class Username private constructor(val text: String) {
    companion object {
        fun of(raw: String): Username? {
            val clean = raw.trim().lowercase()
            return if (clean.length in 3..12) Username(clean) else null
        }
    }
}

All’interno di main:

println(Username.of("  Ada_L ")?.text)
println(Username.of("x")?.text)
// Username("x")   // errore: il costruttore è privato

Output:

ada_l
null

L'oggetto companion appartiene alla classe, quindi può chiamare il costruttore privato, e il codice della classe usa i membri del companion senza prefisso. Qui ogni biglietto riceve il numero successivo da un unico contatore condiviso da tutti i biglietti:

class Ticket(val holder: String) {
    val number = nextNumber++

    companion object {
        private var nextNumber = 1
        val issued: Int
            get() = nextNumber - 1
    }
}

All'interno di main:

val a = Ticket("Ada")
val b = Ticket("Bo")
println("${a.holder} #${a.number}, ${b.holder} #${b.number}")
println("issued: ${Ticket.issued}")

Output:

Ada #1, Bo #2
issued: 2

Kotlin non ha la parola chiave static. I membri del companion svolgono quel ruolo: una sola copia per l'intera classe, accessibile come ClassName.member. Come qualsiasi oggetto, il companion viene creato una sola volta, quando la classe viene usata per la prima volta. Inserisci al suo interno ciò che non dipende da una singola istanza, come factory e contatori condivisi; tutto ciò che legge i dati di un'istanza resta un membro normale.

class User private constructor(val name: String) {
    fun greet() = "hi $name"             // richiede un'istanza: user.greet()

    companion object {
        fun guest() = User("guest")      // appartiene alla classe: User.guest()
    }
}