Packages

class Param[T] extends Serializable

:: DeveloperApi :: 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

Annotations
@DeveloperApi()
Linear Supertypes
Serializable, 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. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def ->(value: T): ParamPair[T]

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

  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. val doc: String
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. final def equals(obj: Any): Boolean
    Definition Classes
    Param → AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def hashCode(): Int
    Definition Classes
    Param → AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. val isValid: (T) ⇒ Boolean
  15. def jsonDecode(json: String): T

    Decodes a param value from JSON.

  16. def jsonEncode(value: T): String

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

  17. val name: String
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. val parent: String
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. final def toString(): String
    Definition Classes
    Param → AnyRef → Any
  24. def w(value: T): ParamPair[T]

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

  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Members