Scala Compiler 2.13.16 - scala.tools.nsc.settings.MutableSettings.Setting
Keywords: Scala Compiler 2.13.16 scala.tools.nsc.settings.MutableSettings.Setting

Scala Compiler2.13.16 < Back


# Packages

-  package root

  The Scala compiler and reflection APIs.

  The Scala compiler and reflection APIs.

  Definition Classes
    root
-  package scala
  Definition Classes
    root
-  package tools
  Definition Classes
    scala
-  package nsc
  Definition Classes
    tools
-  package settings
  Definition Classes
    nsc
-  class MutableSettings extends reflect.internal.settings.MutableSettings with AbsSettings with ScalaSettings

  A mutable Settings object.

  A mutable Settings object.

  Definition Classes
    settings
- AbsSetting
- AbsSettingValue
- BooleanSetting
- CachePolicy
- ChoiceSetting
- EnableSettings
- IntSetting
- InternalSetting
- LintWarnings
- MacroExpand
- MultiChoiceEnumeration
- MultiChoiceSetting
- MultiStringSetting
- OutputDirs
- OutputSetting
- PathSetting
- PerformanceWarnings
- PhasesSetting
- PrefixSetting
- ScalaVersionSetting
- Setting
- SettingValue
- StringSetting
- UnusedWarnings
- XxmlSettings
- languageFeatures
- mixinForwarderChoices
- optChoices
- optWarningsChoices
- sourceFeatures

c

scala.tools.nsc.settings.MutableSettings

# Setting

###

#### 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
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
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. Setting
2. SettingValue
3. AbsSetting
4. AbsSettingValue
5. Ordered
6. Comparable
7. AnyRef
8. 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

### Instance Constructors

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

### Type Members

1.  abstract type T
   Definition Classes
     AbsSettingValue

### Abstract Value Members

1.  abstract def reset(): Unit
2.  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 `None` on error.

   Attributes
     protected[nsc]
   Definition Classes
     AbsSetting
3.  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 `None` on error. Unconsumed args may error.

   Attributes
     protected[nsc]
   Definition Classes
     AbsSetting
4.  abstract def unparse: List[String]
   Definition Classes
     AbsSetting
5.  abstract val v: T
   Attributes
     protected
   Definition Classes
     SettingValue

### Concrete 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 Setting toany2stringadd[Setting] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  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
     @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.  final def asInstanceOf[T0]: T0
    Definition Classes
      Any
12.  def choices: List[String]
    Definition Classes
      AbsSetting
13.  def clone(): AnyRef
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.CloneNotSupportedException]) @native()
14.  def compare(that: Setting): Int
    Definition Classes
      AbsSetting → Ordered
15.  def compareTo(that: Setting): Int
    Definition Classes
      Ordered → Comparable
16.  def dependencies: List[(Setting, String)]
    Definition Classes
      Setting → AbsSetting
17.  def dependsOn(s: Setting, value: String): Setting.this.type
18.  def deprecationMessage: Option[String]
    Definition Classes
      Setting → AbsSetting
19.  def ensuring(cond: (Setting) => Boolean, msg: => Any): Setting
    Implicit
      This member is added by an implicit conversion from Setting toEnsuring[Setting] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
20.  def ensuring(cond: (Setting) => Boolean): Setting
    Implicit
      This member is added by an implicit conversion from Setting toEnsuring[Setting] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
21.  def ensuring(cond: Boolean, msg: => Any): Setting
    Implicit
      This member is added by an implicit conversion from Setting toEnsuring[Setting] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
22.  def ensuring(cond: Boolean): Setting
    Implicit
      This member is added by an implicit conversion from Setting toEnsuring[Setting] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
23.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
24.  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
25.  def errorAndValue[A](msg: String, x: A): A

    Issue error and return the value.

    Issue error and return the value.

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

    The help message to be printed if isHelping.

    The help message to be printed if isHelping.

    Definition Classes
      AbsSetting
30.  val helpDescription: String
    Definition Classes
      Setting → AbsSetting
31.  def helpSyntax: String
    Definition Classes
      Setting → AbsSetting
32.  def internalOnly(): Setting.this.type
    Definition Classes
      AbsSetting
33.  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
34.  def isDefault: Boolean
    Definition Classes
      SettingValue → AbsSettingValue
35.  def isDeprecated: Boolean
    Definition Classes
      AbsSetting
36.  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
37.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
38.  def isInternalOnly: Boolean
    Definition Classes
      AbsSetting
39.  def isPrivate: Boolean
    Definition Classes
      AbsSetting
40.  def isSetByUser: Boolean
    Definition Classes
      SettingValue
41.  def isStandard: Boolean
    Definition Classes
      AbsSetting
42.  def isVerbose: Boolean
    Definition Classes
      AbsSetting
43.  def isWarning: Boolean
    Definition Classes
      AbsSetting
44.  val name: String
    Definition Classes
      Setting → AbsSetting
45.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
46.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
47.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
48.  def postSetHook(): Unit
    Definition Classes
      Setting → SettingValue
49.  def respondsTo(label: String): Boolean
    Definition Classes
      AbsSetting
50.  val setByUser: Boolean
    Attributes
      protected
    Definition Classes
      SettingValue
51.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
52.  def toString(): String
    Definition Classes
      AbsSetting → AnyRef → Any
53.  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
54.  def value: T
    Definition Classes
      SettingValue → AbsSettingValue
55.  def valueSetByUser: Option[T]
    Definition Classes
      SettingValue
56.  def value_=(arg: T): Unit
    Definition Classes
      SettingValue
57.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
58.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
59.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()
60.  def withAbbreviation(s: String): Setting.this.type
    Definition Classes
      Setting → AbsSetting
61.  def withDeprecationMessage(msg: String): Setting.this.type
    Definition Classes
      Setting → AbsSetting
62.  def withHelpSyntax(s: String): Setting.this.type
    Definition Classes
      Setting → AbsSetting
63.  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 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
2.  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
3.  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
4.  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
5.  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
6.  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

1.  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 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): (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.

### 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 fromSetting to math.Ordered[Setting]

### Inherited by implicit conversion any2stringadd fromSetting to any2stringadd[Setting]

### Inherited by implicit conversion StringFormat fromSetting to StringFormat[Setting]

### Inherited by implicit conversion Ensuring fromSetting to Ensuring[Setting]

### Inherited by implicit conversion ArrowAssoc fromSetting to ArrowAssoc[Setting]

### Ungrouped