CODEWITHSUNDEEP
scalaapplycase-classprivate-constructor
Erik
Erik

Reputation: 3048

Scala case class private constructor but public apply method

If I have the following case class with a private constructor and I can not access the apply-method in the companion object.

case class Meter private (m: Int)

val m = Meter(10) // constructor Meter in class Meter cannot be accessed...

Is there a way to use a case class with a private constructor but keep the generated apply-method in the companion public?

I am aware that there is no difference (in my example) between the two options:

val m1 = new Meter(10)
val m2 = Meter(10)

but I want to forbid the first option.

-- edit --

Surprisingly the following works (but is not really what i want):

val x = Meter
val m3 = x(10) // m3  : Meter = Meter(10)

Upvotes: 42

Views: 30973

Answers (4)

Julian Pieles
Julian Pieles

Reputation: 4026

The solutions above are rather complicated. It is just:

case class Meter private (m: Int)
object Meter { 
 def apply(m: Int): Meter = new Meter(m)
}

Test

new Meter(10) // fails to compile
Meter(10) // compiles just fine

Upvotes: 1

akauppi
akauppi

Reputation: 18076

It seems the requested behavior (private constructor but public .apply) may be the way Scala 2.12 implements these.

I came to this from the opposing angle - would like a private case class constructor also block the .apply method. Reasons here: https://github.com/akauppi/case-class-gym

Interesting, how use cases differ.

Upvotes: 5

Yuriy
Yuriy

Reputation: 2769

It is possible with some implicit tricks:

// first case 
case class Meter[T] private (m: T)(implicit ev: T =:= Int)
object Meter { 
  def apply(m: Int) = new Meter(m + 5) 
}

created some another constructor (and apply method signature) but guaranty that parameter can be only Int.

And after you have case class with case class features (with pattern matching, hashcode & equals) exclude default constructor:

scala> val m = Meter(10)
m: Metter[Int] = Meter(15)

scala> val m = new Meter(10)
<console>:9: error: constructor Meter in class Meter cannot be accessed in object $iw
       val m = new Meter(10)

OR with type tagging (naive implementation):

trait Private
case class Meter private (m: Integer with Private)
object Meter {
  def apply(m: Int) = new Meter((m + 5).asInstanceOf[Integer with Private])
}

It works as expected:

val x = new Meter(10)
<console>:11: error: constructor Meter in class Meter cannot be accessed in object $iw
              new Meter(10)
              ^

val x = Meter(10)
x: Meter = Meter(15)

Some possible issues with primitive types and type tags described here

Upvotes: 2

user425367
user425367

Reputation:

Here's the technique to have a private constructor and a public apply method.

trait Meter {
  def m: Int
}

object Meter {   
  def apply(m: Int): Meter = { MeterImpl(m) }
  private case class MeterImpl(m: Int) extends Meter { println(m) }
}

object Application extends App {
  val m1 = new Meter(10) // Forbidden
  val m2 = Meter(10)
}

Background information private-and-protected-constructor-in-scala

Upvotes: 53

Related Questions