scala.tools.nsc.plugins

Plugin

abstract class Plugin extends AnyRef

Information about a plugin loaded from a jar file.

The concrete subclass must have a one-argument constructor that accepts an instance of global.

(val global: Global)
Version

1.0, 2007-5-21

Linear Supertypes
AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Plugin
  2. AnyRef
  3. Any
Implicitly
  1. by StringAdd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Plugin()

Abstract Value Members

  1. abstract val components: List[PluginComponent]

    The components that this phase defines

  2. abstract val description: String

    A one-line description of the plugin

  3. abstract val global: Global

    The compiler that this plugin uses.

    The compiler that this plugin uses. This is normally equated to a constructor parameter in the concrete subclass.

  4. abstract val name: String

    The name of this plugin

Concrete Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Plugin to StringAdd[Plugin] performed by method StringAdd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): (Plugin, B)

    Implicit information
    This member is added by an implicit conversion from Plugin to ArrowAssoc[Plugin] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  10. def ensuring(cond: (Plugin) ⇒ Boolean, msg: ⇒ Any): Plugin

    Implicit information
    This member is added by an implicit conversion from Plugin to Ensuring[Plugin] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: (Plugin) ⇒ Boolean): Plugin

    Implicit information
    This member is added by an implicit conversion from Plugin to Ensuring[Plugin] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: Boolean, msg: ⇒ Any): Plugin

    Implicit information
    This member is added by an implicit conversion from Plugin to Ensuring[Plugin] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. def ensuring(cond: Boolean): Plugin

    Implicit information
    This member is added by an implicit conversion from Plugin to Ensuring[Plugin] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  15. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  17. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Plugin to StringFormat[Plugin] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  18. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  20. def init(options: List[String], error: (String) ⇒ Unit): Boolean

    Handle any plugin-specific options.

    Handle any plugin-specific options. The user writes -P:plugname:opt1,opt2, but the plugin sees List(opt1, opt2). The plugin can opt out of further processing by returning false. For example, if the plugin has an "enable" flag, now would be a good time to sit on the bench.

    options

    plugin arguments

    error

    error function

    returns

    true to continue, or false to opt out

  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  22. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  23. final def notify(): Unit

    Definition Classes
    AnyRef

  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  25. def options: List[String]

  26. val optionsHelp: Option[String]

    A description of this plugin's options, suitable as a response to the -help command-line option.

    A description of this plugin's options, suitable as a response to the -help command-line option. Conventionally, the options should be listed with the -P:plugname: part included.

  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  28. def toString(): String

    Definition Classes
    AnyRef → Any

  29. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  32. def →[B](y: B): (Plugin, B)

    Implicit information
    This member is added by an implicit conversion from Plugin to ArrowAssoc[Plugin] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def processOptions(options: List[String], error: (String) ⇒ Unit): Unit

    Annotations
    @deprecated
    Deprecated

    (Since version 2.11) use Plugin#init instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringAdd from Plugin to StringAdd[Plugin]

Inherited by implicit conversion StringFormat from Plugin to StringFormat[Plugin]

Inherited by implicit conversion Ensuring from Plugin to Ensuring[Plugin]

Inherited by implicit conversion ArrowAssoc from Plugin to ArrowAssoc[Plugin]

Ungrouped