scala.annotation

compileTimeOnly

final class compileTimeOnly extends Annotation with StaticAnnotation

An annotation that designates that an annottee should not be referred to after type checking (which includes macro expansion).

Examples of potential use: 1) The annottee can only appear in the arguments of some other macro that will eliminate it from the AST during expansion. 2) The annottee is a macro and should have been expanded away, so if hasn't, something wrong has happened. (Comes in handy to provide better support for new macro flavors, e.g. macro annotations, that can't be expanded by the vanilla compiler).

Annotations
@getter() @setter() @beanGetter() @beanSetter() @companionClass() @companionMethod()
Since

2.11.0

Linear Supertypes
StaticAnnotation, Annotation, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. compileTimeOnly
  2. StaticAnnotation
  3. Annotation
  4. AnyRef
  5. Any
Implicitly
  1. by StringAdd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new compileTimeOnly(message: String)

    message

    the error message to print during compilation if a reference remains after type checking

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from compileTimeOnly to StringAdd[compileTimeOnly] performed by method StringAdd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): (compileTimeOnly, B)

    Implicit information
    This member is added by an implicit conversion from compileTimeOnly to ArrowAssoc[compileTimeOnly] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  10. def ensuring(cond: (compileTimeOnly) ⇒ Boolean, msg: ⇒ Any): compileTimeOnly

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

  11. def ensuring(cond: (compileTimeOnly) ⇒ Boolean): compileTimeOnly

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

  12. def ensuring(cond: Boolean, msg: ⇒ Any): compileTimeOnly

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

  13. def ensuring(cond: Boolean): compileTimeOnly

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

  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  15. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  16. def finalize(): Unit

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

  17. 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 information
    This member is added by an implicit conversion from compileTimeOnly to StringFormat[compileTimeOnly] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

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

    Definition Classes
    AnyRef → Any

  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  21. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  22. final def notify(): Unit

    Definition Classes
    AnyRef

  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  25. def toString(): String

    Definition Classes
    AnyRef → Any

  26. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. def →[B](y: B): (compileTimeOnly, B)

    Implicit information
    This member is added by an implicit conversion from compileTimeOnly to ArrowAssoc[compileTimeOnly] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from StaticAnnotation

Inherited from Annotation

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringAdd from compileTimeOnly to StringAdd[compileTimeOnly]

Inherited by implicit conversion StringFormat from compileTimeOnly to StringFormat[compileTimeOnly]

Inherited by implicit conversion Ensuring from compileTimeOnly to Ensuring[compileTimeOnly]

Inherited by implicit conversion ArrowAssoc from compileTimeOnly to ArrowAssoc[compileTimeOnly]

Ungrouped