Packages

abstract class Setting extends AbsSetting with SettingValue with Mutable

A base class for settings of all types. Subclasses each define a value field of the appropriate type.

Source
MutableSettings.scala
Linear Supertypes
Mutable, MutableSettings.SettingValue, MutableSettings.AbsSetting, MutableSettings.AbsSettingValue, math.Ordered[Setting], Comparable[Setting], AnyRef, Any
Known Subclasses
BooleanSetting, ChoiceSetting, IntSetting, MultiChoiceSetting, MultiStringSetting, OutputSetting, PathSetting, PhasesSetting, PrefixSetting, ScalaVersionSetting, StringSetting
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Setting
  2. Mutable
  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. All

Instance Constructors

  1. new Setting(name: String, helpDescription: String)

Type Members

  1. abstract type T
    Definition Classes
    AbsSettingValue

Abstract Value Members

  1. abstract def unparse: List[String]
    Definition Classes
    AbsSetting

Concrete 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. def choices: List[String]
    Definition Classes
    AbsSetting
  7. def compare(that: Setting): Int
    Definition Classes
    AbsSetting → Ordered
  8. def compareTo(that: Setting): Int
    Definition Classes
    Ordered → Comparable
  9. def dependencies: List[(Setting, String)]
    Definition Classes
    Setting → AbsSetting
  10. def dependsOn(s: Setting, value: String): Setting.this.type
  11. def deprecationMessage: Option[String]
    Definition Classes
    Setting → AbsSetting
  12. 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
  13. def errorAndValue[T](msg: String, x: T): T

    Issue error and return

    Issue error and return

    Definition Classes
    AbsSetting
  14. def hashCode(): Int
    Definition Classes
    AbsSetting → AnyRef → Any
  15. def help: String

    The help message to be printed if isHelping.

    The help message to be printed if isHelping.

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

Shadowed Implicit Value Members

  1. def <(that: Setting): Boolean
    Implicit
    This member is added by an implicit conversion from Setting to math.Ordered[Setting] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[Setting] 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:
    (setting: math.Ordered[Setting]).<(that)
    Definition Classes
    Ordered
  2. def <=(that: Setting): Boolean
    Implicit
    This member is added by an implicit conversion from Setting to math.Ordered[Setting] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[Setting] 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:
    (setting: math.Ordered[Setting]).<=(that)
    Definition Classes
    Ordered
  3. def >(that: Setting): Boolean
    Implicit
    This member is added by an implicit conversion from Setting to math.Ordered[Setting] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[Setting] 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:
    (setting: math.Ordered[Setting]).>(that)
    Definition Classes
    Ordered
  4. def >=(that: Setting): Boolean
    Implicit
    This member is added by an implicit conversion from Setting to math.Ordered[Setting] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[Setting] 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:
    (setting: math.Ordered[Setting]).>=(that)
    Definition Classes
    Ordered
  5. def compare(that: Setting): Int
    Implicit
    This member is added by an implicit conversion from Setting to math.Ordered[Setting] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[Setting] 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:
    (setting: math.Ordered[Setting]).compare(that)
    Definition Classes
    Ordered
  6. def compareTo(that: Setting): Int
    Implicit
    This member is added by an implicit conversion from Setting to math.Ordered[Setting] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[Setting] 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:
    (setting: math.Ordered[Setting]).compareTo(that)
    Definition Classes
    Ordered → Comparable