Class/Object

io.fintrospect.parameters

ParameterSpec

Related Docs: object ParameterSpec | package parameters

Permalink

case class ParameterSpec[T] extends Product with Serializable

Spec required to marshal and unmarshal a parameter of a custom type

T

the type of the deserialised parameter

returns

a parameter for retrieving a value of type [T] from the request

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ParameterSpec
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. def as[ValueType <: Value[T]](implicit mf: Manifest[ValueType]): ParameterSpec[ValueType]

    Permalink

    Convenience method to avoid boilerplate using map() with a AnyVal case-classes (which can be tagged with Value[T])

    Convenience method to avoid boilerplate using map() with a AnyVal case-classes (which can be tagged with Value[T])

    ValueType

    - the value type of the case class AnyVal

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def clone(): AnyRef

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

  7. val deserialize: (String) ⇒ T

    Permalink

    function to take the input string from the request and attempt to construct a deserialized instance of T.

    function to take the input string from the request and attempt to construct a deserialized instance of T. Exceptions are automatically caught and translated into the appropriate result, so just concentrate on the Happy-path case

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

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  10. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  11. def map[O](in: (T) ⇒ O): ParameterSpec[O]

    Permalink

    Uni-directional map functions for this ParameterSpec type.

    Uni-directional map functions for this ParameterSpec type. Use this to implement custom Parameter types

  12. def map[O](in: (T) ⇒ O, out: (O) ⇒ T): ParameterSpec[O]

    Permalink

    Bi-directional map functions for this ParameterSpec type.

    Bi-directional map functions for this ParameterSpec type. Use this to implement custom Parameter types

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

    Permalink
    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  16. val paramType: ParamType

    Permalink

    The parameter type to be used in the documentation.

    The parameter type to be used in the documentation. For custom types, this is usually ObjectParamType (for JSON) or StringParamType

  17. val serialize: (T) ⇒ String

    Permalink

    function to take the input type and serialize it to a string to be represented in the request

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

    Permalink
    Definition Classes
    AnyRef

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

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

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

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

  21. final def wait(): Unit

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

Deprecated Value Members

  1. def finalize(): Unit

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped