object RoundingMode extends Enumeration
- Source
- BigDecimal.scala
- Alphabetic
- By Inheritance
- RoundingMode
- Enumeration
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
class
Val extends Value with Serializable
A class implementing the scala.Enumeration.Value type.
A class implementing the scala.Enumeration.Value type. This class can be overridden to change the enumeration's naming and integer identification behaviour.
- Attributes
- protected
- Definition Classes
- Enumeration
- Annotations
- @SerialVersionUID()
-
abstract
class
Value extends Ordered[Value] with Serializable
The type of the enumerated values.
The type of the enumerated values.
- Definition Classes
- Enumeration
- Annotations
- @SerialVersionUID()
-
class
ValueSet extends AbstractSet[Value] with SortedSet[Value] with SortedSetLike[Value, ValueSet] with Serializable
A class for sets of values.
A class for sets of values. Iterating through this set will yield values in increasing order of their ids.
- Definition Classes
- Enumeration
- type RoundingMode = Value
Value Members
-
object
ValueOrdering extends Ordering[Value]
An ordering by id for values of this set
An ordering by id for values of this set
- Definition Classes
- Enumeration
-
object
ValueSet extends Serializable
A factory object for value sets
A factory object for value sets
- Definition Classes
- Enumeration
-
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
-
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
- val CEILING: Value
- val DOWN: Value
- val FLOOR: Value
- val HALF_DOWN: Value
- val HALF_EVEN: Value
- val HALF_UP: Value
- val UNNECESSARY: Value
- val UP: Value
-
final
def
Value(i: Int, name: String): Value
Creates a fresh value, part of this enumeration, called
name
and identified by the integeri
.Creates a fresh value, part of this enumeration, called
name
and identified by the integeri
.- i
An integer that identifies this value at run-time. It must be unique amongst all values of the enumeration.
- name
A human-readable name for that value.
- returns
Fresh value with the provided identifier
i
and namename
.
- Attributes
- protected
- Definition Classes
- Enumeration
-
final
def
Value(name: String): Value
Creates a fresh value, part of this enumeration, called
name
.Creates a fresh value, part of this enumeration, called
name
.- name
A human-readable name for that value.
- returns
Fresh value called
name
.
- Attributes
- protected
- Definition Classes
- Enumeration
-
final
def
Value(i: Int): Value
Creates a fresh value, part of this enumeration, identified by the integer
i
.Creates a fresh value, part of this enumeration, identified by the integer
i
.- i
An integer that identifies this value at run-time. It must be unique amongst all values of the enumeration.
- returns
Fresh value identified by
i
.
- Attributes
- protected
- Definition Classes
- Enumeration
-
final
def
Value: Value
Creates a fresh value, part of this enumeration.
Creates a fresh value, part of this enumeration.
- Attributes
- protected
- Definition Classes
- Enumeration
-
final
def
apply(x: Int): Value
The value of this enumeration with given id
x
The value of this enumeration with given id
x
- Definition Classes
- Enumeration
-
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
clone(): AnyRef
Create a copy of the receiver object.
-
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(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
finalize
method is invoked, as well as the interaction betweenfinalize
and 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
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
true
if the receiver object is an instance of erasure of typeT0
;false
otherwise.
- Definition Classes
- Any
-
final
def
maxId: Int
The one higher than the highest integer amongst those used to identify values in this enumeration.
The one higher than the highest integer amongst those used to identify values in this enumeration.
- Definition Classes
- Enumeration
-
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
-
var
nextId: Int
The integer to use to identify the next created value.
The integer to use to identify the next created value.
- Attributes
- protected
- Definition Classes
- Enumeration
-
var
nextName: Iterator[String]
The string to use to name the next created value.
The string to use to name the next created value.
- Attributes
- protected
- Definition Classes
- Enumeration
-
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
readResolve(): AnyRef
- Attributes
- protected
- Definition Classes
- Enumeration
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
The name of this enumeration.
The name of this enumeration.
- returns
a String representation of the object.
- Definition Classes
- Enumeration → AnyRef → Any
-
def
values: ValueSet
The values of this enumeration as a set.
The values of this enumeration as a set.
- Definition Classes
- Enumeration
-
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
-
final
def
withName(s: String): Value
Return a
Value
from thisEnumeration
whose name matches the arguments
.Return a
Value
from thisEnumeration
whose name matches the arguments
. The names are determined automatically via reflection.- s
an
Enumeration
name- returns
the
Value
of thisEnumeration
if its name matchess
- Definition Classes
- Enumeration
- Exceptions thrown
NoSuchElementException
if noValue
with a matching name is in thisEnumeration
This is the documentation for the Scala standard library.
Package structure
The scala package contains core types like
Int
,Float
,Array
orOption
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 frameworkscala.collection.immutable
- Immutable, sequential data-structures such asVector
,List
,Range
,HashMap
orHashSet
scala.collection.mutable
- Mutable, sequential data-structures such asArrayBuffer
,StringBuilder
,HashMap
orHashSet
scala.collection.concurrent
- Mutable, concurrent data-structures such asTrieMap
scala.collection.parallel.immutable
- Immutable, parallel data-structures such asParVector
,ParRange
,ParHashMap
orParHashSet
scala.collection.parallel.mutable
- Mutable, parallel data-structures such asParArray
,ParHashMap
,ParTrieMap
orParHashSet
scala.concurrent
- Primitives for concurrent programming such asFutures
andPromises
scala.io
- Input and output operationsscala.math
- Basic math functions and additional numeric types likeBigInt
andBigDecimal
scala.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.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 forscala.collection.immutable.List
.Other aliases refer to classes provided by the underlying platform. For example, on the JVM,
String
is an alias forjava.lang.String
.