Packages

class Param[T] extends Serializable

A param with self-contained documentation and optionally default value. Primitive-typed param should use the specialized versions, which are more friendly to Java users.

T

param value type

Source
params.scala
Linear Supertypes
Serializable, AnyRef, Any
Known Subclasses
BooleanParam, DoubleArrayArrayParam, DoubleArrayParam, DoubleParam, FloatParam, IntArrayParam, IntParam, LongParam, StringArrayParam
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Param
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Param(parent: Identifiable, name: String, doc: String)
  2. new Param(parent: String, name: String, doc: String)
  3. new Param(parent: Identifiable, name: String, doc: String, isValid: (T) => Boolean)
  4. new Param(parent: String, name: String, doc: String, isValid: (T) => Boolean)

    parent

    parent object

    name

    param name

    doc

    documentation

    isValid

    optional validation method which indicates if a value is valid. See ParamValidators for factory methods for common validation functions.

Value Members

  1. def ->(value: T): ParamPair[T]

    Creates a param pair with the given value (for Scala).

  2. val doc: String
  3. final def equals(obj: Any): Boolean
    Definition Classes
    Param → AnyRef → Any
  4. final def hashCode(): Int
    Definition Classes
    Param → AnyRef → Any
  5. val isValid: (T) => Boolean
  6. def jsonDecode(json: String): T

    Decodes a param value from JSON.

  7. def jsonEncode(value: T): String

    Encodes a param value into JSON, which can be decoded by jsonDecode().

  8. val name: String
  9. val parent: String
  10. final def toString(): String
    Definition Classes
    Param → AnyRef → Any
  11. def w(value: T): ParamPair[T]

    Creates a param pair with the given value (for Java).