case class RouterBuilder[Input, Route, +RouterType <: Router[Input, Route]] extends Product with Serializable
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 theRoute
is a self-contained/self-describing type for the purpose of validation via the Validator. Put differently, theRoute
should know of theInput
that maps to itself.- RouterType
The type of Router to build.
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- RouterBuilder
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- 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
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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()
- def withLabel(label: String): RouterBuilder[Input, Route, RouterType]
- 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