Trait

com.nrinaudo.fetch

Parameters

Related Doc: package fetch

Permalink

trait Parameters[Self <: Parameters[Self]] extends AnyRef

Stores a list of name / value pairs.

Values are stored in their serialized forms as String, but can be manipulated as more specific types provided corresponding instances of ValueReader and ValueWriter are in scope. Default implementations of these can be found in ValueFormat.

Self Type
Self
Linear Supertypes
AnyRef, Any
Known Subclasses
Headers, MediaTypeParameters
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Parameters
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def build(values: Map[String, String]): Self

    Permalink

    Creates a new instance of Parameters with the specified values.

  2. abstract val values: Map[String, String]

    Permalink

    Where the parameter and their values are stored.

Concrete 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 apply[T](name: String)(implicit arg0: ValueReader[T]): T

    Permalink

    Returns the value of the requested parameter.

    Returns the value of the requested parameter.

    This method is unsafe: it will throw an exception if the requested parameter is either absent or not found. For safer alternatives, see Parameters.get and Parameters.getOpt.

    T

    type of the parameter to retrieve. An implicit instance of ValueReader for this type is required to be in scope.

    name

    name of the parameter to retrieve.

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def clone(): AnyRef

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

  7. def contains(name: String): Boolean

    Permalink

    Checks whether the current instance contains a parameter with the specified name.

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

    Permalink
    Definition Classes
    AnyRef

  9. def equals(p1: Any): Boolean

    Permalink
    Definition Classes
    Parameters → AnyRef → Any

  10. def finalize(): Unit

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

  11. def get[T](name: String)(implicit arg0: ValueReader[T]): Option[Try[T]]

    Permalink

    Returns the value of the requested parameter.

    Returns the value of the requested parameter.

    This method differentiates between an absent parameter (None) and one with an illegal value (Some(Failure)). If that distinction is not necessary, used Parameters.getOpt instead.

    T

    type of the parameter to retrieve. An implicit instance of ValueReader for this type is required to be in scope.

    name

    name of the parameter to retrieve.

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

    Permalink
    Definition Classes
    AnyRef → Any

  13. def getOpt[T](name: String)(implicit arg0: ValueReader[T]): Option[T]

    Permalink

    Returns the value of the requested parameter.

    Returns the value of the requested parameter.

    This method does not differentiate between an absent parameter and one with an illegal value: both cases will return None. If the distinction is important, use the Parameters.get method.

    T

    type of the parameter to retrieve. An implicit instance of ValueReader for this type is required to be in scope.

    name

    name of the parameter to retrieve.

  14. def hashCode(): Int

    Permalink
    Definition Classes
    Parameters → AnyRef → Any

  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  19. def remove(name: String): Self

    Permalink

    Removes the specified parameter if it exists.

    Removes the specified parameter if it exists. Otherwise, does nothing.

    name

    name of the parameter to remove.

  20. def set(name: String, value: String): Self

    Permalink

  21. def set[T](name: String, value: T)(implicit arg0: ValueWriter[T]): Self

    Permalink

    Sets the specified parameter to the specified value.

    Sets the specified parameter to the specified value.

    T

    type of the parameter. An implicit instance of ValueWriter for this type is required to be in scope.

    name

    name of the parameter.

    value

    value of the parameter.

  22. def setIfEmpty[T](name: String, value: T)(implicit arg0: ValueWriter[T]): Self

    Permalink

    Sets the specified parameter to the specified value if it does not exist.

    Sets the specified parameter to the specified value if it does not exist. Otherwise, does nothing.

    T

    type of the parameter. An implicit instance of ValueWriter for this type is required to be in scope.

    name

    name of the parameter to set.

    value

    desired value.

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

    Permalink
    Definition Classes
    AnyRef

  24. def toString(): String

    Permalink
    Definition Classes
    Parameters → AnyRef → Any

  25. final def wait(): Unit

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped