trait OptionOrdering[T] extends Ordering[Option[T]]
- Source
- Ordering.scala
- Alphabetic
- By Inheritance
- OptionOrdering
- Ordering
- PartialOrdering
- Equiv
- Serializable
- Serializable
- Comparator
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Type Members
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 OptionOrdering[T] to any2stringadd[OptionOrdering[T]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (OptionOrdering[T], B)
- Implicit
- This member is added by an implicit conversion from OptionOrdering[T] to ArrowAssoc[OptionOrdering[T]] 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(x: Option[T], y: Option[T]): Int
Returns an integer whose sign communicates how x compares to y.
Returns an integer whose sign communicates how x compares to y.
The result sign has the following meaning:
- negative if x < y
- positive if x > y
- zero otherwise (if x == y)
- Definition Classes
- OptionOrdering → Ordering → Comparator
-
def
ensuring(cond: (OptionOrdering[T]) ⇒ Boolean, msg: ⇒ Any): OptionOrdering[T]
- Implicit
- This member is added by an implicit conversion from OptionOrdering[T] to Ensuring[OptionOrdering[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (OptionOrdering[T]) ⇒ Boolean): OptionOrdering[T]
- Implicit
- This member is added by an implicit conversion from OptionOrdering[T] to Ensuring[OptionOrdering[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): OptionOrdering[T]
- Implicit
- This member is added by an implicit conversion from OptionOrdering[T] to Ensuring[OptionOrdering[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): OptionOrdering[T]
- Implicit
- This member is added by an implicit conversion from OptionOrdering[T] to Ensuring[OptionOrdering[T]] 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(obj: Any): Boolean
The equality method for reference types.
The equality method for reference types. Default implementation delegates to
eq.See also
equalsin scala.Any.- returns
trueif the receiver object is equivalent to the argument;falseotherwise.
- Definition Classes
- OptionOrdering → Comparator → AnyRef → Any
-
def
equiv(x: Option[T], y: Option[T]): Boolean
Return true if
x==yin the ordering.Return true if
x==yin the ordering.- Definition Classes
- Ordering → PartialOrdering → Equiv
-
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
-
final
def
getClass(): Class[_]
Returns the runtime class representation of the object.
-
def
gt(x: Option[T], y: Option[T]): Boolean
Return true if
x>yin the ordering.Return true if
x>yin the ordering.- Definition Classes
- Ordering → PartialOrdering
-
def
gteq(x: Option[T], y: Option[T]): Boolean
Return true if
x>=yin the ordering.Return true if
x>=yin the ordering.- Definition Classes
- Ordering → PartialOrdering
-
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
- OptionOrdering → AnyRef → Any
-
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
-
def
lt(x: Option[T], y: Option[T]): Boolean
Return true if
x<yin the ordering.Return true if
x<yin the ordering.- Definition Classes
- Ordering → PartialOrdering
-
def
lteq(x: Option[T], y: Option[T]): Boolean
Return true if
x<=yin the ordering.Return true if
x<=yin the ordering.- Definition Classes
- Ordering → PartialOrdering
-
def
max(x: Option[T], y: Option[T]): Option[T]
Return
xifx>=y, otherwisey.Return
xifx>=y, otherwisey.- Definition Classes
- Ordering
-
def
min(x: Option[T], y: Option[T]): Option[T]
Return
xifx<=y, otherwisey.Return
xifx<=y, otherwisey.- Definition Classes
- Ordering
-
implicit
def
mkOrderingOps(lhs: Option[T]): Ops
This implicit method augments
Twith the comparison operators defined inscala.math.Ordering.Ops.This implicit method augments
Twith the comparison operators defined inscala.math.Ordering.Ops.- Definition Classes
- Ordering
-
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
on[U](f: (U) ⇒ Option[T]): Ordering[U]
Given f, a function from U into T, creates an Ordering[U] whose compare function is equivalent to:
Given f, a function from U into T, creates an Ordering[U] whose compare function is equivalent to:
def compare(x:U, y:U) = Ordering[T].compare(f(x), f(y))- Definition Classes
- Ordering
-
def
reverse: Ordering[Option[T]]
Return the opposite ordering of this one.
Return the opposite ordering of this one.
- Definition Classes
- Ordering → PartialOrdering
-
def
reversed(): Comparator[Option[T]]
- Definition Classes
- Comparator
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
thenComparing[U <: Comparable[_ >: U]](arg0: java.util.function.Function[_ >: Option[T], _ <: U]): Comparator[Option[T]]
- Definition Classes
- Comparator
-
def
thenComparing[U](arg0: java.util.function.Function[_ >: Option[T], _ <: U], arg1: Comparator[_ >: U]): Comparator[Option[T]]
- Definition Classes
- Comparator
-
def
thenComparing(arg0: Comparator[_ >: Option[T]]): Comparator[Option[T]]
- Definition Classes
- Comparator
-
def
thenComparingDouble(arg0: ToDoubleFunction[_ >: Option[T]]): Comparator[Option[T]]
- Definition Classes
- Comparator
-
def
thenComparingInt(arg0: ToIntFunction[_ >: Option[T]]): Comparator[Option[T]]
- Definition Classes
- Comparator
-
def
thenComparingLong(arg0: ToLongFunction[_ >: Option[T]]): Comparator[Option[T]]
- Definition Classes
- Comparator
-
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
tryCompare(x: Option[T], y: Option[T]): Some[Int]
Returns whether a comparison between
xandyis defined, and if so the result ofcompare(x, y).Returns whether a comparison between
xandyis defined, and if so the result ofcompare(x, y).- Definition Classes
- Ordering → PartialOrdering
-
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): (OptionOrdering[T], B)
- Implicit
- This member is added by an implicit conversion from OptionOrdering[T] to ArrowAssoc[OptionOrdering[T]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
Deprecated Value Members
-
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 OptionOrdering[T] to StringFormat[OptionOrdering[T]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
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.