typedrest/net.typedrest.endpoints.generic/IndexerEndpointImpl

IndexerEndpointImpl

open class IndexerEndpointImpl<TElementEndpoint : Endpoint>(referrer: Endpoint, relativeUri: URI, elementEndpointFactory: (referrer: Endpoint, relativeUri: URI) -> TElementEndpoint) : AbstractEndpoint, IndexerEndpoint<TElementEndpoint>

Endpoint that addresses child TElementEndpoints by ID.

Parameters

referrer

The endpoint used to navigate to this one.

relativeUri

The URI of this endpoint relative to the referrer's. Add a ./ prefix here to imply a trailing slash on referrer's URI.

elementEndpointFactory

The factory for constructing TElementEndpoints to provide for individual elements.

Type Parameters

TElementEndpoint

The type of Endpoint to provide for individual elements.

Constructors

IndexerEndpointImpl

constructor(referrer: Endpoint, relativeUri: URI, elementEndpointFactory: (referrer: Endpoint, relativeUri: URI) -> TElementEndpoint)

constructor(referrer: Endpoint, relativeUri: String, elementEndpointFactory: (referrer: Endpoint, relativeUri: URI) -> TElementEndpoint)

Creates a new indexer endpoint.

Properties

errorHandler

open override val errorHandler: ErrorHandler

httpClient

open override val httpClient: OkHttpClient

linkExtractor

open override val linkExtractor: LinkExtractor

serializers

open override val serializers: List<Serializer>

uri

open override val uri: URI

Functions

contains

fun <TElementEndpoint : ElementEndpoint<*>> IndexerEndpoint<TElementEndpoint>.contains(id: String): Boolean

Determines whether the collection contains a specific element.

delete

fun <TElementEndpoint : ElementEndpoint<*>> IndexerEndpoint<TElementEndpoint>.delete(id: String)

Deletes an existing element from the collection.

deserialize

fun <T> deserialize(body: ResponseBody, type: Class<T>): T?

Deserializes an entity using the first serializer that supports the body's content type.

deserializeList

fun <T> deserializeList(body: ResponseBody, type: Class<T>): List<T>?

Deserializes a list of entities using the first serializer that supports the body's content type.

get

open operator override fun get(id: String): TElementEndpoint

Returns an element endpoint for a specific child element.

getLinks

open override fun getLinks(rel: String): List<Pair<URI, String?>>

Resolves all links with a specific relation type. Uses cached data from last response.

getLinkTemplate

fun getLinkTemplate(rel: String): UriTemplate

Retrieves a link template with a specific relation type.

link

open override fun link(rel: String): URI

Resolves a single link with a specific relation type. Uses cached data from last response if possible.

linkTemplate

open override fun linkTemplate(rel: String, variables: Map<String, Any>): URI

Resolves a link template with a specific relation type. Uses cached data from last response if possible.

serialize

fun <T> serialize(entity: T, type: Class<T>): RequestBody

Serializes an entity using the first serializer.

serializeList

fun <T> serializeList(entities: Iterable<T>, type: Class<T>): RequestBody

Serializes a list of entities using the first serializer.

setDefaultLink

fun setDefaultLink(rel: String, href: String?)

Registers one or more default links for a specific relation type.

setDefaultLinkTemplate

fun setDefaultLinkTemplate(rel: String, href: String?)

Registers a default link template for a specific relation type.