Scala Compiler2.13.2 < Back


# Packages

-  package root

  The Scala compiler and reflection APIs.

  The Scala compiler and reflection APIs.

  Definition Classes
    root
-  package scala
  Definition Classes
    root
-  package tools
  Definition Classes
    scala
-  package nsc
  Definition Classes
    tools
-  package settings
  Definition Classes
    nsc
-  class MutableSettings extends reflect.internal.settings.MutableSettings with AbsSettings with ScalaSettings

  A mutable Settings object.

  A mutable Settings object.

  Definition Classes
    settings
- AbsSetting
- AbsSettingValue
- BooleanSetting
- CachePolicy
- ChoiceSetting
- EnableSettings
- IntSetting
- InternalSetting
- LintWarnings
- MacroExpand
- MultiChoiceEnumeration
- MultiChoiceSetting
- MultiStringSetting
- OutputDirs
- OutputSetting
- PathSetting
- PhasesSetting
- PrefixSetting
- ScalaVersionSetting
- Setting
- SettingValue
- StringSetting
- UnusedWarnings
- XxmlSettings
- languageFeatures
- mixinForwarderChoices
- optChoices
- optWarningsChoices

c

scala.tools.nsc.settings.MutableSettings

# ChoiceSetting

###

#### class ChoiceSetting extends Setting

A setting represented by a string in a given set of `choices`, (`default` unless set).

Source
  MutableSettings.scala

Linear Supertypes
Setting, MutableSettings.SettingValue, MutableSettings.AbsSetting, MutableSettings.AbsSettingValue, math.Ordered[Setting], Comparable[Setting], AnyRef, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. ChoiceSetting
2. Setting
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

Visibility

1. Public
2. Protected

### Type Members

1.  type T = String
   Definition Classes
     ChoiceSetting → AbsSettingValue

### 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
     This member is added by an implicit conversion from ChoiceSetting toany2stringadd[ChoiceSetting] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (ChoiceSetting, B)
   Implicit
     This member is added by an implicit conversion from ChoiceSetting toArrowAssoc[ChoiceSetting] 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.  val choices: List[String]
    Definition Classes
      ChoiceSetting → AbsSetting
13.  val choicesHelp: List[String]
14.  def clone(): AnyRef
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.CloneNotSupportedException]) @native()
15.  def compare(that: Setting): Int
    Definition Classes
      AbsSetting → Ordered
16.  def compareTo(that: Setting): Int
    Definition Classes
      Ordered → Comparable
17.  val default: String
18.  def dependencies: List[(Setting, String)]
    Definition Classes
      Setting → AbsSetting
19.  def dependsOn(s: Setting, value: String): ChoiceSetting.this.type
    Definition Classes
      Setting
20.  def deprecationMessage: Option[String]
    Definition Classes
      Setting → AbsSetting
21.  def ensuring(cond: (ChoiceSetting) => Boolean, msg: => Any): ChoiceSetting
    Implicit
      This member is added by an implicit conversion from ChoiceSetting toEnsuring[ChoiceSetting] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
22.  def ensuring(cond: (ChoiceSetting) => Boolean): ChoiceSetting
    Implicit
      This member is added by an implicit conversion from ChoiceSetting toEnsuring[ChoiceSetting] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
23.  def ensuring(cond: Boolean, msg: => Any): ChoiceSetting
    Implicit
      This member is added by an implicit conversion from ChoiceSetting toEnsuring[ChoiceSetting] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
24.  def ensuring(cond: Boolean): ChoiceSetting
    Implicit
      This member is added by an implicit conversion from ChoiceSetting toEnsuring[ChoiceSetting] performed by method Ensuring 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[A](msg: String, x: A): A

    Issue error and return the value.

    Issue error and return the value.

    Definition Classes
      AbsSetting
28.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
29.  def formatted(fmtstr: String): String
    Implicit
      This member is added by an implicit conversion from ChoiceSetting toStringFormat[ChoiceSetting] performed by method StringFormat in scala.Predef.
    Definition Classes
      StringFormat
    Annotations
      @inline()
30.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
31.  def hashCode(): Int
    Definition Classes
      AbsSetting → AnyRef → Any
32.  def help: String

    The help message to be printed if isHelping.

    The help message to be printed if isHelping.

    Definition Classes
      ChoiceSetting → AbsSetting
33.  val helpArg: String
34.  val helpDescription: String
    Definition Classes
      Setting → AbsSetting
35.  def helpSyntax: String
    Definition Classes
      Setting → AbsSetting
36.  def indexOfChoice: Int
37.  def internalOnly(): ChoiceSetting.this.type
    Definition Classes
      AbsSetting
38.  def isAdvanced: Boolean

    Standard options are shown on the `-help` output, advanced on `-X`, private on `-Y`, warning on `-W`, verbose on `-V`.

    Standard options are shown on the `-help` output, advanced on `-X`, private on `-Y`, warning on `-W`, verbose on `-V`.

    The single char options themselves, including `-P`, are explained on `-help`. Additionally, `-Werror` is on `-help` and `-Xlint` on `-W`.

    Definition Classes
      AbsSetting
39.  def isDefault: Boolean
    Definition Classes
      SettingValue → AbsSettingValue
40.  def isDeprecated: Boolean
    Definition Classes
      AbsSetting
41.  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
      ChoiceSetting → AbsSetting
42.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
43.  def isInternalOnly: Boolean
    Definition Classes
      AbsSetting
44.  def isPrivate: Boolean
    Definition Classes
      AbsSetting
45.  def isSetByUser: Boolean
    Definition Classes
      SettingValue
46.  def isStandard: Boolean
    Definition Classes
      AbsSetting
47.  def isVerbose: Boolean
    Definition Classes
      AbsSetting
48.  def isWarning: Boolean
    Definition Classes
      AbsSetting
49.  val name: String
    Definition Classes
      Setting → AbsSetting
50.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
51.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
52.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
53.  def postSetHook(): Unit
    Definition Classes
      Setting → SettingValue
54.  def respondsTo(label: String): Boolean
    Definition Classes
      AbsSetting
55.  val setByUser: Boolean
    Attributes
      protected
    Definition Classes
      SettingValue
56.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
57.  def toString(): String
    Definition Classes
      AbsSetting → AnyRef → Any
58.  def tryToSet(args: List[String]): None

    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.

    Definition Classes
      ChoiceSetting → AbsSetting
59.  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.

    Definition Classes
      ChoiceSetting → AbsSetting
60.  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
      ChoiceSetting → AbsSetting
61.  def unparse: List[String]
    Definition Classes
      ChoiceSetting → AbsSetting
62.  var v: T
    Attributes
      protected
    Definition Classes
      ChoiceSetting → SettingValue
63.  def value: T
    Definition Classes
      SettingValue → AbsSettingValue
64.  def valueSetByUser: Option[T]
    Definition Classes
      SettingValue
65.  def value_=(arg: T): Unit
    Definition Classes
      SettingValue
66.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
67.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
68.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()
69.  def withAbbreviation(s: String): ChoiceSetting.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 scala/bug#3462. The immutable side doesn't exist yet anyway.

    Definition Classes
      Setting → AbsSetting
70.  def withDefault(value: T): ChoiceSetting.this.type
    Definition Classes
      Setting
71.  def withDeprecationMessage(msg: String): ChoiceSetting.this.type
    Definition Classes
      Setting → AbsSetting
72.  def withHelpSyntax(s: String): ChoiceSetting.this.type
    Definition Classes
      Setting → AbsSetting
73.  def withPostSetHook(f: (ChoiceSetting.this.type) => Unit): ChoiceSetting.this.type
    Definition Classes
      Setting
74.  def withPreSetHook(hook: (String) => String): ChoiceSetting.this.type

### Shadowed Implicit Value Members

1.  def <(that: ChoiceSetting): Boolean
   Implicit
     This member is added by an implicit conversion from ChoiceSetting tomath.Ordered[ChoiceSetting] performed by method orderingToOrdered in scala.math.Ordered.This conversion will take place only if an implicit value of type math.Ordering[ChoiceSetting] 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:

         (choiceSetting: math.Ordered[ChoiceSetting]).<(that)

   Definition Classes
     Ordered
2.  def <=(that: ChoiceSetting): Boolean
   Implicit
     This member is added by an implicit conversion from ChoiceSetting tomath.Ordered[ChoiceSetting] performed by method orderingToOrdered in scala.math.Ordered.This conversion will take place only if an implicit value of type math.Ordering[ChoiceSetting] 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:

         (choiceSetting: math.Ordered[ChoiceSetting]).<=(that)

   Definition Classes
     Ordered
3.  def >(that: ChoiceSetting): Boolean
   Implicit
     This member is added by an implicit conversion from ChoiceSetting tomath.Ordered[ChoiceSetting] performed by method orderingToOrdered in scala.math.Ordered.This conversion will take place only if an implicit value of type math.Ordering[ChoiceSetting] 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:

         (choiceSetting: math.Ordered[ChoiceSetting]).>(that)

   Definition Classes
     Ordered
4.  def >=(that: ChoiceSetting): Boolean
   Implicit
     This member is added by an implicit conversion from ChoiceSetting tomath.Ordered[ChoiceSetting] performed by method orderingToOrdered in scala.math.Ordered.This conversion will take place only if an implicit value of type math.Ordering[ChoiceSetting] 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:

         (choiceSetting: math.Ordered[ChoiceSetting]).>=(that)

   Definition Classes
     Ordered
5.  def compare(that: ChoiceSetting): Int
   Implicit
     This member is added by an implicit conversion from ChoiceSetting tomath.Ordered[ChoiceSetting] performed by method orderingToOrdered in scala.math.Ordered.This conversion will take place only if an implicit value of type math.Ordering[ChoiceSetting] 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:

         (choiceSetting: math.Ordered[ChoiceSetting]).compare(that)

   Definition Classes
     Ordered
6.  def compareTo(that: ChoiceSetting): Int
   Implicit
     This member is added by an implicit conversion from ChoiceSetting tomath.Ordered[ChoiceSetting] performed by method orderingToOrdered in scala.math.Ordered.This conversion will take place only if an implicit value of type math.Ordering[ChoiceSetting] 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:

         (choiceSetting: math.Ordered[ChoiceSetting]).compareTo(that)

   Definition Classes
     Ordered → Comparable

### Deprecated Value Members

1.  def →[B](y: B): (ChoiceSetting, B)
   Implicit
     This member is added by an implicit conversion from ChoiceSetting toArrowAssoc[ChoiceSetting] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @deprecated
   Deprecated

     (Since version 2.13.0) Use `->` instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

### Inherited from Setting

### 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 fromChoiceSetting to math.Ordered[ChoiceSetting]

### Inherited by implicit conversion any2stringadd fromChoiceSetting to any2stringadd[ChoiceSetting]

### Inherited by implicit conversion StringFormat fromChoiceSetting to StringFormat[ChoiceSetting]

### Inherited by implicit conversion Ensuring fromChoiceSetting to Ensuring[ChoiceSetting]

### Inherited by implicit conversion ArrowAssoc fromChoiceSetting to ArrowAssoc[ChoiceSetting]

### Ungrouped