class PathSetting extends StringSetting
- Alphabetic
- By Inheritance
- PathSetting
- StringSetting
- Setting
- Mutable
- SettingValue
- AbsSetting
- AbsSettingValue
- Ordered
- Comparable
- AnyRef
- Any
- by orderingToOrdered
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Type Members
-
type
T = String
- Definition Classes
- StringSetting → AbsSettingValue
Value Members
-
final
def
!=(arg0: Any): Boolean
Test two objects for inequality.
Test two objects for inequality.
- returns
true
if !(this == that), false otherwise.
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
Equivalent to
x.hashCode
except for boxed numeric types andnull
.Equivalent to
x.hashCode
except for boxed numeric types andnull
. 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. Fornull
returns a hashcode wherenull.hashCode
throws aNullPointerException
.- returns
a hash value consistent with ==
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from PathSetting to any2stringadd[PathSetting] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (PathSetting, B)
- Implicit
- This member is added by an implicit conversion from PathSetting to ArrowAssoc[PathSetting] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
def
<(that: Setting): Boolean
- Definition Classes
- Ordered
-
def
<=(that: Setting): Boolean
- Definition Classes
- Ordered
-
final
def
==(arg0: Any): Boolean
The expression
x == that
is equivalent toif (x eq null) that eq null else x.equals(that)
.The expression
x == that
is equivalent toif (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
-
def
>(that: Setting): Boolean
- Definition Classes
- Ordered
-
def
>=(that: Setting): Boolean
- Definition Classes
- Ordered
-
def
abbreviations: List[String]
- Definition Classes
- Setting → AbsSetting
- def append(s: String): Unit
-
val
arg: String
- Definition Classes
- StringSetting
-
final
def
asInstanceOf[T0]: T0
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 aClassCastException
at runtime, while the expressionList(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 typeT0
.
-
def
choices: List[String]
- Definition Classes
- AbsSetting
-
def
clone(): AnyRef
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
-
def
compare(that: Setting): Int
- Definition Classes
- AbsSetting → Ordered
-
def
compareTo(that: Setting): Int
- Definition Classes
- Ordered → Comparable
-
val
default: String
- Definition Classes
- StringSetting
-
def
dependencies: List[(Setting, String)]
- Definition Classes
- Setting → AbsSetting
-
def
dependsOn(s: Setting, value: String): PathSetting.this.type
- Definition Classes
- Setting
-
def
deprecationMessage: Option[String]
- Definition Classes
- Setting → AbsSetting
-
def
ensuring(cond: (PathSetting) ⇒ Boolean, msg: ⇒ Any): PathSetting
- Implicit
- This member is added by an implicit conversion from PathSetting to Ensuring[PathSetting] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (PathSetting) ⇒ Boolean): PathSetting
- Implicit
- This member is added by an implicit conversion from PathSetting to Ensuring[PathSetting] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): PathSetting
- Implicit
- This member is added by an implicit conversion from PathSetting to Ensuring[PathSetting] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): PathSetting
- Implicit
- This member is added by an implicit conversion from PathSetting to Ensuring[PathSetting] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
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 ofAnyRef
, and has three additional properties:- It is consistent: for any non-null instances
x
andy
of typeAnyRef
, multiple invocations ofx.eq(y)
consistently returnstrue
or consistently returnsfalse
. - For any non-null instance
x
of typeAnyRef
,x.eq(null)
andnull.eq(x)
returnsfalse
. null.eq(null)
returnstrue
.
When overriding the
equals
orhashCode
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
- It is consistent: for any non-null instances
-
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.
- 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
-
def
errorAndValue[T](msg: String, x: T): T
Issue error and return
Issue error and return
- Definition Classes
- AbsSetting
-
def
finalize(): Unit
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 betweenfinalize
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
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from PathSetting to StringFormat[PathSetting] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
Returns the runtime class representation of the object.
Returns the runtime class representation of the object.
- returns
a class object corresponding to the runtime type of the receiver.
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
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
-
val
helpDescription: String
- Definition Classes
- Setting → AbsSetting
-
def
helpSyntax: String
- Definition Classes
- Setting → AbsSetting
-
def
internalOnly(): PathSetting.this.type
- Definition Classes
- AbsSetting
-
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
-
def
isDefault: Boolean
- Definition Classes
- PathSetting → SettingValue → AbsSettingValue
-
def
isDeprecated: Boolean
- Definition Classes
- AbsSetting
-
def
isForDebug: Boolean
- Definition Classes
- AbsSetting
-
final
def
isInstanceOf[T0]: Boolean
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 returnfalse
, while the expressionList(1).isInstanceOf[List[String]]
will returntrue
. 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 typeT0
;false
otherwise.
- 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
-
val
name: String
- Definition Classes
- Setting → AbsSetting
-
final
def
ne(arg0: AnyRef): Boolean
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
-
final
def
notify(): Unit
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
-
final
def
notifyAll(): Unit
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
-
def
postSetHook(): Unit
- Definition Classes
- Setting → SettingValue
- def prepend(s: String): Unit
-
def
respondsTo(label: String): Boolean
- Definition Classes
- AbsSetting
-
var
setByUser: Boolean
- Attributes
- protected
- Definition Classes
- SettingValue
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
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
-
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
-
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[scala.tools.nsc]
- Definition Classes
- AbsSetting
-
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
unparse: List[String]
- Definition Classes
- StringSetting → AbsSetting
-
var
v: T
- Attributes
- protected
- Definition Classes
- StringSetting → SettingValue
-
def
value: String
- Definition Classes
- PathSetting → 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( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
withAbbreviation(s: String): PathSetting.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
-
def
withDeprecationMessage(msg: String): PathSetting.this.type
- Definition Classes
- Setting → AbsSetting
-
def
withHelpSyntax(s: String): PathSetting.this.type
- Definition Classes
- Setting → AbsSetting
-
def
withPostSetHook(f: (PathSetting.this.type) ⇒ Unit): PathSetting.this.type
- Definition Classes
- Setting
-
def
→[B](y: B): (PathSetting, B)
- Implicit
- This member is added by an implicit conversion from PathSetting to ArrowAssoc[PathSetting] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
Shadowed Implicit Value Members
-
def
<(that: PathSetting): Boolean
- Implicit
- This member is added by an implicit conversion from PathSetting to math.Ordered[PathSetting] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[PathSetting] 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:(pathSetting: math.Ordered[PathSetting]).<(that)
- Definition Classes
- Ordered
-
def
<=(that: PathSetting): Boolean
- Implicit
- This member is added by an implicit conversion from PathSetting to math.Ordered[PathSetting] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[PathSetting] 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:(pathSetting: math.Ordered[PathSetting]).<=(that)
- Definition Classes
- Ordered
-
def
>(that: PathSetting): Boolean
- Implicit
- This member is added by an implicit conversion from PathSetting to math.Ordered[PathSetting] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[PathSetting] 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:(pathSetting: math.Ordered[PathSetting]).>(that)
- Definition Classes
- Ordered
-
def
>=(that: PathSetting): Boolean
- Implicit
- This member is added by an implicit conversion from PathSetting to math.Ordered[PathSetting] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[PathSetting] 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:(pathSetting: math.Ordered[PathSetting]).>=(that)
- Definition Classes
- Ordered
-
def
compare(that: PathSetting): Int
- Implicit
- This member is added by an implicit conversion from PathSetting to math.Ordered[PathSetting] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[PathSetting] 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:(pathSetting: math.Ordered[PathSetting]).compare(that)
- Definition Classes
- Ordered
-
def
compareTo(that: PathSetting): Int
- Implicit
- This member is added by an implicit conversion from PathSetting to math.Ordered[PathSetting] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[PathSetting] 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:(pathSetting: math.Ordered[PathSetting]).compareTo(that)
- Definition Classes
- Ordered → Comparable
The Scala compiler API.
The following resources are useful for Scala plugin/compiler development: