Valid

Type Members

type Result[T] = T

A function which takes the result type of a conversion as input, and yields the return type of the conversion block.
A function which takes the result type of a conversion as input, and yields the return type of the conversion block.
For example, if converting a String to a Boolean, this is a function which takes Boolean as input, and yields some type Result[Boolean] (Boolean for Convert.Valid, and Option[Boolean] for Convert.Any).

Definition Classes
Valid → Convert

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
object AutoUnwrap

An object containing an implicit conversion from Result[T] to T.
An object containing an implicit conversion from Result[T] to T. The implicit conversion allows the automatic unwrapping of Results, without explicitly calling unwrap.
USE THIS IMPLICIT CONVERSION AT YOUR OWN RISK
This implicit conversion can improve code readability; however, it should be used with care. As with all implicit conversions, it may be difficult to tell when it is applied by the compiler, leading to unexpected behavior which is difficult to debug.
Additionally, because unwrap MUST be called within a conversion block, this implicit conversion MUST be called within a conversion block as well. However, if imported in the wrong scope, the compiler may insert a call to this implicit conversion outside of any conversion block. Use this implicit conversion with care.

Definition Classes
Convert
object Implicit

A wrapper object for an implicit reference to the enclosing Convert.
A wrapper object for an implicit reference to the enclosing Convert.

Definition Classes
Convert
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def conversion[T](res: ⇒ T): T

Performs a conversion.
Performs a conversion.
Conversion operations MUST take place within this block (a 'conversion block').
T
the type of the conversion's result
returns
the result of the conversion, if it did not fail
Definition Classes
Valid → Convert
Example:
1. conversion { val res = ??? // do conversion if (cond) fail(new IllegalArgumentException("invalid input")) // fail if something goes wrong res // return a result }
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def fail(ex: ⇒ Exception): Nothing

Throws the specified exception.
Throws the specified exception.
This method MUST be called within a conversion block from this Convert instance.
ex
the exception to throw

Definition Classes
Valid → Convert
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def require(requirement: Boolean, message: ⇒ Any): Unit

Tests an expression, failing the conversion if false.
Tests an expression, failing the conversion if false. Analogous to Predef.require, except that it fails the conversion instead of always throwing an exception.
This method MUST be called within a conversion block from this Convert instance.
requirement
the expression to test
message
a String to include in the failure message

Definition Classes
Convert
Annotations
@inline()
final def require(requirement: Boolean): Unit

Tests an expression, failing the conversion if false.
Tests an expression, failing the conversion if false. Analogous to Predef.require, except that it fails the conversion instead of always throwing an exception.
This method MUST be called within a conversion block from this Convert instance.
requirement
the expression to test

Definition Classes
Convert
Annotations
@inline()
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def unwrap[T](result: T): T

Returns the result of another conversion.
Returns the result of another conversion.
This method MUST be called within a conversion block from this Convert instance.
T
the type of the result
result
the result of another conversion
returns
the result of the other conversion

Definition Classes
Valid → Convert
final def wait(): Unit

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

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wrapException[T](matches: (Exception) ⇒ Boolean)(body: ⇒ T): T

Wraps a block of code which throws an exception, failing the conversion if the block throws an exception, and the exception matches the specified predicate.
Wraps a block of code which throws an exception, failing the conversion if the block throws an exception, and the exception matches the specified predicate.
This method MUST be called within a conversion block from this Convert instance.
T
the type of the result of body
matches
a predicate to match certain exceptions to be wrapped
body
the block of code which may throw an exception
returns
the result of body, if it did not fail

Definition Classes
Convert
final def wrapException[E <: Exception, T](body: ⇒ T)(implicit arg0: ClassTag[E]): T

Wraps a block of code which throws an exception, failing the conversion if the block throws an exception of the specified type.
Wraps a block of code which throws an exception, failing the conversion if the block throws an exception of the specified type.
This method MUST be called within a conversion block from this Convert instance.
E
the type of the exception
T
the type of the result of body
body
the block of code which may throw an exception
returns
the result of body, if it did not fail

Definition Classes
Convert

Related Doc: package Convert

object Valid extends Convert

Type Members

type Result[T] = T

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object AutoUnwrap

object Implicit

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def conversion[T](res: ⇒ T): T

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def fail(ex: ⇒ Exception): Nothing

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def require(requirement: Boolean, message: ⇒ Any): Unit

final def require(requirement: Boolean): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def unwrap[T](result: T): T

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def wrapException[T](matches: (Exception) ⇒ Boolean)(body: ⇒ T): T

final def wrapException[E <: Exception, T](body: ⇒ T)(implicit arg0: ClassTag[E]): T

Inherited from Convert

Inherited from AnyRef

Inherited from Any

Ungrouped