paramTag

Parameter tagging lets you have more explicit control over which raw parameters can match which real parameters. This way you can have some of the parameters annotated in order to treat them differently, e.g. they may be verbatim, encoded in a different way or collected to a different raw container (e.g. Map[String,Raw] vs List[Raw] - see multi for more details).

Example:

sealed trait RestParam extends RpcTag
class Body extends RestParam
class Url extends RestParam
class Path extends RestParam

@paramTag[RestParam](new Body)
trait RestRawRpc {
  def get(
    @methodName name: String,
    @multi @verbatim @tagged[Path] pathParams: List[String],
    @multi @verbatim @tagged[Url] urlParams: Map[String,String],
    @multi @tagged[Body] bodyParams: Map[String,Json]
  ): Future[Json]
}

NOTE: The example above assumes there is a Json type defined with appropriate encodings - see encoded for more details on parameter and method result encoding.

The example above configures parameter tag type for the entire trait, but you can also do it for each raw method, e.g.

trait RestRawRpc {
  @paramTag[RestParam](new Body)
  def get(...)
}

BaseTag: base type for tags that can be used on real RPC parameters

Linear Supertypes

RawMethodAnnotation, RawSymAnnotation, StaticAnnotation, Annotation, AnyRef, Any

Instance Constructors

new paramTag(defaultTag: BaseTag = null)

defaultTag
default tag value assumed for untagged real parameters

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val defaultTag: BaseTag

default tag value assumed for untagged real parameters
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package rpc

final class paramTag[BaseTag <: RpcTag] extends Annotation with RawMethodAnnotation

Instance Constructors

new paramTag(defaultTag: BaseTag = null)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val defaultTag: BaseTag

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from RawMethodAnnotation

Inherited from RawSymAnnotation

Inherited from StaticAnnotation

Inherited from Annotation

Inherited from AnyRef

Inherited from Any

Ungrouped