trait Sorted[K, +This <: Sorted[K, This]] extends AnyRef
Any collection (including maps) whose keys (or elements) are ordered.
- Source
- Sorted.scala
- Since
2.8
- Alphabetic
- By Inheritance
- Sorted
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
firstKey: K
Returns the first key of the collection.
-
abstract
def
keySet: SortedSet[K]
return as a projection the set of keys in this collection
-
abstract
def
keysIteratorFrom(start: K): Iterator[K]
Creates an iterator over all the keys(or elements) contained in this collection greater than or equal to
startaccording to the ordering of this collection.Creates an iterator over all the keys(or elements) contained in this collection greater than or equal to
startaccording to the ordering of this collection. x.keysIteratorFrom(y) is equivalent to but often more efficient than x.from(y).keysIterator.- start
The lower bound (inclusive) on the keys to be returned
-
abstract
def
lastKey: K
Returns the last key of the collection.
- abstract def ordering: Ordering[K]
-
abstract
def
rangeImpl(from: Option[K], until: Option[K]): This
Creates a ranged projection of this collection.
Creates a ranged projection of this collection. Any mutations in the ranged projection will update this collection and vice versa.
Note: keys are not guaranteed to be consistent between this collection and the projection. This is the case for buffers where indexing is relative to the projection.
- from
The lower-bound (inclusive) of the ranged projection.
Noneif there is no lower bound.- until
The upper-bound (exclusive) of the ranged projection.
Noneif there is no upper bound.
-
abstract
def
repr: This
The current collection
The current collection
- Attributes
- protected
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
Test two objects for inequality.
Test two objects for inequality.
- returns
trueif !(this == that), false otherwise.
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
Equivalent to
x.hashCodeexcept for boxed numeric types andnull.Equivalent to
x.hashCodeexcept 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. Fornullreturns a hashcode wherenull.hashCodethrows 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 Sorted[K, This] to any2stringadd[Sorted[K, This]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (Sorted[K, This], B)
- Implicit
- This member is added by an implicit conversion from Sorted[K, This] to ArrowAssoc[Sorted[K, This]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
The expression
x == thatis equivalent toif (x eq null) that eq null else x.equals(that).The expression
x == thatis equivalent toif (x eq null) that eq null else x.equals(that).- returns
trueif the receiver object is equivalent to the argument;falseotherwise.
- Definition Classes
- AnyRef → Any
-
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 aClassCastExceptionat 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
ClassCastExceptionif the receiver object is not an instance of the erasure of typeT0.
-
def
clone(): AnyRef
Create a copy of the receiver object.
-
def
compare(k0: K, k1: K): Int
Comparison function that orders keys.
-
def
ensuring(cond: (Sorted[K, This]) ⇒ Boolean, msg: ⇒ Any): Sorted[K, This]
- Implicit
- This member is added by an implicit conversion from Sorted[K, This] to Ensuring[Sorted[K, This]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (Sorted[K, This]) ⇒ Boolean): Sorted[K, This]
- Implicit
- This member is added by an implicit conversion from Sorted[K, This] to Ensuring[Sorted[K, This]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): Sorted[K, This]
- Implicit
- This member is added by an implicit conversion from Sorted[K, This] to Ensuring[Sorted[K, This]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): Sorted[K, This]
- Implicit
- This member is added by an implicit conversion from Sorted[K, This] to Ensuring[Sorted[K, This]] 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
eqmethod implements an equivalence relation on non-null instances ofAnyRef, and has three additional properties:- It is consistent: for any non-null instances
xandyof typeAnyRef, multiple invocations ofx.eq(y)consistently returnstrueor consistently returnsfalse. - For any non-null instance
xof typeAnyRef,x.eq(null)andnull.eq(x)returnsfalse. null.eq(null)returnstrue.
When overriding the
equalsorhashCodemethods, 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
trueif the argument is a reference to the receiver object;falseotherwise.
- Definition Classes
- AnyRef
- It is consistent: for any non-null instances
-
def
equals(arg0: Any): Boolean
The equality method for reference types.
-
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
finalizemethod is invoked, as well as the interaction betweenfinalizeand non-local returns and exceptions, are all platform dependent.- Attributes
- protected[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
Returns string formatted according to given
formatstring.Returns string formatted according to given
formatstring. Format strings are as forString.format(@see java.lang.String.format).- Implicit
- This member is added by an implicit conversion from Sorted[K, This] to StringFormat[Sorted[K, This]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
def
from(from: K): This
Creates a ranged projection of this collection with no upper-bound.
Creates a ranged projection of this collection with no upper-bound.
- from
The lower-bound (inclusive) of the ranged projection.
-
final
def
getClass(): Class[_]
Returns the runtime class representation of the object.
-
def
hasAll(j: Iterator[K]): Boolean
- Attributes
- protected
-
def
hashCode(): Int
The hashCode method for reference types.
-
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
trueif the receiver object is an instance of erasure of typeT0;falseotherwise.
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
Equivalent to
!(this eq that).Equivalent to
!(this eq that).- returns
trueif the argument is not a reference to the receiver object;falseotherwise.
- 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
- Annotations
- @native()
- 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
- Annotations
- @native()
- Note
not specified by SLS as a member of AnyRef
-
def
range(from: K, until: K): This
Creates a ranged projection of this collection with both a lower-bound and an upper-bound.
Creates a ranged projection of this collection with both a lower-bound and an upper-bound.
- from
The lower-bound (inclusive) of the ranged projection.
- until
The upper-bound (exclusive) of the ranged projection.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
to(to: K): This
Create a range projection of this collection with no lower-bound.
Create a range projection of this collection with no lower-bound.
- to
The upper-bound (inclusive) of the ranged projection.
-
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
- AnyRef → Any
-
def
until(until: K): This
Creates a ranged projection of this collection with no lower-bound.
Creates a ranged projection of this collection with no lower-bound.
- until
The upper-bound (exclusive) of the ranged projection.
-
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
-
def
→[B](y: B): (Sorted[K, This], B)
- Implicit
- This member is added by an implicit conversion from Sorted[K, This] to ArrowAssoc[Sorted[K, This]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
This is the documentation for the Scala standard library.
Package structure
The scala package contains core types like
Int,Float,ArrayorOptionwhich are accessible in all Scala compilation units without explicit qualification or imports.Notable packages include:
scala.collectionand its sub-packages contain Scala's collections frameworkscala.collection.immutable- Immutable, sequential data-structures such asVector,List,Range,HashMaporHashSetscala.collection.mutable- Mutable, sequential data-structures such asArrayBuffer,StringBuilder,HashMaporHashSetscala.collection.concurrent- Mutable, concurrent data-structures such asTrieMapscala.collection.parallel.immutable- Immutable, parallel data-structures such asParVector,ParRange,ParHashMaporParHashSetscala.collection.parallel.mutable- Mutable, parallel data-structures such asParArray,ParHashMap,ParTrieMaporParHashSetscala.concurrent- Primitives for concurrent programming such asFuturesandPromisesscala.io- Input and output operationsscala.math- Basic math functions and additional numeric types likeBigIntandBigDecimalscala.sys- Interaction with other processes and the operating systemscala.util.matching- Regular expressionsOther packages exist. See the complete list on the right.
Additional parts of the standard library are shipped as separate libraries. These include:
scala.reflect- Scala's reflection API (scala-reflect.jar)scala.xml- XML parsing, manipulation, and serialization (scala-xml.jar)scala.swing- A convenient wrapper around Java's GUI framework called Swing (scala-swing.jar)scala.util.parsing- Parser combinators (scala-parser-combinators.jar)Automatic imports
Identifiers in the scala package and the
scala.Predefobject are always in scope by default.Some of these identifiers are type aliases provided as shortcuts to commonly used classes. For example,
Listis an alias forscala.collection.immutable.List.Other aliases refer to classes provided by the underlying platform. For example, on the JVM,
Stringis an alias forjava.lang.String.