CODEWITHSUNDEEP
scala
Landon Kuhn
Landon Kuhn

Reputation: 78421

How to define and use custom annotations in Scala

I am trying use a custom annotation in Scala. In this example, I create a string that I want to annotate with metadata (in this case, another string). Then, given an instance of the data, and I want to read the annotation.

scala> case class named(name: String) extends scala.annotation.StaticAnnotation
defined class named

scala> @named("Greeting") val v = "Hello"
v: String = Hello

scala> def valueToName(x: String): String = ???
valueToName: (x: String)String

scala> valueToName(v) // returns "Greeting"

Is this even possible?

Upvotes: 16

Views: 11271

Answers (2)

Remi Thieblin
Remi Thieblin

Reputation: 186

With scala 2.11.6, this works to extract values of a annotation:

case class Named(name: String) extends scala.annotation.StaticAnnotation

val myAnnotatedClass: ClassSymbol = u.runtimeMirror(Thread.currentThread().getContextClassLoader).staticClass("MyAnnotatedClass")
val annotation: Option[Annotation] = myAnnotatedClass.annotations.find(_.tree.tpe =:= u.typeOf[Named])
val result = annotation.flatMap { a =>
  a.tree.children.tail.collect({ case Literal(Constant(name: String)) => doSomething(name) }).headOption
}

Upvotes: 3

dth
dth

Reputation: 2337

There are different kinds of annotations in Scala:

Java Annotations that you can access using the Java Reflection API, annotations that are just in the source code, static annotations that are available to the type checker across different compilation units (so they should be somewhere in a class file but not where normal reflections go) and classfile annotations which are stored like java annotations, but cannot be read using the java reflection api.

I have described how to access static and classfile annotations here: What is the (current) state of scala reflection capabilities, especially wrt annotations, as of version 2.11?

If you just need a annotation containing a string using a Java annotation that is loaded by the JVM for you might be the simpler alternative.

Upvotes: 1

Related Questions