play.scalasupport

# ScalaPlugin

#### class ScalaPlugin extends PlayPlugin

The ScalaPlugin in mainly responsible for compiling .scala files

As scala compilation is pretty slow, we try to optimize things a lot: The plugin will keep an in memory instance of the scala compiler. After each change to a scala file, it will check for dependent files and recompile only needed sources.

When a compilation error occurs we will try to recompile all sources to avoid problems.

We discard the in-memory compiler in some cases: - After a change in the .scala files set (adding or removing a scala file to the application) - When a modification to a scala file destroy some types (however if the type was anonymous we try to keep the compiler anyway)

linear super types: PlayPlugin, Comparable[PlayPlugin], AnyRef, Any
Ordering

1. Alphabetic
2. By inheritance

Inherited

1. Hide All
2. Show all

1. ScalaPlugin
2. PlayPlugin
3. Comparable
4. AnyRef
5. Any

Visibility

1. Public
2. All

Impl.

1. Concrete
2. Abstract

### Instance constructors

1. #### new ScalaPlugin ()

### Type Members

1. #### class PathChangeException extends Exception

### Value Members

1. #### def != (arg0: AnyRef) : Boolean

   attributes: final
   definition classes: AnyRef

2. #### def != (arg0: Any) : Boolean

   `o != arg0` is the same as `!(o == (arg0))`.

   `o != arg0` is the same as `!(o == (arg0))`.

   arg0

     the object to compare against this object for dis-equality.

   returns

     `false` if the receiver object is equivalent to the argument; `true` otherwise.

   attributes: final
   definition classes: Any

3. #### def ## () : Int

   attributes: final
   definition classes: AnyRef → Any

4. #### def $asInstanceOf [T0] () : T0

   attributes: final
   definition classes: AnyRef

5. #### def $isInstanceOf [T0] () : Boolean

   attributes: final
   definition classes: AnyRef

6. #### def == (arg0: AnyRef) : Boolean

   `o == arg0` is the same as `if (o eq null) arg0 eq null else o.equals(arg0)`.

   `o == arg0` is the same as `if (o eq null) arg0 eq null else o.equals(arg0)`.

   arg0

     the object to compare against this object for equality.

   returns

     `true` if the receiver object is equivalent to the argument; `false` otherwise.

   attributes: final
   definition classes: AnyRef

7. #### def == (arg0: Any) : Boolean

   `o == arg0` is the same as `o.equals(arg0)`.

   `o == arg0` is the same as `o.equals(arg0)`.

   arg0

     the object to compare against this object for equality.

   returns

     `true` if the receiver object is equivalent to the argument; `false` otherwise.

   attributes: final
   definition classes: Any

8. #### def addTemplateExtensions () : List[String]

   definition classes: ScalaPlugin → PlayPlugin

9. #### def afterActionInvocation () : Unit

   definition classes: PlayPlugin

10. #### def afterApplicationStart () : Unit

    definition classes: PlayPlugin

11. #### def afterFixtureLoad () : Unit

    definition classes: PlayPlugin

12. #### def afterInvocation () : Unit

    definition classes: PlayPlugin

13. #### def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type `T0`.

    This method is used to cast the receiver object to be of type `T0`.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression`1.asInstanceOf[String]` will throw a `ClassCastException` at runtime, while the expression`List(1).asInstanceOf[List[String]]` will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

      the receiver object.

    attributes: final
    definition classes: Any

14. #### def beforeActionInvocation (arg0: Method) : Unit

    definition classes: PlayPlugin

15. #### def beforeDetectingChanges () : Unit

    definition classes: PlayPlugin

16. #### def beforeInvocation () : Unit

    definition classes: PlayPlugin

17. #### def bind (name: String, clazz: Class[_], t: Type, annotations: Array[Annotation], params: Map[String, Array[String]]) : AnyRef

    Custom binders for Scala - Option[T]

    Custom binders for Scala - Option[T]

    definition classes: ScalaPlugin → PlayPlugin

18. #### def bind (arg0: String, arg1: Any, arg2: Map[String, Array[String]]) : AnyRef

    definition classes: PlayPlugin

19. #### def clone () : AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the `clone` method is platform dependent.

    returns

      a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef

20. #### def compareTo (arg0: PlayPlugin) : Int

    definition classes: PlayPlugin → Comparable

21. #### def compile (sources: List[VirtualFile]) : ArrayList[ApplicationClass]

    compiles all given source files

    compiles all given source files

    sources

      files to be compiled

22. #### def compileAll (classes: List[ApplicationClass]) : Unit

    compile all classes

    compile all classes

    classes

      classes to be compiled

    definition classes: ScalaPlugin → PlayPlugin

23. #### def detectChange () : Unit

    try to detect source changes

    try to detect source changes

    definition classes: ScalaPlugin → PlayPlugin

24. #### def enhance (arg0: ApplicationClass) : Unit

    definition classes: PlayPlugin

25. #### def eq (arg0: AnyRef) : Boolean

    This method is used to test whether the argument (`arg0`) is a reference to the receiver object (`this`).

    This method is used to test whether the argument (`arg0`) is a reference to the receiver object (`this`).

    The `eq` method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of `AnyRef`: * It is reflexive: for any non-null instance `x` of type `AnyRef`, `x.eq(x)` returns `true`. * It is symmetric: for any non-null instances `x` and `y` of type `AnyRef`, `x.eq(y)` returns `true` if and only if `y.eq(x)` returns `true`. * It is transitive: for any non-null instances `x`, `y`, and `z` of type `AnyRef` if `x.eq(y)` returns `true` and `y.eq(z)` returns `true`, then `x.eq(z)` returns `true`.

    Additionally, the `eq` method has three other properties. * It is consistent: for any non-null instances `x` and `y` of type `AnyRef`, multiple invocations of `x.eq(y)` consistently returns `true` or consistently returns `false`. * For any non-null instance `x` of type `AnyRef`, `x.eq(null)` and `null.eq(x)` returns `false`. * `null.eq(null)` returns `true`.

    When overriding the `equals` or `hashCode` methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (`o1 eq o2`), they should be equal to each other (`o1 == o2`) and they should hash to the same value (`o1.hashCode == o2.hashCode`).

    arg0

      the object to compare against this object for reference equality.

    returns

      `true` if the argument is a reference to the receiver object; `false` otherwise.

    attributes: final
    definition classes: AnyRef

26. #### def equals (arg0: Any) : Boolean

    This method is used to compare the receiver object (`this`) with the argument object (`arg0`) for equivalence.

    This method is used to compare the receiver object (`this`) with the argument object (`arg0`) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance `x` of type `Any`, `x.equals(x)` should return `true`. * It is symmetric: for any instances `x` and `y` of type `Any`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. * It is transitive: for any instances `x`, `y`, and `z` of type `AnyRef` if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override `hashCode` to ensure that objects that are "equal" (`o1.equals(o2)` returns `true`) hash to the same scala.Int (`o1.hashCode.equals(o2.hashCode)`).

    arg0

      the object to compare against this object for equality.

    returns

      `true` if the receiver object is equivalent to the argument; `false` otherwise.

    definition classes: AnyRef → Any

27. #### def eval (code: String) : Any

28. #### def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the `finalize` method are invoked, as well as the interaction between `finalize`and non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef

29. #### def getClass () : java.lang.Class[_]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

      a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef

30. #### def getJsonStatus () : JsonObject

    definition classes: PlayPlugin

31. #### def getMessage (arg0: String, arg1: Any, arg2: <repeated...>[AnyRef]) : String

    definition classes: PlayPlugin

32. #### def getStatus () : String

    definition classes: PlayPlugin

33. #### def hashCode () : Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (`o1.hashCode.equals(o2.hashCode)`) yet not be equal (`o1.equals(o2)` returns `false`). A degenerate implementation could always return `0`. However, it is required that if two objects are equal (`o1.equals(o2)` returns `true`) that they have identical hash codes (`o1.hashCode.equals(o2.hashCode)`). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the `equals` method.

    returns

      the hash code value for the object.

    definition classes: AnyRef → Any

34. #### def invocationFinally () : Unit

    definition classes: PlayPlugin

35. #### def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is `T0`.

    This method is used to test whether the dynamic type of the receiver object is `T0`.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression`1.isInstanceOf[String]` will return `false`, while the expression `List(1).isInstanceOf[List[String]]` will return `true`. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

      `true` if the receiver object is an instance of erasure of type `T0`; `false` otherwise.

    attributes: final
    definition classes: Any

36. #### var lastHash : Int

37. #### def loadTemplate (arg0: VirtualFile) : Template

    definition classes: PlayPlugin

38. #### def modelFactory (arg0: java.lang.Class[_ <: play.db.Model]) : Factory

    definition classes: PlayPlugin

39. #### def ne (arg0: AnyRef) : Boolean

    `o.ne(arg0)` is the same as `!(o.eq(arg0))`.

    `o.ne(arg0)` is the same as `!(o.eq(arg0))`.

    arg0

      the object to compare against this object for reference dis-equality.

    returns

      `false` if the argument is not a reference to the receiver object; `true` otherwise.

    attributes: final
    definition classes: AnyRef

40. #### def notify () : Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef

41. #### def notifyAll () : Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef

42. #### def onActionInvocationResult (arg0: Result) : Unit

    definition classes: PlayPlugin

43. #### def onApplicationReady () : Unit

    definition classes: PlayPlugin

44. #### def onApplicationStart () : Unit

    definition classes: PlayPlugin

45. #### def onApplicationStop () : Unit

    definition classes: PlayPlugin

46. #### def onClassesChange (modified: List[ApplicationClass]) : ArrayList[ApplicationClass]

    compile a class if a change was made.

    compile a class if a change was made.

    modified

      classes that were modified

    definition classes: ScalaPlugin → PlayPlugin

47. #### def onConfigurationRead () : Unit

    definition classes: ScalaPlugin → PlayPlugin

48. #### def onEvent (arg0: String, arg1: Any) : Unit

    definition classes: PlayPlugin

49. #### def onInvocationException (arg0: Throwable) : Unit

    definition classes: PlayPlugin

50. #### def onInvocationSuccess () : Unit

    definition classes: PlayPlugin

51. #### def onLoad () : Unit

    definition classes: ScalaPlugin → PlayPlugin

52. #### def onRequestRouting (arg0: Route) : Unit

    definition classes: PlayPlugin

53. #### def onRoutesLoaded () : Unit

    definition classes: PlayPlugin

54. #### def onTemplateCompilation (arg0: Template) : Unit

    definition classes: PlayPlugin
    deprecated:

    1. see corresponding Javadoc for more information.

55. #### def overrideTemplateSource (template: BaseTemplate, source: String) : String

    definition classes: ScalaPlugin → PlayPlugin

56. #### def rawInvocation (arg0: Request, arg1: Response) : Boolean

    definition classes: PlayPlugin

57. #### def reset () : Unit

58. #### def routeRequest (arg0: Request) : Unit

    definition classes: PlayPlugin

59. #### def runTest (testClass: Class[BaseTest]) : TestResults

    inject ScalaTestRunner into play's test framework

    inject ScalaTestRunner into play's test framework

    testClass

      a class under testing

    definition classes: ScalaPlugin → PlayPlugin

60. #### def scanSources : (ListBuffer[VirtualFile], Int)

    Scanning both java and scala sources for compilation

    Scanning both java and scala sources for compilation

61. #### def serveStatic (arg0: VirtualFile, arg1: Request, arg2: Response) : Boolean

    definition classes: PlayPlugin

62. #### def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef

63. #### def toString () : String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

      a string representation of the object.

    definition classes: AnyRef → Any

64. #### def unBind (o: Any, name: String) : Map[String, AnyRef]

    definition classes: ScalaPlugin → PlayPlugin

65. #### def wait () : Unit

    attributes: final
    definition classes: AnyRef

66. #### def wait (arg0: Long, arg1: Int) : Unit

    attributes: final
    definition classes: AnyRef

67. #### def wait (arg0: Long) : Unit

    attributes: final
    definition classes: AnyRef

68. #### def willBeValidated (o: Any) : AnyRef

    definition classes: ScalaPlugin → PlayPlugin

### Inherited from PlayPlugin

### Inherited from Comparable[PlayPlugin]

### Inherited from AnyRef

### Inherited from Any