scala.reflect.api

FlagSets

trait FlagSets extends AnyRef

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), newTypeName("C"), Nil, ...)

Here, the flag set is empty.

To make C private, one would write something like:

ClassDef(Modifiers(PRIVATE), newTypeName("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), newTypeName("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

Self Type
Universe
Source
FlagSets.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Grouped
  2. Alphabetic
  3. By inheritance
Inherited
  1. FlagSets
  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

Type Members

  1. trait FlagOps extends Any

    The API of FlagSet instances.

  2. abstract type FlagSet

    An abstract type representing sets of flags (like private, final, etc.

  3. trait FlagValues extends AnyRef

    All possible values that can constitute flag sets.

Abstract Value Members

  1. abstract val Flag: Universe.FlagValues

    A module that contains all possible values that can constitute flag sets.

  2. implicit abstract val FlagSetTag: ClassTag[Universe.FlagSet]

    A tag that preserves the identity of the FlagSet abstract type from erasure.

    A tag that preserves the identity of the FlagSet abstract type from erasure. Can be used for pattern matching, instance tests, serialization and likes.

  3. abstract val NoFlags: Universe.FlagSet

    The empty set of flags

  4. implicit abstract def addFlagOps(left: Universe.FlagSet): Universe.FlagOps

    The API of FlagSet instances.

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 FlagSets to StringAdd[FlagSets] performed by method StringAdd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (FlagSets, B)

    Implicit information
    This member is added by an implicit conversion from FlagSets to ArrowAssoc[FlagSets] 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: (FlagSets) ⇒ Boolean, msg: ⇒ Any): FlagSets

    Implicit information
    This member is added by an implicit conversion from FlagSets to Ensuring[FlagSets] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (FlagSets) ⇒ Boolean): FlagSets

    Implicit information
    This member is added by an implicit conversion from FlagSets to Ensuring[FlagSets] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): FlagSets

    Implicit information
    This member is added by an implicit conversion from FlagSets to Ensuring[FlagSets] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): FlagSets

    Implicit information
    This member is added by an implicit conversion from FlagSets to Ensuring[FlagSets] 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()
  17. def formatted(fmtstr: String): String

    Returns string formatted according to given format string.

    Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).

    Implicit information
    This member is added by an implicit conversion from FlagSets to StringFormat[FlagSets] 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. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  25. def toString(): String

    Definition Classes
    AnyRef → Any
  26. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  27. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  28. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  29. def [B](y: B): (FlagSets, B)

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

Inherited from AnyRef

Inherited from Any

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

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

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

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

Flags

Tags

Implicit values that provide ClassTags for the reflection classes. These are abstract in the interface but are later filled in to provide ClassTags for the either the runtime reflection or macros entities, depending on the use.

Ungrouped