ResolvedResource

class ResolvedResource<R : Resource> : Addressed

A resolved Resource.

The Resource class represents the declaration of a resource. For example, the /api/users/{user} is not a 'real' resource: it is a pattern from which multiple resources can be created (each user gets their own resource). This class, ResolvedResource, represents 'real' resources: /api/users/111 and /api/users/222 are possible values of this class.

To instantiate this class, specify the full path from the root, adding necessary runtime information where necessary. For example:

object Root : RootResource("api") {
    object Users : StaticResource<Root>("users", Root) {
        object User : DynamicResource<Users>("user", User)
    }
}

// The root can be resolved with no further information, since it must be static:
println(Root.resolved)

// Static routes can be resolved simply by specifying their path:
println(Root / Users)

// Dynamic routes require specifying the dynamic segment during resolution:
println(Root / Users / User("123456789"))

Properties

path

open override val path: Path

resource

val resource: R

Functions

div

operator fun <R : Resource, Endpoint : AnyEndpoint> ResolvedResource<R>.div(endpoint: Endpoint): ResolvedEndpoint<Endpoint>

Resolves an endpoint declared in a resolved resource.

Example

println(Root / Users / User("999") / User.get)

operator fun <Current : Resource, Child : StaticResource<Current>> ResolvedResource<Current>.div(child: Child): ResolvedResource<Child>

Resolves the static child resource under this ResolvedResource.

This operator participates in the resource resolution DSL.

Example

val users = Api / Users

operator fun <Current : Resource, Child : DynamicResource<Current>> ResolvedResource<Current>.div(child: DynamicResource.Identified<Current, Child>): ResolvedResource<Child>

Resolves the dynamic child resource under this ResolvedResource by binding its identifier.

The identifier and the target resource are carried by DynamicResource.Identified, typically created via the DynamicResource.invoke operator, e.g. User("123").

This operator participates in the resource resolution DSL.

Example

val user123 = Api / Users / User("123")

operator fun <Root : RootResource, Child : StaticResource<Root>> Root.div(child: Child): ResolvedResource<Child>

Starts resolution from the RootResource and resolves the static child.

Syntactic sugar for this.resolved / child.

operator fun <Root : RootResource, Child : DynamicResource<Root>> Root.div(child: DynamicResource.Identified<Root, Child>): ResolvedResource<Child>

Starts resolution from the RootResource and resolves the dynamic child.

Syntactic sugar for this.resolved / child.

toString

open override fun toString(): String