Packages

trait ClassTag[T] extends ClassManifestDeprecatedApis[T] with Equals with Serializable

A ClassTag[T] stores the erased class of a given type T, accessible via the runtimeClass field. This is particularly useful for instantiating Arrays whose element types are unknown at compile time.

ClassTags are a weaker special case of scala.reflect.api.TypeTags.TypeTags, in that they wrap only the runtime class of a given type, whereas a TypeTag contains all static type information. That is, ClassTags are constructed from knowing only the top-level class of a type, without necessarily knowing all of its argument types. This runtime information is enough for runtime Array creation.

For example:

scala> def mkArray[T : ClassTag](elems: T*) = Array[T](elems: _*)
mkArray: [T](elems: T*)(implicit evidence$1: scala.reflect.ClassTag[T])Array[T]

scala> mkArray(42, 13)
res0: Array[Int] = Array(42, 13)

scala> mkArray("Japan","Brazil","Germany")
res1: Array[String] = Array(Japan, Brazil, Germany)

See scala.reflect.api.TypeTags for more examples, or the Reflection Guide: TypeTags for more details.

Annotations
@nowarn() @implicitNotFound()
Source
ClassTag.scala
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClassTag
  2. Equals
  3. ClassManifestDeprecatedApis
  4. OptManifest
  5. Serializable
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def runtimeClass: Class[_]

    A class representing the type U to which T would be erased.

    A class representing the type U to which T would be erased. Note that there is no subtyping relationship between T and U.

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

    The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    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
    AnyRef → Any
  6. def argString: String
    Attributes
    protected
    Definition Classes
    ClassManifestDeprecatedApis
  7. def arrayClass[A](tp: Class[_]): Class[Array[A]]
    Attributes
    protected
    Definition Classes
    ClassManifestDeprecatedApis
  8. 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.

  9. def canEqual(x: Any): Boolean

    A method that should be called from every well-designed equals method that is open to be overridden in a subclass.

    A method that should be called from every well-designed equals method that is open to be overridden in a subclass. See Programming in Scala, Chapter 28 for discussion and design.

    returns

    true if this instance can possibly equal that, otherwise false

    Definition Classes
    ClassTagEqualsClassManifestDeprecatedApis
  10. def clone(): AnyRef

    Create a copy of the receiver object.

    Create a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
    Note

    not specified by SLS as a member of AnyRef

  11. def ensuring(cond: (ClassTag[T]) => Boolean, msg: => Any): ClassTag[T]
    Implicit
    This member is added by an implicit conversion from ClassTag[T] toEnsuring[ClassTag[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (ClassTag[T]) => Boolean): ClassTag[T]
    Implicit
    This member is added by an implicit conversion from ClassTag[T] toEnsuring[ClassTag[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: => Any): ClassTag[T]
    Implicit
    This member is added by an implicit conversion from ClassTag[T] toEnsuring[ClassTag[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): ClassTag[T]
    Implicit
    This member is added by an implicit conversion from ClassTag[T] toEnsuring[ClassTag[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. 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 of AnyRef, and has three additional properties:

    • It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
    • For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
    • null.eq(null) returns true.

    When overriding the equals or hashCode 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
  16. def equals(x: Any): Boolean

    The universal equality method defined in AnyRef.

    The universal equality method defined in AnyRef.

    Definition Classes
    ClassTagEquals → AnyRef → Any
  17. 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 between finalize 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

  18. final def getClass(): Class[_ <: AnyRef]

    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
    AnyRef → Any
    Annotations
    @native()
  19. 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
    ClassTag → AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object has the same erasure as T0.

    Test whether the dynamic type of the receiver object has the same erasure as T0.

    Depending on what T0 is, the test is done in one of the below ways:

    • T0 is a non-parameterized class type, e.g. BigDecimal: this method returns true if the value of the receiver object is a BigDecimal or a subtype of BigDecimal.
    • T0 is a parameterized class type, e.g. List[Int]: this method returns true if the value of the receiver object is some List[X] for any X. For example, List(1, 2, 3).isInstanceOf[List[String]] will return true.
    • T0 is some singleton type x.type or literal x: this method returns this.eq(x). For example, x.isInstanceOf[1] is equivalent to x.eq(1)
    • T0 is an intersection X with Y or X & Y: this method is equivalent to x.isInstanceOf[X] && x.isInstanceOf[Y]
    • T0 is a union X | Y: this method is equivalent to x.isInstanceOf[X] || x.isInstanceOf[Y]
    • T0 is a type parameter or an abstract type member: this method is equivalent to isInstanceOf[U] where U is T0's upper bound, Any if T0 is unbounded. For example, x.isInstanceOf[A] where A is an unbounded type parameter will return true for any value of x.

    This is exactly equivalent to the type pattern _: T0

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    Definition Classes
    Any
    Note

    due to the unexpectedness of List(1, 2, 3).isInstanceOf[List[String]] returning true and x.isInstanceOf[A] where A is a type parameter or abstract member returning true, these forms issue a warning.

  21. 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
  22. def newArray(len: Int): Array[T]

    Produces a new array with element type T and length len

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

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

  25. final def synchronized[T0](arg0: => T0): T0

    Executes the code in body with an exclusive lock on this.

    Executes the code in body with an exclusive lock on this.

    returns

    the result of body

    Definition Classes
    AnyRef
  26. 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
    ClassTag → AnyRef → Any
  27. def unapply(x: Any): Option[T]

    A ClassTag[T] can serve as an extractor that matches only objects of type T.

    A ClassTag[T] can serve as an extractor that matches only objects of type T.

    The compiler tries to turn unchecked type tests in pattern matches into checked ones by wrapping a (_: T) type pattern as ct(_: T), where ct is the ClassTag[T] instance. Type tests necessary before calling other extractors are treated similarly. SomeExtractor(...) is turned into ct(SomeExtractor(...)) if T in SomeExtractor.unapply(x: T) is uncheckable, but we have an instance of ClassTag[T].

  28. final def wait(): Unit

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--.

    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
    Note

    not specified by SLS as a member of AnyRef

  29. final def wait(arg0: Long, arg1: Int): Unit

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-

    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
    Note

    not specified by SLS as a member of AnyRef

  30. final def wait(arg0: Long): Unit

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-.

    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
    Note

    not specified by SLS as a member of AnyRef

  31. def wrap: ClassTag[Array[T]]

    Produces a ClassTag that knows how to instantiate an Array[Array[T]]

Deprecated Value Members

  1. def <:<(that: ClassManifest[_]): Boolean

    Tests whether the type represented by this manifest is a subtype of the type represented by that manifest, subject to the limitations described in the header.

    Tests whether the type represented by this manifest is a subtype of the type represented by that manifest, subject to the limitations described in the header.

    Definition Classes
    ClassManifestDeprecatedApis
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) use scala.reflect.runtime.universe.TypeTag for subtype checking instead

  2. def >:>(that: ClassManifest[_]): Boolean

    Tests whether the type represented by this manifest is a supertype of the type represented by that manifest, subject to the limitations described in the header.

    Tests whether the type represented by this manifest is a supertype of the type represented by that manifest, subject to the limitations described in the header.

    Definition Classes
    ClassManifestDeprecatedApis
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) use scala.reflect.runtime.universe.TypeTag for subtype checking instead

  3. def arrayManifest: ClassManifest[Array[T]]
    Definition Classes
    ClassManifestDeprecatedApis
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) use wrap instead

  4. def erasure: Class[_]
    Definition Classes
    ClassManifestDeprecatedApis
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) use runtimeClass instead

  5. 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 ClassTag[T] toStringFormat[ClassTag[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 of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  6. def newArray2(len: Int): Array[Array[T]]
    Definition Classes
    ClassManifestDeprecatedApis
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) use wrap.newArray instead

  7. def newArray3(len: Int): Array[Array[Array[T]]]
    Definition Classes
    ClassManifestDeprecatedApis
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) use wrap.wrap.newArray instead

  8. def newArray4(len: Int): Array[Array[Array[Array[T]]]]
    Definition Classes
    ClassManifestDeprecatedApis
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) use wrap.wrap.wrap.newArray instead

  9. def newArray5(len: Int): Array[Array[Array[Array[Array[T]]]]]
    Definition Classes
    ClassManifestDeprecatedApis
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) use wrap.wrap.wrap.wrap.newArray instead

  10. def newArrayBuilder(): ArrayBuilder[T]
    Definition Classes
    ClassManifestDeprecatedApis
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) use ArrayBuilder.make(this) instead

  11. def newWrappedArray(len: Int): ArraySeq[T]
    Definition Classes
    ClassManifestDeprecatedApis
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) create WrappedArray directly instead

  12. def typeArguments: List[OptManifest[_]]
    Definition Classes
    ClassManifestDeprecatedApis
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) use scala.reflect.runtime.universe.TypeTag to capture type structure instead

  13. def [B](y: B): (ClassTag[T], B)
    Implicit
    This member is added by an implicit conversion from ClassTag[T] toArrowAssoc[ClassTag[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Equals

Inherited from ClassManifestDeprecatedApis[T]

Inherited from OptManifest[T]

Inherited from java.io.Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromClassTag[T] to any2stringadd[ClassTag[T]]

Inherited by implicit conversion StringFormat fromClassTag[T] to StringFormat[ClassTag[T]]

Inherited by implicit conversion Ensuring fromClassTag[T] to Ensuring[ClassTag[T]]

Inherited by implicit conversion ArrowAssoc fromClassTag[T] to ArrowAssoc[ClassTag[T]]

Ungrouped