The API of FlagSet instances.
The API of FlagSet instances.
The main source of information about flag sets is the scala.reflect.api.FlagSets page.
An abstract type representing sets of flags (like private, final, etc.) that apply to definition trees and symbols
All possible values that can constitute flag sets.
All possible values that can constitute flag sets. The main source of information about flag sets is the scala.reflect.api.FlagSets page.
A module that contains all possible values that can constitute flag sets.
The empty set of flags
The API of FlagSet instances.
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 theflagsfield of scala.reflect.api.Trees#Modifiers. Trees that accept modifiers are:For example, to create a class named
Cone would write something like:ClassDef(Modifiers(NoFlags), newTypeName("C"), Nil, ...)Here, the flag set is empty.
To make
Cprivate, 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
isXXXtest methods (e.g.isFinalcan be used to test finality). These test methods might require an upcast withasTerm,asTypeorasClassas 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