Packages

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
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
Visibility
  1. Public
  2. All

Type Members

  1. type T = String
    Definition Classes
    ChoiceSetting → AbsSettingValue

Value Members

  1. def <(that: Setting): Boolean
    Definition Classes
    Ordered
  2. def <=(that: Setting): Boolean
    Definition Classes
    Ordered
  3. def >(that: Setting): Boolean
    Definition Classes
    Ordered
  4. def >=(that: Setting): Boolean
    Definition Classes
    Ordered
  5. def abbreviations: List[String]
    Definition Classes
    Setting → AbsSetting
  6. val choices: List[String]
    Definition Classes
    ChoiceSetting → AbsSetting
  7. val choicesHelp: List[String]
  8. def compare(that: Setting): Int
    Definition Classes
    AbsSetting → Ordered
  9. def compareTo(that: Setting): Int
    Definition Classes
    Ordered → Comparable
  10. val default: String
  11. def dependencies: List[(Setting, String)]
    Definition Classes
    Setting → AbsSetting
  12. def dependsOn(s: Setting, value: String): ChoiceSetting.this.type
    Definition Classes
    Setting
  13. def deprecationMessage: Option[String]
    Definition Classes
    Setting → AbsSetting
  14. 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
  15. def errorAndValue[T](msg: String, x: T): T

    Issue error and return

    Issue error and return

    Definition Classes
    AbsSetting
  16. def hashCode(): Int
    Definition Classes
    AbsSetting → AnyRef → Any
  17. def help: String

    The help message to be printed if isHelping.

    The help message to be printed if isHelping.

    Definition Classes
    ChoiceSetting → AbsSetting
  18. val helpDescription: String
    Definition Classes
    Setting → AbsSetting
  19. def helpSyntax: String
    Definition Classes
    Setting → AbsSetting
  20. def indexOfChoice: Int
  21. def internalOnly(): ChoiceSetting.this.type
    Definition Classes
    AbsSetting
  22. 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
  23. def isDefault: Boolean
    Definition Classes
    SettingValue → AbsSettingValue
  24. def isDeprecated: Boolean
    Definition Classes
    AbsSetting
  25. def isForDebug: Boolean
    Definition Classes
    AbsSetting
  26. 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
  27. def isInternalOnly: Boolean
    Definition Classes
    AbsSetting
  28. def isPrivate: Boolean
    Definition Classes
    AbsSetting
  29. def isSetByUser: Boolean
    Definition Classes
    SettingValue
  30. def isStandard: Boolean
    Definition Classes
    AbsSetting
  31. val name: String
    Definition Classes
    Setting → AbsSetting
  32. def postSetHook(): Unit
    Definition Classes
    Setting → SettingValue
  33. def respondsTo(label: String): Boolean
    Definition Classes
    AbsSetting
  34. def toString(): String
    Definition Classes
    AbsSetting → AnyRef → Any
  35. 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
  36. 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
  37. 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
  38. def unparse: List[String]
    Definition Classes
    ChoiceSetting → AbsSetting
  39. def value: T
    Definition Classes
    SettingValue → AbsSettingValue
  40. def valueSetByUser: Option[T]
    Definition Classes
    SettingValue
  41. def value_=(arg: T): Unit
    Definition Classes
    SettingValue
  42. 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
  43. def withDeprecationMessage(msg: String): ChoiceSetting.this.type
    Definition Classes
    Setting → AbsSetting
  44. def withHelpSyntax(s: String): ChoiceSetting.this.type
    Definition Classes
    Setting → AbsSetting
  45. def withPostSetHook(f: (ChoiceSetting.this.type) ⇒ Unit): ChoiceSetting.this.type
    Definition Classes
    Setting

Shadowed Implicit Value Members

  1. def <(that: ChoiceSetting): Boolean
    Implicit
    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
    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
    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
    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
    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
    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