abstract class Setting extends AbsSetting with SettingValue
A base class for settings of all types.
Subclasses each define a value field of the appropriate type.
- Source
- MutableSettings.scala
Linear Supertypes
Known Subclasses
Type Hierarchy
Ordering
- Alphabetic
- By Inheritance
Inherited
- Setting
- SettingValue
- AbsSetting
- AbsSettingValue
- Ordered
- Comparable
- AnyRef
- Any
Implicitly
- by orderingToOrdered
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new Setting(name: String, helpDescription: String)
Type Members
- abstract type T
- Definition Classes
- AbsSettingValue
Abstract Value Members
- abstract def reset(): Unit
- abstract 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
Noneon error.- Attributes
- protected[nsc]
- Definition Classes
- AbsSetting
- abstract 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
Noneon error. Unconsumed args may error.- Attributes
- protected[nsc]
- Definition Classes
- AbsSetting
- abstract def unparse: List[String]
- Definition Classes
- AbsSetting
- abstract val v: T
- Attributes
- protected
- Definition Classes
- SettingValue
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Setting, B)
- def <(that: Setting): Boolean
- Definition Classes
- Ordered
- def <=(that: Setting): Boolean
- Definition Classes
- Ordered
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def >(that: Setting): Boolean
- Definition Classes
- Ordered
- def >=(that: Setting): Boolean
- Definition Classes
- Ordered
- def abbreviations: List[String]
- Definition Classes
- Setting → AbsSetting
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def choices: List[String]
- Definition Classes
- AbsSetting
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def compare(that: Setting): Int
- Definition Classes
- AbsSetting → Ordered
- def compareTo(that: Setting): Int
- Definition Classes
- Ordered → Comparable
- def dependencies: List[(Setting, String)]
- Definition Classes
- Setting → AbsSetting
- def dependsOn(s: Setting, value: String): Setting.this.type
- def deprecationMessage: Option[String]
- Definition Classes
- Setting → AbsSetting
- def ensuring(cond: (Setting) => Boolean, msg: => Any): Setting
- def ensuring(cond: (Setting) => Boolean): Setting
- def ensuring(cond: Boolean, msg: => Any): Setting
- def ensuring(cond: Boolean): Setting
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- 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
- def errorAndValue[A](msg: String, x: A): A
Issue error and return the value.
Issue error and return the value.
- Definition Classes
- AbsSetting
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AbsSetting → AnyRef → Any
- def help: String
The help message to be printed if isHelping.
The help message to be printed if isHelping.
- Definition Classes
- AbsSetting
- val helpDescription: String
- Definition Classes
- Setting → AbsSetting
- def helpSyntax: String
- Definition Classes
- Setting → AbsSetting
- def internalOnly(): Setting.this.type
- Definition Classes
- AbsSetting
- def isAdvanced: Boolean
Standard options are shown on the
-helpoutput, advanced on-X, private on-Y, warning on-W, verbose on-V.Standard options are shown on the
-helpoutput, advanced on-X, private on-Y, warning on-W, verbose on-V.The single char options themselves, including
-P, are explained on-help. Additionally,-Werroris on-helpand-Xlinton-W.- Definition Classes
- AbsSetting
- def isDefault: Boolean
- Definition Classes
- SettingValue → AbsSettingValue
- def isDeprecated: Boolean
- Definition Classes
- AbsSetting
- 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
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isInternalOnly: Boolean
- Definition Classes
- AbsSetting
- def isPrivate: Boolean
- Definition Classes
- AbsSetting
- def isSetByUser: Boolean
- Definition Classes
- SettingValue
- def isStandard: Boolean
- Definition Classes
- AbsSetting
- def isVerbose: Boolean
- Definition Classes
- AbsSetting
- def isWarning: Boolean
- Definition Classes
- AbsSetting
- val name: String
- Definition Classes
- Setting → AbsSetting
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def postSetHook(): Unit
- Definition Classes
- Setting → SettingValue
- def respondsTo(label: String): Boolean
- Definition Classes
- AbsSetting
- val setByUser: Boolean
- Attributes
- protected
- Definition Classes
- SettingValue
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AbsSetting → AnyRef → Any
- 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
- def value: T
- Definition Classes
- SettingValue → AbsSettingValue
- def valueSetByUser: Option[T]
- Definition Classes
- SettingValue
- def value_=(arg: T): Unit
- Definition Classes
- SettingValue
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withAbbreviation(s: String): Setting.this.type
- Definition Classes
- Setting → AbsSetting
- def withDeprecationMessage(msg: String): Setting.this.type
- Definition Classes
- Setting → AbsSetting
- def withHelpSyntax(s: String): Setting.this.type
- Definition Classes
- Setting → AbsSetting
- def withPostSetHook(f: (Setting.this.type) => Unit): Setting.this.type
Shadowed Implicit Value Members
- def <(that: Setting): Boolean
- Implicit
- This member is added by an implicit conversion from Setting tomath.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
- def <=(that: Setting): Boolean
- Implicit
- This member is added by an implicit conversion from Setting tomath.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
- def >(that: Setting): Boolean
- Implicit
- This member is added by an implicit conversion from Setting tomath.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
- def >=(that: Setting): Boolean
- Implicit
- This member is added by an implicit conversion from Setting tomath.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
- def compare(that: Setting): Int
- Implicit
- This member is added by an implicit conversion from Setting tomath.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
- def compareTo(that: Setting): Int
- Implicit
- This member is added by an implicit conversion from Setting tomath.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
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from Setting toStringFormat[Setting] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (Setting, B)
- Implicit
- This member is added by an implicit conversion from Setting toArrowAssoc[Setting] 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.
The Scala compiler and reflection APIs.