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
Known Subclasses
Ordering
- Alphabetic
- By Inheritance
Inherited
- Param
- Serializable
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new Param(parent: Identifiable, name: String, doc: String)
- new Param(parent: String, name: String, doc: String, dataClass: Class[T])
- 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)
- new Param(parent: String, name: String, doc: String, isValid: (T) => Boolean, dataClass: Class[T])
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def ->(value: T): ParamPair[T]
Creates a param pair with the given value (for Scala).
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- val dataClass: Class[T]
- val doc: String
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def equals(obj: Any): Boolean
- Definition Classes
- Param → AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def hashCode(): Int
- Definition Classes
- Param → AnyRef → Any
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- 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
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- val parent: String
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- 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).
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)