Trait

scala.tools.nsc.settings.AbsSettings

InternalSetting

Related Doc: package AbsSettings

Permalink

trait InternalSetting extends AbsSetting

Source
AbsSettings.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InternalSetting
  2. AbsSetting
  3. AbsSettingValue
  4. Ordered
  5. Comparable
  6. AnyRef
  7. 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. abstract type T

    Permalink
    Definition Classes
    AbsSettingValue

Abstract Value Members

  1. abstract def helpDescription: String

    Permalink
    Definition Classes
    AbsSetting
  2. abstract def isDefault: Boolean

    Permalink
    Definition Classes
    AbsSettingValue
  3. abstract def name: String

    Permalink
    Definition Classes
    AbsSetting
  4. abstract def tryToSet(args: List[String]): Option[ResultOfTryToSet]

    Permalink

    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.

    Attributes
    protected[scala.tools.nsc]
    Definition Classes
    AbsSetting
  5. abstract def unparse: List[String]

    Permalink
    Definition Classes
    AbsSetting
  6. abstract def value: T

    Permalink
    Definition Classes
    AbsSettingValue
  7. abstract def withAbbreviation(name: String): InternalSetting.this.type

    Permalink

    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
    AbsSetting
  8. abstract def withDeprecationMessage(msg: String): InternalSetting.this.type

    Permalink
    Definition Classes
    AbsSetting
  9. abstract def withHelpSyntax(help: String): InternalSetting.this.type

    Permalink
    Definition Classes
    AbsSetting

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink

    Test two objects for inequality.

    Test two objects for inequality.

    returns

    true if !(this == that), false otherwise.

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink

    Equivalent to x.hashCode except for boxed numeric types and null.

    Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.

    returns

    a hash value consistent with ==

    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from InternalSetting to any2stringadd[InternalSetting] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (InternalSetting, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from InternalSetting to ArrowAssoc[InternalSetting] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. def <(that: Setting): Boolean

    Permalink
    Definition Classes
    Ordered
  6. def <=(that: Setting): Boolean

    Permalink
    Definition Classes
    Ordered
  7. final def ==(arg0: Any): Boolean

    Permalink

    The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    AnyRef → Any
  8. def >(that: Setting): Boolean

    Permalink
    Definition Classes
    Ordered
  9. def >=(that: Setting): Boolean

    Permalink
    Definition Classes
    Ordered
  10. def abbreviations: List[String]

    Permalink
    Definition Classes
    AbsSetting
  11. final def asInstanceOf[T0]: T0

    Permalink

    Cast the receiver object to be of type T0.

    Cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

    returns

    the receiver object.

    Definition Classes
    Any
    Exceptions thrown

    ClassCastException if the receiver object is not an instance of the erasure of type T0.

  12. def choices: List[String]

    Permalink
    Definition Classes
    AbsSetting
  13. def clone(): AnyRef

    Permalink

    Create a copy of the receiver object.

    Create a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
    Note

    not specified by SLS as a member of AnyRef

  14. def compare(that: Setting): Int

    Permalink
    Definition Classes
    AbsSetting → Ordered
  15. def compareTo(that: Setting): Int

    Permalink
    Definition Classes
    Ordered → Comparable
  16. def dependencies: List[(Setting, String)]

    Permalink
    Definition Classes
    AbsSetting
  17. def deprecationMessage: Option[String]

    Permalink
    Definition Classes
    AbsSetting
  18. def ensuring(cond: (InternalSetting) ⇒ Boolean, msg: ⇒ Any): InternalSetting

    Permalink
    Implicit information
    This member is added by an implicit conversion from InternalSetting to Ensuring[InternalSetting] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: (InternalSetting) ⇒ Boolean): InternalSetting

    Permalink
    Implicit information
    This member is added by an implicit conversion from InternalSetting to Ensuring[InternalSetting] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. def ensuring(cond: Boolean, msg: ⇒ Any): InternalSetting

    Permalink
    Implicit information
    This member is added by an implicit conversion from InternalSetting to Ensuring[InternalSetting] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. def ensuring(cond: Boolean): InternalSetting

    Permalink
    Implicit information
    This member is added by an implicit conversion from InternalSetting to Ensuring[InternalSetting] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. final def eq(arg0: AnyRef): Boolean

    Permalink

    Tests whether the argument (that) is a reference to the receiver object (this).

    Tests whether the argument (that) is a reference to the receiver object (this).

    The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:

    • It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
    • For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
    • null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    Definition Classes
    AnyRef
  23. def equals(that: Any): Boolean

    Permalink

    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.

    that

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    AbsSetting → AnyRef → Any
  24. def errorAndValue[T](msg: String, x: T): T

    Permalink

    Issue error and return

    Issue error and return

    Definition Classes
    AbsSetting
  25. def finalize(): Unit

    Permalink

    Called by the garbage collector on the receiver object when there are no more references to the object.

    Called by the garbage collector on the receiver object when there are no more references to the object.

    The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
    Note

    not specified by SLS as a member of AnyRef

  26. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from InternalSetting to StringFormat[InternalSetting] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  27. final def getClass(): Class[_]

    Permalink

    A representation that corresponds to the dynamic class of the receiver object.

    A representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    Definition Classes
    AnyRef → Any
    Note

    not specified by SLS as a member of AnyRef

  28. def hashCode(): Int

    Permalink

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in scala.Any.

    returns

    the hash code value for this object.

    Definition Classes
    AbsSetting → AnyRef → Any
  29. def helpSyntax: String

    Permalink
    Definition Classes
    AbsSetting
  30. def internalOnly(): InternalSetting.this.type

    Permalink
    Definition Classes
    AbsSetting
  31. def isAdvanced: Boolean

    Permalink

    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
  32. def isDeprecated: Boolean

    Permalink
    Definition Classes
    AbsSetting
  33. def isForDebug: Boolean

    Permalink
    Definition Classes
    AbsSetting
  34. final def isInstanceOf[T0]: Boolean

    Permalink

    Test whether the dynamic type of the receiver object is T0.

    Test whether the dynamic type of the receiver object is T0.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    Definition Classes
    Any
  35. def isInternalOnly: Boolean

    Permalink
    Definition Classes
    InternalSettingAbsSetting
  36. def isPrivate: Boolean

    Permalink
    Definition Classes
    AbsSetting
  37. def isStandard: Boolean

    Permalink
    Definition Classes
    AbsSetting
  38. final def ne(arg0: AnyRef): Boolean

    Permalink

    Equivalent to !(this eq that).

    Equivalent to !(this eq that).

    returns

    true if the argument is not a reference to the receiver object; false otherwise.

    Definition Classes
    AnyRef
  39. final def notify(): Unit

    Permalink

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  40. final def notifyAll(): Unit

    Permalink

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  41. def respondsTo(label: String): Boolean

    Permalink
    Definition Classes
    AbsSetting
  42. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  43. def toString(): String

    Permalink

    Creates a String representation of this object.

    Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

    returns

    a String representation of the object.

    Definition Classes
    AbsSetting → AnyRef → Any
  44. def tryToSetColon(args: List[String]): Option[ResultOfTryToSet]

    Permalink

    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[scala.tools.nsc]
    Definition Classes
    AbsSetting
  45. def tryToSetFromPropertyValue(s: String): Unit

    Permalink

    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
  46. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  49. def [B](y: B): (InternalSetting, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from InternalSetting to ArrowAssoc[InternalSetting] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. def <(that: InternalSetting): Boolean

    Permalink
    Implicit information
    This member is added by an implicit conversion from InternalSetting to math.Ordered[InternalSetting] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[InternalSetting] 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:
    (internalSetting: math.Ordered[InternalSetting]).<(that)
    Definition Classes
    Ordered
  2. def <=(that: InternalSetting): Boolean

    Permalink
    Implicit information
    This member is added by an implicit conversion from InternalSetting to math.Ordered[InternalSetting] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[InternalSetting] 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:
    (internalSetting: math.Ordered[InternalSetting]).<=(that)
    Definition Classes
    Ordered
  3. def >(that: InternalSetting): Boolean

    Permalink
    Implicit information
    This member is added by an implicit conversion from InternalSetting to math.Ordered[InternalSetting] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[InternalSetting] 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:
    (internalSetting: math.Ordered[InternalSetting]).>(that)
    Definition Classes
    Ordered
  4. def >=(that: InternalSetting): Boolean

    Permalink
    Implicit information
    This member is added by an implicit conversion from InternalSetting to math.Ordered[InternalSetting] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[InternalSetting] 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:
    (internalSetting: math.Ordered[InternalSetting]).>=(that)
    Definition Classes
    Ordered
  5. def compare(that: InternalSetting): Int

    Permalink
    Implicit information
    This member is added by an implicit conversion from InternalSetting to math.Ordered[InternalSetting] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[InternalSetting] 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:
    (internalSetting: math.Ordered[InternalSetting]).compare(that)
    Definition Classes
    Ordered
  6. def compareTo(that: InternalSetting): Int

    Permalink
    Implicit information
    This member is added by an implicit conversion from InternalSetting to math.Ordered[InternalSetting] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[InternalSetting] 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:
    (internalSetting: math.Ordered[InternalSetting]).compareTo(that)
    Definition Classes
    Ordered → Comparable

Inherited from AbsSetting

Inherited from math.Ordered[Setting]

Inherited from Comparable[Setting]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion orderingToOrdered from InternalSetting to math.Ordered[InternalSetting]

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

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

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

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

Ungrouped