Class

com.avsystem.commons.rpc

paramTag

Related Doc: package rpc

Permalink

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

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,Body]
trait RestRawRpc {
  def get(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,Body]
  def get(...)
}
BaseTag

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

DefaultTag

the default tag type used for real parameters not explicitly tagged - if you don't want to introduce any specific default tag, just use the same type as for BaseTag

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. paramTag
  2. RawMethodAnnotation
  3. RawRpcAnnotation
  4. StaticAnnotation
  5. Annotation
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new paramTag()

    Permalink

Value Members

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

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

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

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

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

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

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

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  16. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from RawMethodAnnotation

Inherited from RawRpcAnnotation

Inherited from StaticAnnotation

Inherited from Annotation

Inherited from AnyRef

Inherited from Any

Ungrouped