Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to qualify methods as static in Scala?

I have a class

class MyClass {
  def apply(myRDD: RDD[String]) {
      val rdd2 = myRDD.map(myString => {
          // do String manipulation
      }
  }

}

object MyClass {

}

Since I have a block of code performing one task (the area that says "do String manipulation"), I thought I should break it out into it's own method. Since the method is not changing the state of the class, I thought I should make it a static method.

How do I do that?

I thought that you can just pop a method inside the companion object and it would be available as a static class, like this:

object MyClass {
  def doStringManipulation(myString: String) = {
    // do String manipulation
  }
}

but when I try val rdd2 = myRDD.map(myString => { doStringManipulation(myString)}), scala doesn't recognize the method and it forces me to do MyClass.doStringManipulation(myString) in order to call it.

What am I doing wrong?

like image 233
B. Smith Avatar asked Jan 09 '18 23:01

B. Smith


People also ask

Does Scala have static methods?

As we know, Scala does NOT have “static” keyword at all. This is the design decision done by Scala Team. The main reason to take this decision is to make Scala as a Pure Object-Oriented Language. “static” keyword means that we can access that class members without creating an object or without using an object.

Can method be declared as static?

If a method is declared as static, it is a member of a class rather than belonging to the object of the class. It can be called without creating an object of the class. A static method also has the power to access static data members of the class.

How do you know if a method should be static?

Static methods are usually preferred when: All instance methods should share a specific piece of code (although you could still have an instance method for that). You want to call method without having to create an instance of that class. You must make sure that the utility class is never changed.

What are the conditions on static methods?

Features of static method:Every instance of a class has access to the method. Static methods have access to class variables (static variables) without using the class's object (instance). Only static data may be accessed by a static method. It is unable to access data that is not static (instance variables).


2 Answers

In Scala there are no static methods: all methods are defined over an object, be it an instance of a class or a singleton, as the one you defined in your question.

As you correctly pointed out, by having a class and an object named in the same way in the same compilation unit you make the object a companion of the class, which means that the two have access to each others' private fields and methods, but this does mean they are available without specifying which object you are accessing.

What you want to do is either using the long form as mentioned (MyClass.doStringManipulation(myString)) or, if you think it makes sense, you can just import the method in the class' scope, as follows:

import MyClass.doStringManipulation

class MyClass {
  def apply(myRDD: RDD[String]): Unit = {
    val rdd2 = myRDD.map(doStringManipulation)
  }
}

object MyClass {
  private def doStringManipulation(myString: String): String = {
    ???
  }
}

As a side note, for the MyClass.apply method, you used the a notation which is going to disappear in the future:

// this is a shorthand for a method that returns `Unit` but is going to disappear
def method(parameter: Type) {
  // does things
}

// this means the same, but it's going to stay
// the `=` is enough, even without the explicit return type
// unless, that is, you want to force the method to discard the last value and return `Unit`
def method(parameter: Type): Unit = {
  // does things
}
like image 145
stefanobaghino Avatar answered Oct 21 '22 06:10

stefanobaghino


You should follow scala's advice.

val rdd2 = myRDD.map(MyClass.doStringManipulation)

like image 26
Joaquín Bucca Avatar answered Oct 21 '22 08:10

Joaquín Bucca