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.

Linear Supertypes
Mutable, MutableSettings.SettingValue, MutableSettings.AbsSetting, MutableSettings.AbsSettingValue, math.Ordered[Setting], Comparable[Setting], AnyRef, Any
Known Subclasses
BooleanSetting, ChoiceSetting, IntSetting, MultiStringSetting, OutputSetting, PathSetting, PhasesSetting, PrefixSetting, ScalaVersionSetting, StringSetting
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 StringFormat
4. by Ensuring
5. by ArrowAssoc

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: Any): Boolean

   Definition Classes
     AnyRef → Any

2. #### final def ##(): Int

   Definition Classes
     AnyRef → Any

3. #### def +(other: String): String

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

4. #### def ->[B](y: B): (Setting, B)

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

5. #### def <(that: Setting): Boolean

   Definition Classes
     Ordered

6. #### def <=(that: Setting): Boolean

   Definition Classes
     Ordered

7. #### final def ==(arg0: Any): Boolean

   Definition Classes
     AnyRef → Any

8. #### def >(that: Setting): Boolean

   Definition Classes
     Ordered

9. #### def >=(that: Setting): Boolean

   Definition Classes
     Ordered

10. #### def abbreviations: List[String]

    Definition Classes
      Setting → AbsSetting

11. #### final def asInstanceOf[T0]: T0

    Definition Classes
      Any

12. #### def choices: List[String]

    Definition Classes
      AbsSetting

13. #### def clone(): AnyRef

    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

14. #### def compare(that: Setting): Int

    Definition Classes
      AbsSetting → Ordered

15. #### def compareTo(that: Setting): Int

    Definition Classes
      Ordered → Comparable

16. #### def dependencies: List[(Setting, String)]

    Definition Classes
      Setting → AbsSetting

17. #### def dependsOn(s: Setting, value: String): Setting.this.type

18. #### def deprecationMessage: Option[String]

    Definition Classes
      Setting → AbsSetting

19. #### 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 Ensuring in scala.Predef.
    Definition Classes
      Ensuring

20. #### def ensuring(cond: (Setting) ⇒ Boolean): Setting

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

21. #### 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 Ensuring in scala.Predef.
    Definition Classes
      Ensuring

22. #### def ensuring(cond: Boolean): Setting

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

23. #### final def eq(arg0: AnyRef): Boolean

    Definition Classes
      AnyRef

24. #### 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

25. #### def errorAndValue[T](msg: String, x: T): T

    Issue error and return

    Issue error and return

    Definition Classes
      AbsSetting

26. #### def finalize(): Unit

    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )

27. #### def formatted(fmtstr: String): String

    Implicit information
      This member is added by an implicit conversion from Setting to StringFormat[Setting] performed by method StringFormat in scala.Predef.
    Definition Classes
      StringFormat
    Annotations
      @inline()

28. #### final def getClass(): Class[_]

    Definition Classes
      AnyRef → Any

29. #### def hashCode(): Int

    Definition Classes
      AbsSetting → AnyRef → Any

30. #### val helpDescription: String

    Definition Classes
      Setting → AbsSetting

31. #### def helpSyntax: String

    Definition Classes
      Setting → AbsSetting

32. #### def internalOnly(): Setting.this.type

    Definition Classes
      AbsSetting

33. #### 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

34. #### def isDefault: Boolean

    Definition Classes
      SettingValue → AbsSettingValue

35. #### def isDeprecated: Boolean

    Definition Classes
      AbsSetting

36. #### def isForDebug: Boolean

    Definition Classes
      AbsSetting

37. #### final def isInstanceOf[T0]: Boolean

    Definition Classes
      Any

38. #### def isInternalOnly: Boolean

    Definition Classes
      AbsSetting

39. #### def isPrivate: Boolean

    Definition Classes
      AbsSetting

40. #### def isSetByUser: Boolean

    Definition Classes
      SettingValue

41. #### def isStandard: Boolean

    Definition Classes
      AbsSetting

42. #### val name: String

    Definition Classes
      Setting → AbsSetting

43. #### final def ne(arg0: AnyRef): Boolean

    Definition Classes
      AnyRef

44. #### final def notify(): Unit

    Definition Classes
      AnyRef

45. #### final def notifyAll(): Unit

    Definition Classes
      AnyRef

46. #### def postSetHook(): Unit

    Definition Classes
      Setting → SettingValue

47. #### def respondsTo(label: String): Boolean

    Definition Classes
      AbsSetting

48. #### var setByUser: Boolean

    Attributes
      protected
    Definition Classes
      SettingValue

49. #### final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
      AnyRef

50. #### def toString(): String

    Definition Classes
      AbsSetting → AnyRef → Any

51. #### 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

52. #### 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

53. #### def value: T

    Definition Classes
      SettingValue → AbsSettingValue

54. #### def value_=(arg: T): Unit

    Definition Classes
      SettingValue

55. #### final def wait(): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

56. #### final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

57. #### final def wait(arg0: Long): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

58. #### 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
      Setting → AbsSetting

59. #### def withDeprecationMessage(msg: String): Setting.this.type

    Definition Classes
      Setting → AbsSetting

60. #### def withHelpSyntax(s: String): Setting.this.type

    Definition Classes
      Setting → AbsSetting

61. #### def withPostSetHook(f: (Setting.this.type) ⇒ Unit): Setting.this.type

62. #### def →[B](y: B): (Setting, B)

    Implicit information
      This member is added by an implicit conversion from Setting to ArrowAssoc[Setting] performed by method ArrowAssoc 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

### 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 any2stringadd[Setting]

### Inherited by implicit conversion StringFormat from Setting to StringFormat[Setting]

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

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

### Ungrouped