Packages

  • package root
    Definition Classes
    root
  • package scala
    Definition Classes
    root
  • package reflect
    Definition Classes
    scala
  • package api

    EXPERIMENTAL

    EXPERIMENTAL

    The Scala Reflection API (located in scala-reflect.jar).

    In Scala 2.10.0, the Scala Reflection API and its implementation have an "experimental" status. This means that the API and the docs are not complete and can be changed in binary- and source-incompatible manner in 2.10.1. This also means that the implementation has some known issues.

    The following types are the backbone of the Scala Reflection API, and serve as a good starting point for information about Scala Reflection:

    For more information about Scala Reflection, see the Reflection Guide

    Definition Classes
    reflect
  • trait FlagSets extends AnyRef

    EXPERIMENTAL

    EXPERIMENTAL

    The trait that defines flag sets and operations on them.

    Flags are used to provide modifiers for abstract syntax trees that represent definitions via the flags field of scala.reflect.api.Trees#Modifiers. Trees that accept modifiers are:

    For example, to create a class named C one would write something like:

    ClassDef(Modifiers(NoFlags), TypeName("C"), Nil, ...)

    Here, the flag set is empty.

    To make C private, one would write something like:

    ClassDef(Modifiers(PRIVATE), TypeName("C"), Nil, ...)

    Flags can also be combined with the vertical bar operator (|). For example, a private final class is written something like:

    ClassDef(Modifiers(PRIVATE | FINAL), TypeName("C"), Nil, ...)

    The list of all available flags is defined in scala.reflect.api.FlagSets#FlagValues, available via scala.reflect.api.FlagSets#Flag. (Typically one writes a wildcard import for this, e.g. import scala.reflect.runtime.universe.Flag._).

    Definition trees are compiled down to symbols, so flags on modifiers of these trees are transformed into flags on the resulting symbols. Unlike trees, symbols don't expose flags, but rather provide isXXX test methods (e.g. isFinal can be used to test finality). These test methods might require an upcast with asTerm, asType or asClass as some flags only make sense for certain kinds of symbols.

    Of Note: This part of the Reflection API is being considered as a candidate for redesign. It is quite possible that in future releases of the reflection API, flag sets could be replaced with something else.

    For more details about FlagSets and other aspects of Scala reflection, see the Reflection Guide

    Definition Classes
    api
  • FlagOps
  • FlagSet
  • FlagValues

trait FlagValues extends AnyRef

All possible values that can constitute flag sets. The main source of information about flag sets is the scala.reflect.api.FlagSets page.

Source
FlagSets.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FlagValues
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract val ABSOVERRIDE: Universe.FlagSet

    Flag indicating that tree has abstract and override modifiers set

  2. abstract val ABSTRACT: Universe.FlagSet

    Flag indicating that tree represents an abstract class

  3. abstract val ARTIFACT: Universe.FlagSet

    Flag used to distinguish platform-specific implementation details.

    Flag used to distinguish platform-specific implementation details. Trees and symbols which are currently marked ARTIFACT by scalac: * $outer fields and accessors * super accessors * protected accessors * lazy local accessors * bridge methods * default argument getters * evaluation-order preserving locals for right-associative and out-of-order named arguments * catch-expression storing vals * anything else which feels a setFlag(ARTIFACT)

    See also

    SYNTHETIC

  4. abstract val BYNAMEPARAM: Universe.FlagSet

    Flag indicating that tree represents a by-name parameter

  5. abstract val CASE: Universe.FlagSet

    Flag indicating that tree has case modifier set

  6. abstract val CASEACCESSOR: Universe.FlagSet

    Flag indicating that tree represents a parameter of the primary constructor of some case class or a synthetic member underlying thereof.

    Flag indicating that tree represents a parameter of the primary constructor of some case class or a synthetic member underlying thereof. E.g. here's how 'case class C(val x: Int)' is represented:

    [[syntax trees at end of parser]]// Scala source: tmpnHkJ3y
case class C extends scala.Product with scala.Serializable {
  <caseaccessor> <paramaccessor> val x: Int = _;
  def <init>(x: Int) = {
    super.<init>();
    ()
  }
}
ClassDef(
  Modifiers(CASE), TypeName("C"), List(),
  Template(
    List(Select(Ident(scala), TypeName("Product")), Select(Ident(scala), TypeName("Serializable"))),
    noSelfType,
    List(
      ValDef(Modifiers(CASEACCESSOR | PARAMACCESSOR), TermName("x"), Ident(TypeName("Int")), EmptyTree),
      DefDef(
        Modifiers(), nme.CONSTRUCTOR, List(),
        List(List(ValDef(Modifiers(PARAM | PARAMACCESSOR), TermName("x"), Ident(TypeName("Int")), EmptyTree))), TypeTree(),
        Block(List(pendingSuperCall), Literal(Constant(())))))))))
  7. abstract val CONTRAVARIANT: Universe.FlagSet

    Flag indicating that tree represents a contravariant type parameter (marked with -).

  8. abstract val COVARIANT: Universe.FlagSet

    Flag indicating that tree represents a covariant type parameter (marked with +).

  9. abstract val DEFAULTINIT: Universe.FlagSet

    Flag indicating that tree represents a variable or a member initialized to the default value

  10. abstract val DEFAULTPARAM: Universe.FlagSet

    Flag indicating that tree represents a parameter that has a default value

  11. abstract val DEFERRED: Universe.FlagSet

    Flag indicating that tree represents an abstract type, method, or value

  12. abstract val FINAL: Universe.FlagSet

    Flag indicating that tree has final modifier set

  13. abstract val IMPLICIT: Universe.FlagSet

    Flag indicating that tree has implicit modifier set

  14. abstract val INTERFACE: Universe.FlagSet

    Flag indicating that a tree is an interface (i.e.

    Flag indicating that a tree is an interface (i.e. a trait which defines only abstract methods)

  15. abstract val LAZY: Universe.FlagSet

    Flag indicating that tree has lazy modifier set

  16. abstract val LOCAL: Universe.FlagSet

    Flag indicating that tree represents a member local to current class, i.e.

    Flag indicating that tree represents a member local to current class, i.e. private[this] or protected[this]. This requires having either PRIVATE or PROTECTED set as well.

  17. abstract val MACRO: Universe.FlagSet

    Flag indicating that tree represents a macro definition.

  18. abstract val MUTABLE: Universe.FlagSet

    Flag indicating that tree represents a mutable variable

  19. abstract val OVERRIDE: Universe.FlagSet

    Flag indicating that tree has override modifier set

  20. abstract val PARAM: Universe.FlagSet

    Flag indicating that tree represents a class or parameter.

    Flag indicating that tree represents a class or parameter. Both type and value parameters carry the flag.

  21. abstract val PARAMACCESSOR: Universe.FlagSet

    Flag indicating that tree represents a parameter of the primary constructor of some class or a synthetic member underlying thereof.

    Flag indicating that tree represents a parameter of the primary constructor of some class or a synthetic member underlying thereof. E.g. here's how 'class C(val x: Int)' is represented:

    [[syntax trees at end of parser]]// Scala source: tmposDU52
class C extends scala.AnyRef {
  <paramaccessor> val x: Int = _;
  def <init>(x: Int) = {
    super.<init>();
    ()
  }
}
ClassDef(
  Modifiers(), TypeName("C"), List(),
  Template(
    List(Select(Ident(scala), TypeName("AnyRef"))),
    noSelfType,
    List(
      ValDef(Modifiers(PARAMACCESSOR), TermName("x"), Ident(TypeName("Int")), EmptyTree),
      DefDef(
        Modifiers(), nme.CONSTRUCTOR, List(),
        List(List(ValDef(Modifiers(PARAM | PARAMACCESSOR), TermName("x"), Ident(TypeName("Int")), EmptyTree))), TypeTree(),
        Block(List(pendingSuperCall), Literal(Constant(())))))))))
  22. abstract val PRESUPER: Universe.FlagSet

    Flag indicating that tree represents an early definition

  23. abstract val PRIVATE: Universe.FlagSet

    Flag indicating that tree has private modifier set

  24. abstract val PROTECTED: Universe.FlagSet

    Flag indicating that tree has protected modifier set

  25. abstract val SEALED: Universe.FlagSet

    Flag indicating that tree has sealed modifier set

  26. abstract val STABLE: Universe.FlagSet

    Flag that indicates methods that are supposed to be stable (e.g.

    Flag that indicates methods that are supposed to be stable (e.g. synthetic getters of valdefs).

  27. abstract val SYNTHETIC: Universe.FlagSet

    Flag used to distinguish programmatically generated definitions from user-written ones.

    Flag used to distinguish programmatically generated definitions from user-written ones.

    See also

    ARTIFACT

  28. abstract val TRAIT: Universe.FlagSet

    Flag indicating that tree represents a trait

  29. abstract val ENUM: Universe.FlagSet

    Flag indicating that tree represents an enum.

    Flag indicating that tree represents an enum.

    It can only appear at

    • the enum's class
    • enum constants
    Annotations
    @deprecated
    Deprecated

    (Since version 2.11.8) use isJavaEnum on the corresponding symbol instead