Documentation pattern - secondary constructors
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 42/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- scala
- Ambito
- documentation
Direzione di ricerca
Non sono indicati né un file di documentazione né un test. Inizia individuando il punto di ingresso della documentazione di macwire per i costruttori, quindi incorpora i pattern dei costruttori secondari, di Defaults e delle factory mostrati nell'issue. Il lavoro è completo quando il pattern è documentato nella guida appropriata e gli esempi sono comprensibili nella documentazione circostante.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
If you're wondering how to deal with multiple constructors with macwire here is a pattern.
So you have this X class that provides default implementations for some of its parameters:
class X(a: A, b: B, c: C, d: D) {
// secondary constructor, providing defaults for C and D
def this(a: A, b: B) = {
this(a, b, new DefaultC, new DefaultD)
}
}
This can also be written using default parameters (as long as DefaultC or DefaultD does not depend on a or b), but down the line that's the same:
// default parameters, which will be turned into secondary constructors
class X(a: A, b: B, c: C = new DefaultC, d: D = new DefaultD)
(Un)fortunately macwire only looks at the primary constructor (BTW something could be said in the documentation about why this is better).
To workaround that "limitation" here is an alternative:
class X(a: A, b: B, c: C, d: D) {
// no secondary constructor
}
object X {
import Defaults._
def apply(a: A, b: B) : X = wire[X]
trait Defaults {
lazy val c = wire[DefaultC]
lazy val d = wire[DefaultD]
}
object Defaults extends Defaults
}
We can now re-use the defaults provided by X if we're interested in them:
class MyModule extends X.Defaults {
lazy val a: A = wire[AImpl]
lazy val b: B = wire[BImpl]
lazy val x: X = wire[X]
}
Things can get a little more tricky if DefaultC needs some parameters that we're unable to provide. In that case we'll resort to factories:
object X {
import Defaults._
def apply(a: A, b: B, cDep: CDep) : X = {
val c = buildC(cDep)
wire[X]
}
trait Defaults {
def buildC(cDep: CDep) = wire[DefaultC]
lazy val d = wire[DefaultD]
}
object Defaults extends Defaults
}
And in your module
class MyModule extends X.Defaults {
lazy val a: A = wire[AImpl]
lazy val b: B = wire[BImpl]
lazy val cDep: CDep = wire[CDepImpl]
lazy val c: C = buildC(cDep)
lazy val x: X = wire[X]
}
- Lingua principale
- Scala
- Stelle
- 1.3k
- Fork
- 77
- Merge medio
- 9m
- PR unite (30g)
- 4
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di softwaremill/macwire
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
softwaremill/macwire#412 · 3 commenti ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 25/100
softwaremill/macwire#391 · 1 commento ·
-
macrosakka Pekko alternative Aperta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 20/100
softwaremill/macwire#301 · 2 commenti ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 20/100
softwaremill/macwire#281 · 5 commenti ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
softwaremill/macwire#278 · 3 commenti ·
Tutte le issue di softwaremill/macwire
Issue simili
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 70/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
ergoplatform/ergodocs#614 ·
-
area:ci enhancement requires-triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
apache/datafusion-comet#6078 ·
-
enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
-
bug delta-datalayout flink
Difficoltà 2/5 1-3 ore Idoneità per principianti 86/100