class BooleanSetting extends Setting

A setting that is a boolean flag, with default as specified.

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. BooleanSetting
  2. Setting
  3. SettingValue
  4. AbsSetting
  5. AbsSettingValue
  6. Ordered
  7. Comparable
  8. AnyRef
  9. Any
Implicitly
  1. by reflectSettingToBoolean
  2. by orderingToOrdered
  3. by any2stringadd
  4. by StringFormat
  5. by Ensuring
  6. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1.  type T = Boolean
    Definition Classes
    BooleanSetting → AbsSettingValue

Value Members

  1.  final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2.  final def ##: Int
    Definition Classes
    AnyRef → Any
  3.  def &(x: Boolean): Boolean
    Implicit
    This member is added by an implicit conversion from BooleanSetting toBoolean performed by method reflectSettingToBoolean in scala.reflect.internal.settings.MutableSettings.
    Definition Classes
    Boolean
  4.  def &&(x: Boolean): Boolean
    Implicit
    This member is added by an implicit conversion from BooleanSetting toBoolean performed by method reflectSettingToBoolean in scala.reflect.internal.settings.MutableSettings.
    Definition Classes
    Boolean
  5.  def +(other: String): String
    Implicit
    This member is added by an implicit conversion from BooleanSetting toany2stringadd[BooleanSetting] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  6.  def ->[B](y: B): (BooleanSetting, B)
    Implicit
    This member is added by an implicit conversion from BooleanSetting toArrowAssoc[BooleanSetting] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  7.  def <(that: Setting): Boolean
    Definition Classes
    Ordered
  8.  def <=(that: Setting): Boolean
    Definition Classes
    Ordered
  9.  final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10.  def >(that: Setting): Boolean
    Definition Classes
    Ordered
  11.  def >=(that: Setting): Boolean
    Definition Classes
    Ordered
  12.  def ^(x: Boolean): Boolean
    Implicit
    This member is added by an implicit conversion from BooleanSetting toBoolean performed by method reflectSettingToBoolean in scala.reflect.internal.settings.MutableSettings.
    Definition Classes
    Boolean
  13.  def abbreviations: List[String]
    Definition Classes
    Setting → AbsSetting
  14.  final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  15.  def choices: List[String]
    Definition Classes
    AbsSetting
  16.  def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  17.  def compare(that: Setting): Int
    Definition Classes
    AbsSetting → Ordered
  18.  def compareTo(that: Setting): Int
    Definition Classes
    Ordered → Comparable
  19.  def dependencies: List[(Setting, String)]
    Definition Classes
    Setting → AbsSetting
  20.  def dependsOn(s: Setting, value: String): BooleanSetting.this.type
    Definition Classes
    Setting
  21.  def deprecationMessage: Option[String]
    Definition Classes
    Setting → AbsSetting
  22.  def ensuring(cond: (BooleanSetting) => Boolean, msg: => Any): BooleanSetting
    Implicit
    This member is added by an implicit conversion from BooleanSetting toEnsuring[BooleanSetting] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23.  def ensuring(cond: (BooleanSetting) => Boolean): BooleanSetting
    Implicit
    This member is added by an implicit conversion from BooleanSetting toEnsuring[BooleanSetting] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24.  def ensuring(cond: Boolean, msg: => Any): BooleanSetting
    Implicit
    This member is added by an implicit conversion from BooleanSetting toEnsuring[BooleanSetting] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25.  def ensuring(cond: Boolean): BooleanSetting
    Implicit
    This member is added by an implicit conversion from BooleanSetting toEnsuring[BooleanSetting] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  26.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27.  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
  28.  def errorAndValue[A](msg: String, x: A): A

    Issue error and return the value.

    Issue error and return the value.

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

    The help message to be printed if isHelping.

    The help message to be printed if isHelping.

    Definition Classes
    AbsSetting
  33.  val helpDescription: String
    Definition Classes
    Setting → AbsSetting
  34.  def helpSyntax: String
    Definition Classes
    Setting → AbsSetting
  35.  def internalOnly(): BooleanSetting.this.type
    Definition Classes
    AbsSetting
  36.  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
  37.  def isDefault: Boolean
    Definition Classes
    SettingValue → AbsSettingValue
  38.  def isDeprecated: 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
    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.  def isVerbose: Boolean
    Definition Classes
    AbsSetting
  46.  def isWarning: Boolean
    Definition Classes
    AbsSetting
  47.  val name: String
    Definition Classes
    Setting → AbsSetting
  48.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  49.  final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  50.  final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  51.  def postSetHook(): Unit
    Definition Classes
    Setting → SettingValue
  52.  def respondsTo(label: String): Boolean
    Definition Classes
    AbsSetting
  53.  val setByUser: Boolean
    Attributes
    protected
    Definition Classes
    SettingValue
  54.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  55.  def toString(): String
    Definition Classes
    AbsSetting → AnyRef → Any
  56.  def tryToSet(args: List[String]): Some[List[String]]

    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
    BooleanSetting → AbsSetting
  57.  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
    BooleanSetting → AbsSetting
  58.  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
    BooleanSetting → AbsSetting
  59.  def unary_!: Boolean
    Implicit
    This member is added by an implicit conversion from BooleanSetting toBoolean performed by method reflectSettingToBoolean in scala.reflect.internal.settings.MutableSettings.
    Definition Classes
    Boolean
  60.  def unparse: List[String]
    Definition Classes
    BooleanSetting → AbsSetting
  61.  var v: Boolean
    Attributes
    protected
    Definition Classes
    BooleanSetting → SettingValue
  62.  def value: Boolean
    Definition Classes
    BooleanSetting → SettingValue → AbsSettingValue
  63.  def valueSetByUser: Option[T]
    Definition Classes
    SettingValue
  64.  def value_=(arg: T): Unit
    Definition Classes
    SettingValue
  65.  final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  66.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  67.  final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  68.  def withAbbreviation(s: String): BooleanSetting.this.type
    Definition Classes
    Setting → AbsSetting
  69.  def withDeprecationMessage(msg: String): BooleanSetting.this.type
    Definition Classes
    Setting → AbsSetting
  70.  def withHelpSyntax(s: String): BooleanSetting.this.type
    Definition Classes
    Setting → AbsSetting
  71.  def withPostSetHook(f: (BooleanSetting.this.type) => Unit): BooleanSetting.this.type
    Definition Classes
    Setting
  72.  def |(x: Boolean): Boolean
    Implicit
    This member is added by an implicit conversion from BooleanSetting toBoolean performed by method reflectSettingToBoolean in scala.reflect.internal.settings.MutableSettings.
    Definition Classes
    Boolean
  73.  def ||(x: Boolean): Boolean
    Implicit
    This member is added by an implicit conversion from BooleanSetting toBoolean performed by method reflectSettingToBoolean in scala.reflect.internal.settings.MutableSettings.
    Definition Classes
    Boolean

Shadowed Implicit Value Members

  1.  def !=(x: Boolean): Boolean
    Implicit
    This member is added by an implicit conversion from BooleanSetting toBoolean performed by method reflectSettingToBoolean in scala.reflect.internal.settings.MutableSettings.
    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:
    (booleanSetting: Boolean).!=(x)
    Definition Classes
    Boolean
  2.  def <(that: BooleanSetting): Boolean
    Implicit
    This member is added by an implicit conversion from BooleanSetting tomath.Ordered[BooleanSetting] performed by method orderingToOrdered in scala.math.Ordered.This conversion will take place only if an implicit value of type math.Ordering[BooleanSetting] 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:
    (booleanSetting: math.Ordered[BooleanSetting]).<(that)
    Definition Classes
    Ordered
  3.  def <=(that: BooleanSetting): Boolean
    Implicit
    This member is added by an implicit conversion from BooleanSetting tomath.Ordered[BooleanSetting] performed by method orderingToOrdered in scala.math.Ordered.This conversion will take place only if an implicit value of type math.Ordering[BooleanSetting] 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:
    (booleanSetting: math.Ordered[BooleanSetting]).<=(that)
    Definition Classes
    Ordered
  4.  def ==(x: Boolean): Boolean
    Implicit
    This member is added by an implicit conversion from BooleanSetting toBoolean performed by method reflectSettingToBoolean in scala.reflect.internal.settings.MutableSettings.
    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:
    (booleanSetting: Boolean).==(x)
    Definition Classes
    Boolean
  5.  def >(that: BooleanSetting): Boolean
    Implicit
    This member is added by an implicit conversion from BooleanSetting tomath.Ordered[BooleanSetting] performed by method orderingToOrdered in scala.math.Ordered.This conversion will take place only if an implicit value of type math.Ordering[BooleanSetting] 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:
    (booleanSetting: math.Ordered[BooleanSetting]).>(that)
    Definition Classes
    Ordered
  6.  def >=(that: BooleanSetting): Boolean
    Implicit
    This member is added by an implicit conversion from BooleanSetting tomath.Ordered[BooleanSetting] performed by method orderingToOrdered in scala.math.Ordered.This conversion will take place only if an implicit value of type math.Ordering[BooleanSetting] 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:
    (booleanSetting: math.Ordered[BooleanSetting]).>=(that)
    Definition Classes
    Ordered
  7.  def compare(that: BooleanSetting): Int
    Implicit
    This member is added by an implicit conversion from BooleanSetting tomath.Ordered[BooleanSetting] performed by method orderingToOrdered in scala.math.Ordered.This conversion will take place only if an implicit value of type math.Ordering[BooleanSetting] 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:
    (booleanSetting: math.Ordered[BooleanSetting]).compare(that)
    Definition Classes
    Ordered
  8.  def compareTo(that: BooleanSetting): Int
    Implicit
    This member is added by an implicit conversion from BooleanSetting tomath.Ordered[BooleanSetting] performed by method orderingToOrdered in scala.math.Ordered.This conversion will take place only if an implicit value of type math.Ordering[BooleanSetting] 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:
    (booleanSetting: math.Ordered[BooleanSetting]).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 BooleanSetting toStringFormat[BooleanSetting] 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.

  2.  def →[B](y: B): (BooleanSetting, B)
    Implicit
    This member is added by an implicit conversion from BooleanSetting toArrowAssoc[BooleanSetting] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Setting

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 reflectSettingToBoolean fromBooleanSetting to Boolean

Inherited by implicit conversion orderingToOrdered fromBooleanSetting to math.Ordered[BooleanSetting]

Inherited by implicit conversion any2stringadd fromBooleanSetting to any2stringadd[BooleanSetting]

Inherited by implicit conversion StringFormat fromBooleanSetting to StringFormat[BooleanSetting]

Inherited by implicit conversion Ensuring fromBooleanSetting to Ensuring[BooleanSetting]

Inherited by implicit conversion ArrowAssoc fromBooleanSetting to ArrowAssoc[BooleanSetting]

Ungrouped