Packages

class StringSetting extends Setting

A setting represented by a string, (default unless set)

Source
MutableSettings.scala
Linear Supertypes
Setting, Mutable, MutableSettings.SettingValue, MutableSettings.AbsSetting, MutableSettings.AbsSettingValue, math.Ordered[Setting], Comparable[Setting], AnyRef, Any
Known Subclasses
OutputSetting, PathSetting
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StringSetting
  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
    StringSetting → 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
    This member is added by an implicit conversion from StringSetting to any2stringadd[StringSetting] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (StringSetting, B)
    Implicit
    This member is added by an implicit conversion from StringSetting to ArrowAssoc[StringSetting] 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. val arg: String
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def choices: List[String]
    Definition Classes
    AbsSetting
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  15. def compare(that: Setting): Int
    Definition Classes
    AbsSetting → Ordered
  16. def compareTo(that: Setting): Int
    Definition Classes
    Ordered → Comparable
  17. val default: String
  18. def dependencies: List[(Setting, String)]
    Definition Classes
    Setting → AbsSetting
  19. def dependsOn(s: Setting, value: String): StringSetting.this.type
    Definition Classes
    Setting
  20. def deprecationMessage: Option[String]
    Definition Classes
    Setting → AbsSetting
  21. def ensuring(cond: (StringSetting) ⇒ Boolean, msg: ⇒ Any): StringSetting
    Implicit
    This member is added by an implicit conversion from StringSetting to Ensuring[StringSetting] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. def ensuring(cond: (StringSetting) ⇒ Boolean): StringSetting
    Implicit
    This member is added by an implicit conversion from StringSetting to Ensuring[StringSetting] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. def ensuring(cond: Boolean, msg: ⇒ Any): StringSetting
    Implicit
    This member is added by an implicit conversion from StringSetting to Ensuring[StringSetting] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. def ensuring(cond: Boolean): StringSetting
    Implicit
    This member is added by an implicit conversion from StringSetting to Ensuring[StringSetting] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. 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
  27. def errorAndValue[T](msg: String, x: T): T

    Issue error and return

    Issue error and return

    Definition Classes
    AbsSetting
  28. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  29. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  30. def hashCode(): Int
    Definition Classes
    AbsSetting → AnyRef → Any
  31. def help: String

    The help message to be printed if isHelping.

    The help message to be printed if isHelping.

    Definition Classes
    StringSetting → AbsSetting
  32. val helpDescription: String
    Definition Classes
    Setting → AbsSetting
  33. def helpSyntax: String
    Definition Classes
    Setting → AbsSetting
  34. def internalOnly(): StringSetting.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. 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
    StringSetting → AbsSetting
  40. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  41. def isInternalOnly: Boolean
    Definition Classes
    AbsSetting
  42. def isPrivate: Boolean
    Definition Classes
    AbsSetting
  43. def isSetByUser: Boolean
    Definition Classes
    SettingValue
  44. def isStandard: Boolean
    Definition Classes
    AbsSetting
  45. val name: String
    Definition Classes
    Setting → AbsSetting
  46. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  47. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  48. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  49. def postSetHook(): Unit
    Definition Classes
    Setting → SettingValue
  50. def respondsTo(label: String): Boolean
    Definition Classes
    AbsSetting
  51. var sawHelp: Boolean
    Attributes
    protected
  52. val setByUser: Boolean
    Attributes
    protected
    Definition Classes
    SettingValue
  53. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  54. def toString(): String
    Definition Classes
    AbsSetting → AnyRef → Any
  55. def tryToSet(args: List[String]): Option[ResultOfTryToSet]

    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
    StringSetting → AbsSetting
  56. 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.

    Attributes
    protected[nsc]
    Definition Classes
    AbsSetting
  57. 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
  58. def unparse: List[String]
    Definition Classes
    StringSetting → AbsSetting
  59. var v: T
    Attributes
    protected
    Definition Classes
    StringSetting → SettingValue
  60. def value: T
    Definition Classes
    SettingValue → AbsSettingValue
  61. def valueSetByUser: Option[T]
    Definition Classes
    SettingValue
  62. def value_=(arg: T): Unit
    Definition Classes
    SettingValue
  63. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  64. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  65. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  66. def withAbbreviation(s: String): StringSetting.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
  67. def withDeprecationMessage(msg: String): StringSetting.this.type
    Definition Classes
    Setting → AbsSetting
  68. def withHelpSyntax(s: String): StringSetting.this.type
    Definition Classes
    Setting → AbsSetting
  69. def withPostSetHook(f: (StringSetting.this.type) ⇒ Unit): StringSetting.this.type
    Definition Classes
    Setting
  70. def →[B](y: B): (StringSetting, B)
    Implicit
    This member is added by an implicit conversion from StringSetting to ArrowAssoc[StringSetting] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

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

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from StringSetting to StringFormat[StringSetting] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

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

Inherited by implicit conversion any2stringadd from StringSetting to any2stringadd[StringSetting]

Inherited by implicit conversion StringFormat from StringSetting to StringFormat[StringSetting]

Inherited by implicit conversion Ensuring from StringSetting to Ensuring[StringSetting]

Inherited by implicit conversion ArrowAssoc from StringSetting to ArrowAssoc[StringSetting]

Ungrouped