Packages

final class ParamMap extends Serializable

A param to value map.

Annotations
@Since( "1.2.0" )
Source
params.scala
Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ParamMap
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ParamMap()

    Creates an empty param map.

    Creates an empty param map.

    Annotations
    @Since( "1.2.0" )

Value Members

  1. def ++(other: ParamMap): ParamMap

    Returns a new param map that contains parameters in this map and the given map, where the latter overwrites this if there exist conflicts.

    Returns a new param map that contains parameters in this map and the given map, where the latter overwrites this if there exist conflicts.

    Annotations
    @Since( "1.2.0" )
  2. def ++=(other: ParamMap): ParamMap.this.type

    Adds all parameters from the input param map into this param map.

    Adds all parameters from the input param map into this param map.

    Annotations
    @Since( "1.2.0" )
  3. def apply[T](param: Param[T]): T

    Gets the value of the input param or its default value if it does not exist.

    Gets the value of the input param or its default value if it does not exist. Raises a NoSuchElementException if there is no value associated with the input param.

    Annotations
    @Since( "1.2.0" )
  4. def contains(param: Param[_]): Boolean

    Checks whether a parameter is explicitly specified.

    Checks whether a parameter is explicitly specified.

    Annotations
    @Since( "1.2.0" )
  5. def copy: ParamMap

    Creates a copy of this param map.

    Creates a copy of this param map.

    Annotations
    @Since( "1.2.0" )
  6. def filter(parent: Params): ParamMap

    Filters this param map for the given parent.

    Filters this param map for the given parent.

    Annotations
    @Since( "1.2.0" )
  7. def get[T](param: Param[T]): Option[T]

    Optionally returns the value associated with a param.

    Optionally returns the value associated with a param.

    Annotations
    @Since( "1.2.0" )
  8. def getOrElse[T](param: Param[T], default: T): T

    Returns the value associated with a param or a default value.

    Returns the value associated with a param or a default value.

    Annotations
    @Since( "1.4.0" )
  9. def put(paramPairs: ParamPair[_]*): ParamMap.this.type

    Puts a list of param pairs (overwrites if the input params exists).

    Puts a list of param pairs (overwrites if the input params exists).

    Annotations
    @varargs() @Since( "1.2.0" )
  10. def put[T](param: Param[T], value: T): ParamMap.this.type

    Puts a (param, value) pair (overwrites if the input param exists).

    Puts a (param, value) pair (overwrites if the input param exists).

    Annotations
    @Since( "1.2.0" )
  11. def remove[T](param: Param[T]): Option[T]

    Removes a key from this map and returns its value associated previously as an option.

    Removes a key from this map and returns its value associated previously as an option.

    Annotations
    @Since( "1.4.0" )
  12. def size: Int

    Number of param pairs in this map.

    Number of param pairs in this map.

    Annotations
    @Since( "1.3.0" )
  13. def toSeq: Seq[ParamPair[_]]

    Converts this param map to a sequence of param pairs.

    Converts this param map to a sequence of param pairs.

    Annotations
    @Since( "1.2.0" )
  14. def toString(): String
    Definition Classes
    ParamMap → AnyRef → Any
    Annotations
    @Since( "1.2.0" )