Scala Standard Library2.12.3-1 < Back
 

# Packages

-  package root

  This is the documentation for the Scala standard library.

  This is the documentation for the Scala standard library.

  #### Package structure

  The scala package contains core types like `Int`, `Float`, `Array` or `Option` which are accessible in all Scala compilation units without explicit qualification or imports.

  Notable packages include:

  - `scala.collection` and its sub-packages contain Scala's collections framework
    - `scala.collection.immutable` - Immutable, sequential data-structures such as `Vector`, `List`, `Range`, `HashMap` or `HashSet`
    - `scala.collection.mutable` - Mutable, sequential data-structures such as `ArrayBuffer`, `StringBuilder`, `HashMap` or `HashSet`
    - `scala.collection.concurrent` - Mutable, concurrent data-structures such as `TrieMap`
    - `scala.collection.parallel.immutable` - Immutable, parallel data-structures such as `ParVector`, `ParRange`, `ParHashMap` or `ParHashSet`
    - `scala.collection.parallel.mutable` - Mutable, parallel data-structures such as `ParArray`, `ParHashMap`, `ParTrieMap` or `ParHashSet`
  - `scala.concurrent` - Primitives for concurrent programming such as `Futures` and `Promises`
  - `scala.io` - Input and output operations
  - `scala.math` - Basic math functions and additional numeric types like `BigInt` and `BigDecimal`
  - `scala.sys` - Interaction with other processes and the operating system
  - `scala.util.matching` - Regular expressions

  Other 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.Predef` object are always in scope by default.

  Some of these identifiers are type aliases provided as shortcuts to commonly used classes. For example, `List` is an alias for `scala.collection.immutable.List`.

  Other aliases refer to classes provided by the underlying platform. For example, on the JVM, `String` is an alias for `java.lang.String`.

  Definition Classes
    root
-  package scala

  Core Scala types.

  Core Scala types. They are always available without an explicit import.

  Definition Classes
    root
-  package runtime
  Definition Classes
    scala
- AbstractFunction0
- AbstractFunction1
- AbstractFunction10
- AbstractFunction11
- AbstractFunction12
- AbstractFunction13
- AbstractFunction14
- AbstractFunction15
- AbstractFunction16
- AbstractFunction17
- AbstractFunction18
- AbstractFunction19
- AbstractFunction2
- AbstractFunction20
- AbstractFunction21
- AbstractFunction22
- AbstractFunction3
- AbstractFunction4
- AbstractFunction5
- AbstractFunction6
- AbstractFunction7
- AbstractFunction8
- AbstractFunction9
- AbstractPartialFunction
- ArrayCharSequence
- FractionalProxy
- IntegralProxy
- LambdaDeserializer
- LazyBoolean
- LazyByte
- LazyChar
- LazyDouble
- LazyFloat
- LazyInt
- LazyLong
- LazyRef
- LazyShort
- LazyUnit
- NonLocalReturnControl
- OrderedProxy
- RangedProxy
- RichBoolean
- RichByte
- RichChar
- RichDouble
- RichException
- RichFloat
- RichInt
- RichLong
- RichShort
- ScalaNumberProxy
- ScalaWholeNumberProxy
- SeqCharSequence
- StringFormat
- Tuple2Zipped
- Tuple3Zipped
- ZippedTraversable2
- ZippedTraversable3

t

scala.runtime

# OrderedProxy 

###

#### trait OrderedProxy[T] extends Ordered[T] with Typed[T]

Source
  ScalaNumberProxy.scala

Linear Supertypes
Typed[T], Proxy, math.Ordered[T], Comparable[T], Any
Known Subclasses
FractionalProxy, IntegralProxy, RichBoolean, RichByte, RichChar, RichDouble, RichFloat, RichInt, RichLong, RichShort, ScalaNumberProxy, ScalaWholeNumberProxy
Type Hierarchy
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. OrderedProxy
2. Typed
3. Proxy
4. Ordered
5. Comparable
6. 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

### Abstract Value Members

1.  abstract 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
     Any
2.  abstract def ord: Ordering[T]
   Attributes
     protected
3.  abstract def self: T
   Definition Classes
     Typed → Proxy

### Concrete Value Members

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

   Test two objects for inequality.

   Test two objects for inequality.

   returns

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

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

   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
     Any
3.  def +(other: String): String
   Implicit
     This member is added by an implicit conversion from OrderedProxy[T] to any2stringadd[OrderedProxy[T]] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (OrderedProxy[T], B)
   Implicit
     This member is added by an implicit conversion from OrderedProxy[T] to ArrowAssoc[OrderedProxy[T]] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  def <(that: T): Boolean

   Returns true if `this` is less than `that`

   Returns true if `this` is less than `that`

   Definition Classes
     Ordered
6.  def <=(that: T): Boolean

   Returns true if `this` is less than or equal to `that`.

   Returns true if `this` is less than or equal to `that`.

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

   Test two objects for equality.

   Test two objects for equality. 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
     Any
8.  def >(that: T): Boolean

   Returns true if `this` is greater than `that`.

   Returns true if `this` is greater than `that`.

   Definition Classes
     Ordered
9.  def >=(that: T): Boolean

   Returns true if `this` is greater than or equal to `that`.

   Returns true if `this` is greater than or equal to `that`.

   Definition Classes
     Ordered
10.  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 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`.

11.  def compare(y: T): Int

    Result of comparing `this` with operand `that`.

    Result of comparing `this` with operand `that`.

    Implement this method to determine how instances of A will be sorted.

    Returns `x` where:

    - `x < 0` when `this < that`
    - `x == 0` when `this == that`
    - `x > 0` when `this > that`
    Definition Classes
      OrderedProxy → Ordered
12.  def compareTo(that: T): Int

    Result of comparing `this` with operand `that`.

    Result of comparing `this` with operand `that`.

    Definition Classes
      Ordered → Comparable
13.  def ensuring(cond: (OrderedProxy[T]) ⇒ Boolean, msg: ⇒ Any): OrderedProxy[T]
    Implicit
      This member is added by an implicit conversion from OrderedProxy[T] to Ensuring[OrderedProxy[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
14.  def ensuring(cond: (OrderedProxy[T]) ⇒ Boolean): OrderedProxy[T]
    Implicit
      This member is added by an implicit conversion from OrderedProxy[T] to Ensuring[OrderedProxy[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
15.  def ensuring(cond: Boolean, msg: ⇒ Any): OrderedProxy[T]
    Implicit
      This member is added by an implicit conversion from OrderedProxy[T] to Ensuring[OrderedProxy[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
16.  def ensuring(cond: Boolean): OrderedProxy[T]
    Implicit
      This member is added by an implicit conversion from OrderedProxy[T] to Ensuring[OrderedProxy[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
17.  def equals(that: Any): Boolean

    Compares the receiver object (`this`) with the argument object (`that`) for equivalence.

    Compares the receiver object (`this`) with the argument object (`that`) for equivalence.

    Any implementation of this method should be an equivalence relation:

    - It is reflexive: for any instance `x` of type `Any`, `x.equals(x)` should return `true`.
    - It is symmetric: for any instances `x` and `y` of type `Any`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`.
    - It is transitive: for any instances `x`, `y`, and `z` of type `Any` if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override `hashCode` to ensure that objects which are "equal" (`o1.equals(o2)` returns `true`) hash to the same scala.Int. (`o1.hashCode.equals(o2.hashCode)`).

    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
      Proxy → Any
18.  def formatted(fmtstr: String): String

    Returns string formatted according to given `format` string.

    Returns string formatted according to given `format` string. Format strings are as for `String.format` (@see java.lang.String.format).

    Implicit
      This member is added by an implicit conversion from OrderedProxy[T] to Predef.StringFormat[OrderedProxy[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
      StringFormat
    Annotations
      @inline()
19.  def hashCode(): Int

    Calculate a hash code value for the object.

    Calculate a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (`o1.hashCode.equals(o2.hashCode)`) yet not be equal (`o1.equals(o2)` returns `false`). A degenerate implementation could always return `0`. However, it is required that if two objects are equal (`o1.equals(o2)` returns `true`) that they have identical hash codes (`o1.hashCode.equals(o2.hashCode)`). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the `equals` method.

    returns

      the hash code value for this object.

    Definition Classes
      Proxy → Any
20.  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 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
21.  def toString(): String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

      a string representation of the object.

    Definition Classes
      Proxy → Any
22.  def →[B](y: B): (OrderedProxy[T], B)
    Implicit
      This member is added by an implicit conversion from OrderedProxy[T] to ArrowAssoc[OrderedProxy[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
      ArrowAssoc

### Shadowed Implicit Value Members

1.  def <(that: OrderedProxy[T]): Boolean

   Returns true if `this` is less than `that`

   Returns true if `this` is less than `that`

   Implicit
     This member is added by an implicit conversion from OrderedProxy[T] to math.Ordered[OrderedProxy[T]] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[OrderedProxy[T]] 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:

         (orderedProxy: math.Ordered[OrderedProxy[T]]).<(that)

   Definition Classes
     Ordered
2.  def <=(that: OrderedProxy[T]): Boolean

   Returns true if `this` is less than or equal to `that`.

   Returns true if `this` is less than or equal to `that`.

   Implicit
     This member is added by an implicit conversion from OrderedProxy[T] to math.Ordered[OrderedProxy[T]] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[OrderedProxy[T]] 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:

         (orderedProxy: math.Ordered[OrderedProxy[T]]).<=(that)

   Definition Classes
     Ordered
3.  def >(that: OrderedProxy[T]): Boolean

   Returns true if `this` is greater than `that`.

   Returns true if `this` is greater than `that`.

   Implicit
     This member is added by an implicit conversion from OrderedProxy[T] to math.Ordered[OrderedProxy[T]] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[OrderedProxy[T]] 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:

         (orderedProxy: math.Ordered[OrderedProxy[T]]).>(that)

   Definition Classes
     Ordered
4.  def >=(that: OrderedProxy[T]): Boolean

   Returns true if `this` is greater than or equal to `that`.

   Returns true if `this` is greater than or equal to `that`.

   Implicit
     This member is added by an implicit conversion from OrderedProxy[T] to math.Ordered[OrderedProxy[T]] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[OrderedProxy[T]] 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:

         (orderedProxy: math.Ordered[OrderedProxy[T]]).>=(that)

   Definition Classes
     Ordered
5.  def compare(that: OrderedProxy[T]): Int

   Result of comparing `this` with operand `that`.

   Result of comparing `this` with operand `that`.

   Implement this method to determine how instances of A will be sorted.

   Returns `x` where:

   - `x < 0` when `this < that`
   - `x == 0` when `this == that`
   - `x > 0` when `this > that`
   Implicit
     This member is added by an implicit conversion from OrderedProxy[T] to math.Ordered[OrderedProxy[T]] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[OrderedProxy[T]] 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:

         (orderedProxy: math.Ordered[OrderedProxy[T]]).compare(that)

   Definition Classes
     Ordered
6.  def compareTo(that: OrderedProxy[T]): Int

   Result of comparing `this` with operand `that`.

   Result of comparing `this` with operand `that`.

   Implicit
     This member is added by an implicit conversion from OrderedProxy[T] to math.Ordered[OrderedProxy[T]] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[OrderedProxy[T]] 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:

         (orderedProxy: math.Ordered[OrderedProxy[T]]).compareTo(that)

   Definition Classes
     Ordered → Comparable

### Inherited from Typed[T]

### Inherited from Proxy

### Inherited from math.Ordered[T]

### Inherited from Comparable[T]

### Inherited from Any

### Inherited by implicit conversion orderingToOrdered from OrderedProxy[T] to math.Ordered[OrderedProxy[T]]

### Inherited by implicit conversion any2stringadd from OrderedProxy[T] to any2stringadd[OrderedProxy[T]]

### Inherited by implicit conversion StringFormat from OrderedProxy[T] to Predef.StringFormat[OrderedProxy[T]]

### Inherited by implicit conversion Ensuring from OrderedProxy[T] to Ensuring[OrderedProxy[T]]

### Inherited by implicit conversion ArrowAssoc from OrderedProxy[T] to ArrowAssoc[OrderedProxy[T]]

### Ungrouped