Class scala.AnyVal

abstract  class AnyVal extends Any



AnyVal is the root class of all value types, which describe values not implemented as objects in the underlying host system. Value classes are specified in Scala Language Specification, section 12.2.
 The standard implementation includes nine AnyVal subtypes:
 scala.Double, scala.Float, scala.Long, scala.Int, scala.Char, scala.Short, and scala.Byte are the numeric value types.
 scala.Unit and scala.Boolean are the non-numeric value types.
 Other groupings:

The subrange types are scala.Byte, scala.Short, and scala.Char.
The integer types include the subrange types as well as scala.Int and scala.Long.
The floating point types are scala.Float and scala.Double.

Prior to Scala 2.10, AnyVal was a sealed trait. Beginning with Scala 2.10, however, it is possible to define a subclass of AnyVal called a user-defined value class which is treated specially by the compiler. Properly-defined user value classes provide a way to improve performance on user-defined types by avoiding object allocation at runtime, and by replacing virtual method invocations with static method invocations.
User-defined value classes which avoid object allocation...

must have a single val parameter that is the underlying runtime representation.
can define defs, but no vals, vars, or nested traitss, classes or objects.
typically extend no other trait apart from AnyVal.
cannot be used in type tests or pattern matching.
may not override equals or hashCode methods.

A minimal example:
class Wrapper(val underlying: Int) extends AnyVal {
  def foo: Wrapper = new Wrapper(underlying * 19)
}
It's important to note that user-defined value classes are limited, and in some circumstances, still must allocate a value class george02@example.org. These limitations and circumstances are explained in greater detail in the Value Classes and Universal Traits. 


Source
AnyVal.scala
Linear Supertypes
Any
Known Subclasses

UnapplySeqWrapper, Boolean, Byte, Char, Double, Float, UnliftOps, Int, Long, ElementWiseExtractor, ArrowAssoc, Ensuring, StringFormat, Short, Unit, ValueOf, ArrayOps, IterableOnceExtensionMethods, SizeCompareOps, UnapplySeqWrapper, Shape, StringOps, Deferrer, Partial, Deferrer, UnwrapOp, DoubleMult, DurationDouble, DurationInt, DurationLong, IntMult, LongMult, JavaDurationOps, ScalaDurationOps, RichBiConsumerAsFunction2, RichBiFunctionAsFunction2, RichBiPredicateAsFunction2, RichBinaryOperatorAsFunction2, RichBooleanSupplierAsFunction0, RichConsumerAsFunction1, RichDoubleBinaryOperatorAsFunction2, RichDoubleConsumerAsFunction1, RichDoubleFunctionAsFunction1, RichDoublePredicateAsFunction1, RichDoubleSupplierAsFunction0, RichDoubleToIntFunctionAsFunction1, RichDoubleToLongFunctionAsFunction1, RichDoubleUnaryOperatorAsFunction1, RichFunction0AsBooleanSupplier, RichFunction0AsDoubleSupplier, RichFunction0AsIntSupplier, RichFunction0AsLongSupplier, RichFunction0AsSupplier, RichFunction1AsConsumer, RichFunction1AsDoubleConsumer, RichFunction1AsDoubleFunction, RichFunction1AsDoublePredicate, RichFunction1AsDoubleToIntFunction, RichFunction1AsDoubleToLongFunction, RichFunction1AsDoubleUnaryOperator, RichFunction1AsFunction, RichFunction1AsIntConsumer, RichFunction1AsIntFunction, RichFunction1AsIntPredicate, RichFunction1AsIntToDoubleFunction, RichFunction1AsIntToLongFunction, RichFunction1AsIntUnaryOperator, RichFunction1AsLongConsumer, RichFunction1AsLongFunction, RichFunction1AsLongPredicate, RichFunction1AsLongToDoubleFunction, RichFunction1AsLongToIntFunction, RichFunction1AsLongUnaryOperator, RichFunction1AsPredicate, RichFunction1AsToDoubleFunction, RichFunction1AsToIntFunction, RichFunction1AsToLongFunction, RichFunction1AsUnaryOperator, RichFunction2AsBiConsumer, RichFunction2AsBiFunction, RichFunction2AsBiPredicate, RichFunction2AsBinaryOperator, RichFunction2AsDoubleBinaryOperator, RichFunction2AsIntBinaryOperator, RichFunction2AsLongBinaryOperator, RichFunction2AsObjDoubleConsumer, RichFunction2AsObjIntConsumer, RichFunction2AsObjLongConsumer, RichFunction2AsToDoubleBiFunction, RichFunction2AsToIntBiFunction, RichFunction2AsToLongBiFunction, RichFunctionAsFunction1, RichIntBinaryOperatorAsFunction2, RichIntConsumerAsFunction1, RichIntFunctionAsFunction1, RichIntPredicateAsFunction1, RichIntSupplierAsFunction0, RichIntToDoubleFunctionAsFunction1, RichIntToLongFunctionAsFunction1, RichIntUnaryOperatorAsFunction1, RichLongBinaryOperatorAsFunction2, RichLongConsumerAsFunction1, RichLongFunctionAsFunction1, RichLongPredicateAsFunction1, RichLongSupplierAsFunction0, RichLongToDoubleFunctionAsFunction1, RichLongToIntFunctionAsFunction1, RichLongUnaryOperatorAsFunction1, RichObjDoubleConsumerAsFunction2, RichObjIntConsumerAsFunction2, RichObjLongConsumerAsFunction2, RichPredicateAsFunction1, RichSupplierAsFunction0, RichToDoubleBiFunctionAsFunction2, RichToDoubleFunctionAsFunction1, RichToIntBiFunctionAsFunction2, RichToIntFunctionAsFunction1, RichToLongBiFunctionAsFunction2, RichToLongFunctionAsFunction1, RichUnaryOperatorAsFunction1, CompletionStageOps, FutureOps, RichOption, RichOptional, RichOptionalDouble, RichOptionalInt, RichOptionalLong, ChainingOps, MergeableEither, any2stringadd, SearchImpl





Instance Constructors

 new AnyVal()



Value Members

final  def !=(arg0: Any): Boolean


Test two objects for inequality. 

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


Definition Classes
Any



final  def ##(): Int


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



 def +(other: String): String


Implicit
This member is added by an implicit conversion from AnyVal toany2stringadd[AnyVal] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd


 def ->[B](y: B): (AnyVal, B)


Implicit
This member is added by an implicit conversion from AnyVal toArrowAssoc[AnyVal] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations

@inline() 


final  def ==(arg0: Any): Boolean


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



final  def asInstanceOf[T0]: 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.



 def ensuring(cond: (AnyVal) => Boolean, msg: => Any): AnyVal


Implicit
This member is added by an implicit conversion from AnyVal toEnsuring[AnyVal] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring


 def ensuring(cond: (AnyVal) => Boolean): AnyVal


Implicit
This member is added by an implicit conversion from AnyVal toEnsuring[AnyVal] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring


 def ensuring(cond: Boolean, msg: => Any): AnyVal


Implicit
This member is added by an implicit conversion from AnyVal toEnsuring[AnyVal] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring


 def ensuring(cond: Boolean): AnyVal


Implicit
This member is added by an implicit conversion from AnyVal toEnsuring[AnyVal] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring


 def equals(arg0: Any): Boolean



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)). 


returns
true if the receiver object is equivalent to the argument; false otherwise.


Definition Classes
Any



 def formatted(fmtstr: String): 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 AnyVal toStringFormat[AnyVal] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations

@inline() 



 def getClass(): Class[_ <: AnyVal]


Returns the runtime class representation of the object. 

returns
a class object corresponding to the runtime type of the receiver.


Definition Classes

AnyVal → Any




 def hashCode(): Int



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
Any



final  def isInstanceOf[T0]: Boolean



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



 def toString(): String



Returns a string representation of the object.
 The default representation is platform dependent. 


returns
a string representation of the object.


Definition Classes
Any






    
{'path': 'public/docs/scala~2.13_library/scala/anyval.html', 'source': 'DevDocs.IO'}