abstract class Setting extends AbsSetting with SettingValue with Mutable

A base class for settings of all types. Subclasses each define a value field of the appropriate type.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Setting
  2. Mutable
  3. SettingValue
  4. AbsSetting
  5. AbsSettingValue
  6. Ordered
  7. Comparable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Setting(name: String, helpDescription: String)

Type Members

  1. abstract type T
    Definition Classes
    AbsSettingValue

Abstract Value Members

  1. abstract def tryToSet(args: List[String]): Option[ResultOfTryToSet]

    After correct Setting has been selected, tryToSet is called with the remainder of the command line.

    After correct Setting has been selected, tryToSet is called with the remainder of the command line. It consumes any applicable arguments and returns the unconsumed ones.

    Attributes
    protected[nsc]
    Definition Classes
    AbsSetting
  2. abstract def unparse: List[String]
    Definition Classes
    AbsSetting
  3. abstract val v: T
    Attributes
    protected
    Definition Classes
    SettingValue

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def <(that: Setting): Boolean
    Definition Classes
    Ordered
  4. def <=(that: Setting): Boolean
    Definition Classes
    Ordered
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def >(that: Setting): Boolean
    Definition Classes
    Ordered
  7. def >=(that: Setting): Boolean
    Definition Classes
    Ordered
  8. def abbreviations: List[String]
    Definition Classes
    SettingAbsSetting
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def choices: List[String]
    Definition Classes
    AbsSetting
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  12. def compare(that: Setting): Int
    Definition Classes
    AbsSetting → Ordered
  13. def compareTo(that: Setting): Int
    Definition Classes
    Ordered → Comparable
  14. def dependencies: List[(Setting, String)]
    Definition Classes
    SettingAbsSetting
  15. def dependsOn(s: Setting, value: String): Setting.this.type
  16. def deprecationMessage: Option[String]
    Definition Classes
    SettingAbsSetting
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(that: Any): Boolean

    Equality tries to sidestep all the drama and define it simply and in one place: two AbsSetting objects are equal if their names and values compare equal.

    Equality tries to sidestep all the drama and define it simply and in one place: two AbsSetting objects are equal if their names and values compare equal.

    Definition Classes
    AbsSetting → AnyRef → Any
  19. def errorAndValue[T](msg: String, x: T): T

    Issue error and return

    Issue error and return

    Definition Classes
    AbsSetting
  20. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. def hashCode(): Int
    Definition Classes
    AbsSetting → AnyRef → Any
  23. def help: String

    The help message to be printed if isHelping.

    The help message to be printed if isHelping.

    Definition Classes
    AbsSetting
  24. val helpDescription: String
    Definition Classes
    SettingAbsSetting
  25. def helpSyntax: String
    Definition Classes
    SettingAbsSetting
  26. def internalOnly(): Setting.this.type
    Definition Classes
    AbsSetting
  27. def isAdvanced: Boolean

    These categorizations are so the help output shows -X and -P among the standard options and -Y among the advanced options.

    These categorizations are so the help output shows -X and -P among the standard options and -Y among the advanced options.

    Definition Classes
    AbsSetting
  28. def isDefault: Boolean
    Definition Classes
    SettingValue → AbsSettingValue
  29. def isDeprecated: Boolean
    Definition Classes
    AbsSetting
  30. def isForDebug: Boolean
    Definition Classes
    AbsSetting
  31. def isHelping: Boolean

    If this method returns true, print the help message and exit.

    If this method returns true, print the help message and exit.

    Definition Classes
    AbsSetting
  32. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  33. def isInternalOnly: Boolean
    Definition Classes
    AbsSetting
  34. def isPrivate: Boolean
    Definition Classes
    AbsSetting
  35. def isSetByUser: Boolean
    Definition Classes
    SettingValue
  36. def isStandard: Boolean
    Definition Classes
    AbsSetting
  37. val name: String
    Definition Classes
    SettingAbsSetting
  38. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  39. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  40. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  41. def postSetHook(): Unit
    Definition Classes
    Setting → SettingValue
  42. def respondsTo(label: String): Boolean
    Definition Classes
    AbsSetting
  43. val setByUser: Boolean
    Attributes
    protected
    Definition Classes
    SettingValue
  44. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  45. def toString(): String
    Definition Classes
    AbsSetting → AnyRef → Any
  46. def tryToSetColon(args: List[String]): Option[ResultOfTryToSet]

    Commands which can take lists of arguments in form -Xfoo:bar,baz override this method and accept them as a list.

    Commands which can take lists of arguments in form -Xfoo:bar,baz override this method and accept them as a list. It returns List[String] for consistency with tryToSet, and should return its incoming arguments unmodified on failure, and Nil on success.

    Attributes
    protected[nsc]
    Definition Classes
    AbsSetting
  47. def tryToSetFromPropertyValue(s: String): Unit

    Attempt to set from a properties file style property value.

    Attempt to set from a properties file style property value. Currently used by Eclipse SDT only. !!! Needs test.

    Definition Classes
    AbsSetting
  48. def value: T
    Definition Classes
    SettingValue → AbsSettingValue
  49. def valueSetByUser: Option[T]
    Definition Classes
    SettingValue
  50. def value_=(arg: T): Unit
    Definition Classes
    SettingValue
  51. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  52. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  53. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  54. def withAbbreviation(s: String): Setting.this.type

    In mutable Settings, these return the same object with a var set.

    In mutable Settings, these return the same object with a var set. In immutable, of course they will return a new object, which means we can't use "this.type", at least not in a non-casty manner, which is unfortunate because we lose type information without it.

    ...but now they're this.type because of #3462. The immutable side doesn't exist yet anyway.

    Definition Classes
    SettingAbsSetting
  55. def withDeprecationMessage(msg: String): Setting.this.type
    Definition Classes
    SettingAbsSetting
  56. def withHelpSyntax(s: String): Setting.this.type
    Definition Classes
    SettingAbsSetting
  57. def withPostSetHook(f: (Setting.this.type) ⇒ Unit): Setting.this.type

Inherited from Mutable

Inherited from math.Ordered[Setting]

Inherited from Comparable[Setting]

Inherited from AnyRef

Inherited from Any

Ungrouped