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. 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[A](msg: String, x: A): A

    Issue error and return the value.

    Issue error and return the value.

    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 helpArg: String
  19. val helpDescription: String
    Definition Classes
    Setting → AbsSetting
  20. def helpSyntax: String
    Definition Classes
    Setting → AbsSetting
  21. def indexOfChoice: Int
  22. def internalOnly(): ChoiceSetting.this.type
    Definition Classes
    AbsSetting
  23. 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
  24. def isDefault: Boolean
    Definition Classes
    SettingValue → AbsSettingValue
  25. def isDeprecated: 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. def isVerbose: Boolean
    Definition Classes
    AbsSetting
  32. def isWarning: Boolean
    Definition Classes
    AbsSetting
  33. val name: String
    Definition Classes
    Setting → AbsSetting
  34. def postSetHook(): Unit
    Definition Classes
    Setting → SettingValue
  35. def reset(): Unit
    Definition Classes
    ChoiceSetting → Setting
  36. def respondsTo(label: String): Boolean
    Definition Classes
    AbsSetting
  37. def toString(): String
    Definition Classes
    AbsSetting → AnyRef → Any
  38. def tryToSet(args: List[String]): Option[ResultOfTryToSet]

    Setting is presented the remaining command line arguments.

    Setting is presented the remaining command line arguments. It should consume any applicable args and return the rest, or None on error.

    Definition Classes
    ChoiceSetting → AbsSetting
  39. def tryToSetColon(args: List[String]): Option[ResultOfTryToSet]

    Setting is presented arguments in form -Xfoo:bar,baz.

    Setting is presented arguments in form -Xfoo:bar,baz. It should consume all the arguments and return an empty list, or None on error. Unconsumed args may error.

    Definition Classes
    ChoiceSetting → AbsSetting
  40. 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
  41. def unparse: List[String]
    Definition Classes
    ChoiceSetting → AbsSetting
  42. def value: T
    Definition Classes
    SettingValue → AbsSettingValue
  43. def valueSetByUser: Option[T]
    Definition Classes
    SettingValue
  44. def value_=(arg: T): Unit
    Definition Classes
    SettingValue
  45. def withAbbreviation(s: String): ChoiceSetting.this.type
    Definition Classes
    Setting → AbsSetting
  46. def withDeprecationMessage(msg: String): ChoiceSetting.this.type
    Definition Classes
    Setting → AbsSetting
  47. def withHelpSyntax(s: String): ChoiceSetting.this.type
    Definition Classes
    Setting → AbsSetting
  48. def withPostSetHook(f: (ChoiceSetting.this.type) => Unit): ChoiceSetting.this.type
    Definition Classes
    Setting
  49. 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