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, Mutable, MutableSettings.SettingValue, MutableSettings.AbsSetting, MutableSettings.AbsSettingValue, math.Ordered[Setting], Comparable[Setting], AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering

1. Alphabetic
2. By inheritance

Inherited

1. ChoiceSetting
2. Setting
3. Mutable
4. SettingValue
5. AbsSetting
6. AbsSettingValue
7. Ordered
8. Comparable
9. AnyRef
10. 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

### 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 information
     This member is added by an implicit conversion from ChoiceSetting to any2stringadd[ChoiceSetting] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd

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

   Implicit information
     This member is added by an implicit conversion from ChoiceSetting to ArrowAssoc[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. #### 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. #### val default: String

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

    Definition Classes
      Setting → AbsSetting

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

    Definition Classes
      Setting

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

    Definition Classes
      Setting → AbsSetting

20. #### def ensuring(cond: (ChoiceSetting) ⇒ Boolean, msg: ⇒ Any): ChoiceSetting

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

21. #### def ensuring(cond: (ChoiceSetting) ⇒ Boolean): ChoiceSetting

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

22. #### def ensuring(cond: Boolean, msg: ⇒ Any): ChoiceSetting

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

23. #### def ensuring(cond: Boolean): ChoiceSetting

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

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

    Definition Classes
      AnyRef

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

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

    Issue error and return

    Issue error and return

    Definition Classes
      AbsSetting

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

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

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

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

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

    Definition Classes
      AnyRef → Any

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

    Definition Classes
      AbsSetting → AnyRef → Any

31. #### val helpDescription: String

    Definition Classes
      Setting → AbsSetting

32. #### def helpSyntax: String

    Definition Classes
      Setting → AbsSetting

33. #### def indexOfChoice: Int

34. #### def internalOnly(): ChoiceSetting.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
      Setting → AbsSetting

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. #### final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
      AnyRef

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

    Definition Classes
      AbsSetting → AnyRef → Any

53. #### def tryToSet(args: List[String]): None.type

    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

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

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

56. #### def unparse: List[String]

    Definition Classes
      ChoiceSetting → AbsSetting

57. #### var v: T

    Attributes
      protected
    Definition Classes
      ChoiceSetting → SettingValue

58. #### def value: T

    Definition Classes
      SettingValue → AbsSettingValue

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

    Definition Classes
      SettingValue

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

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

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

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

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

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

63. #### 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 #3462. The immutable side doesn't exist yet anyway.

    Definition Classes
      Setting → AbsSetting

64. #### def withDeprecationMessage(msg: String): ChoiceSetting.this.type

    Definition Classes
      Setting → AbsSetting

65. #### def withHelpSyntax(s: String): ChoiceSetting.this.type

    Definition Classes
      Setting → AbsSetting

66. #### def withPostSetHook(f: (ChoiceSetting.this.type) ⇒ Unit): ChoiceSetting.this.type

    Definition Classes
      Setting

67. #### def →[B](y: B): (ChoiceSetting, B)

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

### Shadowed Implicit Value Members

1. #### def <(that: ChoiceSetting): Boolean

   Implicit information
     This member is added by an implicit conversion from ChoiceSetting to math.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 information
     This member is added by an implicit conversion from ChoiceSetting to math.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 information
     This member is added by an implicit conversion from ChoiceSetting to math.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 information
     This member is added by an implicit conversion from ChoiceSetting to math.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 information
     This member is added by an implicit conversion from ChoiceSetting to math.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 information
     This member is added by an implicit conversion from ChoiceSetting to math.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

### Inherited from Setting

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

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

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

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

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

### Ungrouped