RouterBuilder

Utility for building and creating routers. The resulting router should be considered immutable, unless the router's implementation explicitly states otherwise.

Input: The router's Input type.
Route: The router's destination Route type. It is recommended that the Route is a self-contained/self-describing type for the purpose of validation via the validator. Put differently, the Route should know of the Input that maps to itself.
RouterType: The type of Router to build.

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

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

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

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

Definition Classes
AnyRef
def newRouter(): RouterType

Generate a new router from the defined routes
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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( ... )
def withLabel(label: String): RouterBuilder[Input, Route, RouterType]

Set the label for the resulting router
def withRoute(route: Route): RouterBuilder[Input, Route, RouterType]

Add the route to the routes that will be present in the router when newRouter() is called.
def withValidator(validator: Validator[Route]): RouterBuilder[Input, Route, RouterType]

Configure the route validation logic for this builder

Related Docs: object RouterBuilder | package routing

case class RouterBuilder[Input, Route, +RouterType <: Router[Input, Route]] extends Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

def newRouter(): RouterType

final def notify(): Unit

final def notifyAll(): Unit

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

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withLabel(label: String): RouterBuilder[Input, Route, RouterType]

def withRoute(route: Route): RouterBuilder[Input, Route, RouterType]

def withValidator(validator: Validator[Route]): RouterBuilder[Input, Route, RouterType]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped