Packages

trait QueryParam extends Annotation

Annotations
@Target() @Retention() @InjectableValue()
Linear Supertypes
Annotation, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. QueryParam
  2. Annotation
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def annotationType(): Class[_ <: Annotation]
    Definition Classes
    Annotation
  2. abstract def commaSeparatedList(): Boolean

    Set to true for parameters that are in comma-separated format, so that they will be split before parsing the individual values.

    Set to true for parameters that are in comma-separated format, so that they will be split before parsing the individual values. Only meaningful for collections.

    This makes it easy to support the query param styles from RFC-6570 (URI Template) Section 3.2.8 https://tools.ietf.org/html/rfc6570#section-3.2.8

    These styles use the modifiers defined elsewhere in the spec, especially the "explode modifier" defined in Section 2.4.2 https://tools.ietf.org/html/rfc6570#section-2.4.2

    commaSeparatedList == false corresponds to the "explode modifier" style &list=red&list=green&list=blue

    commaSeparatedList == true corresponds to the non-"explode modifier" style: &list=red,green,blue

    Annotations
    @AnnotationDefault()
  3. abstract def value(): String

    An optional field name to use for reading the query parameter from the Finagle HTTP Request.

    An optional field name to use for reading the query parameter from the Finagle HTTP Request. When empty, the annotated case class field name will be used to read the query parameter from the Finagle HTTP Request parameters.

    returns

    the name of the query parameter field.

    Annotations
    @AnnotationDefault()

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Annotation

Inherited from AnyRef

Inherited from Any

Ungrouped