< Back

Packages

package root

Definition Classes
root
package xitrum
Things that are usually used by application developers are put in this package for convenience, because when they want to use XXX, they can simply write:
Things that are usually used by application developers are put in this package for convenience, because when they want to use XXX, they can simply write:
```
import xitrum.XXX
```
To avoid polluting this namespace, things that are utilities should be put in package xitrum.util, not here.
Annotations and validators are put to package xitrum.annation and xitrum.validator because there are many of them. It's better for application developers to write:
```
import xitrum.annotation._
import xitrum.validator._
```
Definition Classes
root
package routing

Definition Classes
xitrum
DiscoveredAcc
DotRouteToken
HttpMethodWebSocket
NonDotRouteToken
ReverseRoute
Route
RouteCollection
RouteCollector
RouteCompiler
RouteToken
SerializableRoute
SerializableRouteCollection
SockJsClassAndOptions
SockJsRouteMap
SwaggerJson
SwaggerUi

t

RouteToken

sealed trait RouteToken extends AnyRef

Linear Supertypes

AnyRef, Any

Known Subclasses

DotRouteToken, NonDotRouteToken

Type Hierarchy

Ordering

Alphabetic
By Inheritance

Inherited

RouteToken
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Abstract Value Members

abstract def decompile(forSwagger: Boolean): String
Reconstruct NonDotRouteToken("id", true, Some("[0-9]+".r)): - Not for Swagger => ":id<[0-9]+>" - For Swagger => {id}
abstract def matchToken(pathParams: Params, pathTokens: Seq[String], last: Boolean): Boolean
pathParams
May be updated if matched
last
Used when matching "*"
abstract def numPlaceholders: Int
Used by ReverseRoute (reverse routes are cached, thus no need to cache numPlaceholders as "val")
abstract def url(params: Map[String, Any]): Either[String, (Any, Map[String, Any])]
params
Used when isPlaceholder is true
returns
Left(error) or Right((token value, remaining params))

Concrete 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 equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
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 synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped