OptionalArg

Provides idiomatic optional parameter values on top of Option, but which can be passed in as raw values, instead of having to pass in Some(value)

import io.radanalytics.silex.util.OptionalArg

def possiblyFilter(data: Seq[Int], filterMax: OptionalArg[Int] = None) = {
  // Treat an OptionalArg like an Option, for idiomatic handling of unset vals as None
  if (filterMax.isEmpty) data else data.filter(_ <= filterMax.get)
}

val data = Seq(1, -1, 2)

// default filterMax is None
possiblyFilter(data) // returns data unfiltered

// provide argument as (-1), instead of having to specify Some(-1)
possiblyFilter(data, filterMax = -1) // returns Seq(-1)

// Support full Option methods and implicit conversion to Option
import OptionalArg.fullOptionSupport
def possiblyFilterUsingMap(data: Seq[Int], filterMax: OptionalArg[Int] = None) = {
  // use the 'map' method on an OptionalArg:
  filterMax.map(t => data.filter(_ <= t)).getOrElse(data)
}

A: The underlying value type.

Linear Supertypes

AnyVal, Any

Instance Constructors

new OptionalArg(option: Option[A])

option
The raw Option value. May be implicitly constructed from raw value of type A

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

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

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def get: A

Get the value of the optional argument, assuming the argument is not empty.
Get the value of the optional argument, assuming the argument is not empty.
returns
the value of the optional argument, or throw an exception if it is None
def getClass(): Class[_ <: AnyVal]

Definition Classes
AnyVal → Any
def getOrElse[A1 >: A](d: ⇒ A1): A1

Get the value of the optional argument if it is defined, otherwise return the given default.
Get the value of the optional argument if it is defined, otherwise return the given default.
d
A block evaluating to a default value, if the the optional value is not defined
returns
The value of the optional argument if one was defined, otherwise the value of d
def isDefined: Boolean

Determine if the optional argument is defined (contains Some(value))
Determine if the optional argument is defined (contains Some(value))
returns
true if option contains Some(value), false otherwise
def isEmpty: Boolean

Determine if the optional argument is empty (contains None)
Determine if the optional argument is empty (contains None)
returns
true if the option is None, false otherwise
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val option: Option[A]

The raw Option value.
The raw Option value. May be implicitly constructed from raw value of type A
def toString(): String

Definition Classes
Any

Related Docs: object OptionalArg | package util

final class OptionalArg[A] extends AnyVal

Instance Constructors

new OptionalArg(option: Option[A])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def get: A

def getClass(): Class[_ <: AnyVal]

def getOrElse[A1 >: A](d: ⇒ A1): A1

def isDefined: Boolean

def isEmpty: Boolean

final def isInstanceOf[T0]: Boolean

val option: Option[A]

def toString(): String

Inherited from AnyVal

Inherited from Any

Ungrouped