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
- Alphabetic
- By Inheritance
- Param
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Param(parent: Identifiable, name: String, doc: String)
- new Param(parent: String, name: String, doc: String)
- new Param(parent: Identifiable, name: String, doc: String, isValid: (T) => Boolean)
- 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
- def ->(value: T): ParamPair[T]
Creates a param pair with the given value (for Scala).
- val doc: String
- final def equals(obj: Any): Boolean
- Definition Classes
- Param → AnyRef → Any
- final def hashCode(): Int
- Definition Classes
- Param → AnyRef → Any
- val isValid: (T) => Boolean
- def jsonDecode(json: String): T
Decodes a param value from JSON.
- def jsonEncode(value: T): String
Encodes a param value into JSON, which can be decoded by
jsonDecode()
. - val name: String
- val parent: String
- final def toString(): String
- Definition Classes
- Param → AnyRef → Any
- def w(value: T): ParamPair[T]
Creates a param pair with the given value (for Java).