Packages

  • package root
    Definition Classes
    root
  • package scala
    Definition Classes
    root
  • package reflect
    Definition Classes
    scala
  • package macros

    EXPERIMENTAL

    EXPERIMENTAL

    The base package for Scala macros.

    Macros are functions that are called by the compiler during compilation. Within these functions the programmer has access to compiler APIs. For example, it is possible to generate, analyze and typecheck code.

    See the Macros Guide on how to get started with Scala macros.

    Definition Classes
    reflect
  • trait Enclosures extends AnyRef

    EXPERIMENTAL

    EXPERIMENTAL

    A slice of the Scala macros context that exposes enclosing trees (method, class, compilation unit and currently compiled macro application), the enclosing position of the macro expansion, as well as macros and implicits that are currently in-flight.

    Starting from Scala 2.11.0, the APIs to get the trees enclosing by the current macro application are deprecated, and the reasons for that are two-fold. Firstly, we would like to move towards the philosophy of locally-expanded macros, as it has proven to be important for understanding of code. Secondly, within the current architecture of scalac, we are unable to have c.enclosingTree-style APIs working robustly. Required changes to the typechecker would greatly exceed the effort that we would like to expend on this feature given the existence of more pressing concerns at the moment. This is somewhat aligned with the overall evolution of macros during the 2.11 development cycle, where we played with c.introduceTopLevel and c.introduceMember, but at the end of the day decided to reject them.

    If you're relying on the now deprecated APIs, consider using the new c.internal.enclosingOwner method that can be used to obtain the names of enclosing definitions. Alternatively try reformulating your macros in terms of completely local expansion and/or joining a discussion of a somewhat related potential language feature at https://groups.google.com/forum/#!topic/scala-debate/f4CLmYShX6Q. We also welcome questions and suggestions on our mailing lists, where we would be happy to further discuss this matter.

    Definition Classes
    macros
  • EnclosureException
c

scala.reflect.macros.Enclosures

EnclosureException

case class EnclosureException(expected: Class[_], enclosingTrees: List[blackbox.Context.Tree]) extends Exception with Product with Serializable

Indicates than one of the enclosure methods failed to find a tree of required type among enclosing trees.

Annotations
@deprecated
Deprecated

(Since version 2.11.0) c.enclosingTree-style APIs are now deprecated; consult the scaladoc for more information

Source
Enclosures.scala
See also

scala.reflect.macros.Enclosures

Linear Supertypes
Serializable, Product, Equals, java.lang.Exception, java.lang.Throwable, java.io.Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EnclosureException
  2. Serializable
  3. Product
  4. Equals
  5. Exception
  6. Throwable
  7. Serializable
  8. AnyRef
  9. Any
Implicitly
  1. by RichException
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new EnclosureException(expected: Class[_], enclosingTrees: List[blackbox.Context.Tree])

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 blackbox.Context.EnclosureException to any2stringadd[blackbox.Context.EnclosureException] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (blackbox.Context.EnclosureException, B)
    Implicit
    This member is added by an implicit conversion from blackbox.Context.EnclosureException to ArrowAssoc[blackbox.Context.EnclosureException] 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. final def addSuppressed(arg0: java.lang.Throwable): Unit
    Definition Classes
    Throwable
  7. 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.

  8. 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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
    Note

    not specified by SLS as a member of AnyRef

  9. val enclosingTrees: List[blackbox.Context.Tree]
  10. def ensuring(cond: (blackbox.Context.EnclosureException) ⇒ Boolean, msg: ⇒ Any): blackbox.Context.EnclosureException
    Implicit
    This member is added by an implicit conversion from blackbox.Context.EnclosureException to Ensuring[blackbox.Context.EnclosureException] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (blackbox.Context.EnclosureException) ⇒ Boolean): blackbox.Context.EnclosureException
    Implicit
    This member is added by an implicit conversion from blackbox.Context.EnclosureException to Ensuring[blackbox.Context.EnclosureException] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): blackbox.Context.EnclosureException
    Implicit
    This member is added by an implicit conversion from blackbox.Context.EnclosureException to Ensuring[blackbox.Context.EnclosureException] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): blackbox.Context.EnclosureException
    Implicit
    This member is added by an implicit conversion from blackbox.Context.EnclosureException to Ensuring[blackbox.Context.EnclosureException] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. 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
  15. val expected: Class[_]
  16. def fillInStackTrace(): java.lang.Throwable
    Definition Classes
    Throwable
  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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
    Note

    not specified by SLS as a member of AnyRef

  18. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from blackbox.Context.EnclosureException to StringFormat[blackbox.Context.EnclosureException] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. def getCause(): java.lang.Throwable
    Definition Classes
    Throwable
  20. final 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
    AnyRef → Any
  21. def getLocalizedMessage(): String
    Definition Classes
    Throwable
  22. def getMessage(): String
    Definition Classes
    Throwable
  23. def getStackTrace(): Array[StackTraceElement]
    Definition Classes
    Throwable
  24. final def getSuppressed(): Array[java.lang.Throwable]
    Definition Classes
    Throwable
  25. def initCause(arg0: java.lang.Throwable): java.lang.Throwable
    Definition Classes
    Throwable
  26. 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
  27. 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
  28. 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
    Note

    not specified by SLS as a member of AnyRef

  29. 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
    Note

    not specified by SLS as a member of AnyRef

  30. def printStackTrace(arg0: PrintWriter): Unit
    Definition Classes
    Throwable
  31. def printStackTrace(arg0: PrintStream): Unit
    Definition Classes
    Throwable
  32. def printStackTrace(): Unit
    Definition Classes
    Throwable
  33. def setStackTrace(arg0: Array[StackTraceElement]): Unit
    Definition Classes
    Throwable
  34. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  35. 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
    Throwable → AnyRef → Any
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. def [B](y: B): (blackbox.Context.EnclosureException, B)
    Implicit
    This member is added by an implicit conversion from blackbox.Context.EnclosureException to ArrowAssoc[blackbox.Context.EnclosureException] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def getStackTraceString: String
    Implicit
    This member is added by an implicit conversion from blackbox.Context.EnclosureException to RichException performed by method RichException in scala.Predef.
    Definition Classes
    RichException
    Annotations
    @deprecated
    Deprecated

    (Since version 2.11.0) Use Throwable#getStackTrace

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from java.lang.Exception

Inherited from java.lang.Throwable

Inherited from java.io.Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion RichException from blackbox.Context.EnclosureException to RichException

Inherited by implicit conversion any2stringadd from blackbox.Context.EnclosureException to any2stringadd[blackbox.Context.EnclosureException]

Inherited by implicit conversion StringFormat from blackbox.Context.EnclosureException to StringFormat[blackbox.Context.EnclosureException]

Inherited by implicit conversion Ensuring from blackbox.Context.EnclosureException to Ensuring[blackbox.Context.EnclosureException]

Inherited by implicit conversion ArrowAssoc from blackbox.Context.EnclosureException to ArrowAssoc[blackbox.Context.EnclosureException]

Ungrouped