scala.tools.nsc.settings.MutableSettings

Setting

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.

Definition Classes
MutableSettingsAbsScalaSettingsAbsSettings → MutableSettings → AbsSettings
Linear Supertypes
Mutable, MutableSettings.SettingValue, MutableSettings.AbsSetting, MutableSettings.AbsSettingValue, math.Ordered[Setting], Comparable[Setting], AnyRef, Any
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
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
Implicitly
  1. by orderingToOrdered
  2. by any2stringadd
  3. by any2stringfmt
  4. by any2ArrowAssoc
  5. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
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[scala.tools.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: 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 Setting to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (Setting, B)

    Implicit information
    This member is added by an implicit conversion from Setting to ArrowAssoc[Setting] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. def <(that: Setting): Boolean

    Definition Classes
    Ordered
  7. def <=(that: Setting): Boolean

    Definition Classes
    Ordered
  8. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  9. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  10. def >(that: Setting): Boolean

    Definition Classes
    Ordered
  11. def >=(that: Setting): Boolean

    Definition Classes
    Ordered
  12. def abbreviations: List[String]

    Definition Classes
    SettingAbsSetting
  13. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  14. def choices: List[String]

    Definition Classes
    AbsSetting
  15. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. def compare(that: Setting): Int

    Definition Classes
    AbsSetting → Ordered
  17. def compareTo(that: Setting): Int

    Definition Classes
    Ordered → Comparable
  18. def dependencies: List[(Setting, String)]

    Definition Classes
    SettingAbsSetting
  19. def dependsOn(s: Setting, value: String): Setting.this.type

  20. def deprecationMessage: Option[String]

    Definition Classes
    SettingAbsSetting
  21. def ensuring(cond: (Setting) ⇒ Boolean, msg: ⇒ Any): Setting

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

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

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

    Implicit information
    This member is added by an implicit conversion from Setting to Ensuring[Setting] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  26. 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
  27. def errorAndValue[T](msg: String, x: T): T

    Issue error and return

    Issue error and return

    Definition Classes
    AbsSetting
  28. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  29. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Setting to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  30. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  31. def hashCode(): Int

    Definition Classes
    AbsSetting → AnyRef → Any
  32. val helpDescription: String

    Definition Classes
    SettingAbsSetting
  33. def helpSyntax: String

    Definition Classes
    SettingAbsSetting
  34. def internalOnly(): Setting.this.type

    Definition Classes
    AbsSetting
  35. 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
  36. def isDefault: Boolean

    Definition Classes
    SettingValue → AbsSettingValue
  37. def isDeprecated: Boolean

    Definition Classes
    AbsSetting
  38. def isForDebug: Boolean

    Definition Classes
    AbsSetting
  39. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  40. def isInternalOnly: Boolean

    Definition Classes
    AbsSetting
  41. def isPrivate: Boolean

    Definition Classes
    AbsSetting
  42. def isSetByUser: Boolean

    Definition Classes
    SettingValue
  43. def isStandard: Boolean

    Definition Classes
    AbsSetting
  44. val name: String

    Definition Classes
    SettingAbsSetting
  45. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  48. def postSetHook(): Unit

    Definition Classes
    Setting → SettingValue
  49. def respondsTo(label: String): Boolean

    Definition Classes
    AbsSetting
  50. var setByUser: Boolean

    Attributes
    protected
    Definition Classes
    SettingValue
  51. def shouldStopProcessing: Boolean

    Definition Classes
    AbsSetting
  52. def stopProcessing(): Setting.this.type

    Definition Classes
    AbsSetting
  53. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  54. def toString(): String

    Definition Classes
    AbsSetting → AnyRef → Any
  55. 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[scala.tools.nsc]
    Definition Classes
    AbsSetting
  56. 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.

    Definition Classes
    AbsSetting
  57. def value: T

    Definition Classes
    SettingValue → AbsSettingValue
  58. def value_=(arg: T): Unit

    Definition Classes
    SettingValue
  59. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  62. 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
  63. def withDeprecationMessage(msg: String): Setting.this.type

    Definition Classes
    SettingAbsSetting
  64. def withHelpSyntax(s: String): Setting.this.type

    Definition Classes
    SettingAbsSetting
  65. def withPostSetHook(f: (Setting.this.type) ⇒ Unit): Setting.this.type

  66. def [B](y: B): (Setting, B)

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

Shadowed Implicit Value Members

  1. def <(that: Setting): Boolean

    Implicit information
    This member is added by an implicit conversion from Setting to math.Ordered[Setting] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[Setting] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (setting: math.Ordered[Setting]).<(that)
    Definition Classes
    Ordered
  2. def <=(that: Setting): Boolean

    Implicit information
    This member is added by an implicit conversion from Setting to math.Ordered[Setting] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[Setting] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (setting: math.Ordered[Setting]).<=(that)
    Definition Classes
    Ordered
  3. def >(that: Setting): Boolean

    Implicit information
    This member is added by an implicit conversion from Setting to math.Ordered[Setting] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[Setting] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (setting: math.Ordered[Setting]).>(that)
    Definition Classes
    Ordered
  4. def >=(that: Setting): Boolean

    Implicit information
    This member is added by an implicit conversion from Setting to math.Ordered[Setting] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[Setting] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (setting: math.Ordered[Setting]).>=(that)
    Definition Classes
    Ordered
  5. def compare(that: Setting): Int

    Implicit information
    This member is added by an implicit conversion from Setting to math.Ordered[Setting] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[Setting] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (setting: math.Ordered[Setting]).compare(that)
    Definition Classes
    Ordered
  6. def compareTo(that: Setting): Int

    Implicit information
    This member is added by an implicit conversion from Setting to math.Ordered[Setting] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[Setting] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (setting: math.Ordered[Setting]).compareTo(that)
    Definition Classes
    Ordered → Comparable
  7. val self: Any

    Implicit information
    This member is added by an implicit conversion from Setting to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (setting: StringAdd).self
    Definition Classes
    StringAdd
  8. val self: Any

    Implicit information
    This member is added by an implicit conversion from Setting to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (setting: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: Setting

    Implicit information
    This member is added by an implicit conversion from Setting to ArrowAssoc[Setting] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (setting: ArrowAssoc[Setting]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Setting

    Implicit information
    This member is added by an implicit conversion from Setting to Ensuring[Setting] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (setting: Ensuring[Setting]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Mutable

Inherited from MutableSettings.SettingValue

Inherited from MutableSettings.AbsSetting

Inherited from MutableSettings.AbsSettingValue

Inherited from math.Ordered[Setting]

Inherited from Comparable[Setting]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion orderingToOrdered from Setting to math.Ordered[Setting]

Inherited by implicit conversion any2stringadd from Setting to StringAdd

Inherited by implicit conversion any2stringfmt from Setting to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Setting to ArrowAssoc[Setting]

Inherited by implicit conversion any2Ensuring from Setting to Ensuring[Setting]

Ungrouped