scala.tools.nsc.settings.MutableSettings

MultiChoiceSetting

class MultiChoiceSetting[E <: MultiChoiceEnumeration] extends Setting with Clearable

A Setting that collects string-valued settings from an enumerated domain.

Arguments can be provided in colonated or non-colonated mode, i.e. "-option a b" or "-option:a,b". Note that arguments starting with a "-" can only be provided in colonated mode, otherwise they are interpreted as a new option.

In non-colonated mode, the setting stops consuming arguments at the first non-choice, i.e. "-option a b c" only consumes "a" and "b" if "c" is not a valid choice.

Source
MutableSettings.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. MultiChoiceSetting
  2. Clearable
  3. Setting
  4. Mutable
  5. SettingValue
  6. AbsSetting
  7. AbsSettingValue
  8. Ordered
  9. Comparable
  10. AnyRef
  11. 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 = E.ValueSet

    Definition Classes
    MultiChoiceSetting → 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 MultiChoiceSetting[E] to any2stringadd[MultiChoiceSetting[E]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (MultiChoiceSetting[E], B)

    Implicit information
    This member is added by an implicit conversion from MultiChoiceSetting[E] to ArrowAssoc[MultiChoiceSetting[E]] 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. object ChoiceOrVal

  11. def abbreviations: List[String]

    Definition Classes
    SettingAbsSetting
  12. def add(arg: String): Unit

    Add a named choice to the multichoice value.

  13. final def asInstanceOf[T0]: T0

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

    Definition Classes
    MultiChoiceSettingAbsSetting
  15. def clear(): Unit

    Definition Classes
    MultiChoiceSetting → Clearable
  16. def clone(): AnyRef

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

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

    Definition Classes
    Ordered → Comparable
  19. def compute(): Unit

    (Re)compute from current yeas, nays, wildcard status.

  20. def contains(s: String): Boolean

  21. def contains(choice: E.Value): Boolean

  22. val default: Option[List[String]]

    If Some(args), the default options if none are provided.

    If Some(args), the default options if none are provided. If None, an error is printed if there are no arguments.

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

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

    Definition Classes
    Setting
  25. def deprecationMessage: Option[String]

    Definition Classes
    SettingAbsSetting
  26. def descriptions: List[String]

  27. val domain: E

    enumeration of choices implementing MultiChoice, or the string value is taken for the name

  28. def ensuring(cond: (MultiChoiceSetting[E]) ⇒ Boolean, msg: ⇒ Any): MultiChoiceSetting[E]

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

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

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

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

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

    Issue error and return

    Issue error and return

    Definition Classes
    AbsSetting
  35. def finalize(): Unit

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

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

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

    Definition Classes
    AbsSetting → AnyRef → Any
  39. def help: String

  40. val helpDescription: String

    Definition Classes
    SettingAbsSetting
  41. def helpSyntax: String

    Definition Classes
    SettingAbsSetting
  42. def internalOnly(): MultiChoiceSetting.this.type

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

    Definition Classes
    SettingValue → AbsSettingValue
  45. def isDeprecated: Boolean

    Definition Classes
    AbsSetting
  46. def isForDebug: Boolean

    Definition Classes
    AbsSetting
  47. def isHelping: Boolean

  48. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  49. def isInternalOnly: Boolean

    Definition Classes
    AbsSetting
  50. def isPrivate: Boolean

    Definition Classes
    AbsSetting
  51. def isSetByUser: Boolean

    Definition Classes
    SettingValue
  52. def isStandard: Boolean

    Definition Classes
    AbsSetting
  53. val name: String

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

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

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

    Definition Classes
    AnyRef
  57. def postSetHook(): Unit

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

    Definition Classes
    AbsSetting
  59. var setByUser: Boolean

    Attributes
    protected
    Definition Classes
    SettingValue
  60. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  61. def toString(): String

    Definition Classes
    AbsSetting → AnyRef → Any
  62. def tryToSet(args: List[String]): Some[List[String]]

    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
    MultiChoiceSettingAbsSetting
  63. def tryToSetColon(args: List[String]): Some[List[String]]

    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
    MultiChoiceSettingAbsSetting
  64. 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
    MultiChoiceSettingAbsSetting
  65. def unparse: List[String]

    Definition Classes
    MultiChoiceSettingAbsSetting
  66. var v: T

    Attributes
    protected
    Definition Classes
    MultiChoiceSetting → SettingValue
  67. def value: T

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

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  72. def withAbbreviation(s: String): MultiChoiceSetting.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
  73. def withDeprecationMessage(msg: String): MultiChoiceSetting.this.type

    Definition Classes
    SettingAbsSetting
  74. def withHelpSyntax(s: String): MultiChoiceSetting.this.type

    Definition Classes
    SettingAbsSetting
  75. def withPostSetHook(f: (MultiChoiceSetting.this.type) ⇒ Unit): MultiChoiceSetting.this.type

    Definition Classes
    Setting
  76. def [B](y: B): (MultiChoiceSetting[E], B)

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

Shadowed Implicit Value Members

  1. def <(that: MultiChoiceSetting[E]): Boolean

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

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

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

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

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

    Implicit information
    This member is added by an implicit conversion from MultiChoiceSetting[E] to math.Ordered[MultiChoiceSetting[E]] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[MultiChoiceSetting[E]] 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:
    (multiChoiceSetting: math.Ordered[MultiChoiceSetting[E]]).compareTo(that)
    Definition Classes
    Ordered → Comparable

Inherited from Clearable

Inherited from Setting

Inherited from Mutable

Inherited from math.Ordered[Setting]

Inherited from Comparable[Setting]

Inherited from AnyRef

Inherited from Any

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

Inherited by implicit conversion any2stringadd from MultiChoiceSetting[E] to any2stringadd[MultiChoiceSetting[E]]

Inherited by implicit conversion StringFormat from MultiChoiceSetting[E] to StringFormat[MultiChoiceSetting[E]]

Inherited by implicit conversion Ensuring from MultiChoiceSetting[E] to Ensuring[MultiChoiceSetting[E]]

Inherited by implicit conversion ArrowAssoc from MultiChoiceSetting[E] to ArrowAssoc[MultiChoiceSetting[E]]

Ungrouped