typedrest/net.typedrest.endpoints.generic/GenericCollectionEndpointImpl

GenericCollectionEndpointImpl

open class GenericCollectionEndpointImpl<TEntity, TElementEndpoint : ElementEndpoint<TEntity>>(referrer: Endpoint, relativeUri: URI, entityType: Class<TEntity>, elementEndpointFactory: (referrer: Endpoint, relativeUri: URI) -> TElementEndpoint) : AbstractCachingEndpoint, GenericCollectionEndpoint<TEntity, TElementEndpoint>

Endpoint for a collection of TEntitys addressable as TElementEndpoints.

Use the more constrained CollectionEndpointImpl when possible.

Parameters

referrer

The endpoint used to navigate to this one.

relativeUri

The URI of this endpoint relative to the referrer's.

entityType

The type of individual elements in the collection.

elementEndpointFactory

The factory for constructing TElementEndpoints to provide for individual elements.

TEntity

The type of individual elements in the collection.

TElementEndpoint

The type of ElementEndpoint to provide for individual TEntitys.

Inheritors

CollectionEndpointImpl

Constructors

GenericCollectionEndpointImpl

constructor(referrer: Endpoint, relativeUri: URI, entityType: Class<TEntity>, elementEndpointFactory: (referrer: Endpoint, relativeUri: URI) -> TElementEndpoint)

constructor(referrer: Endpoint, relativeUri: String, entityType: Class<TEntity>, elementEndpointFactory: (referrer: Endpoint, relativeUri: URI) -> TElementEndpoint)

Creates a new element collection endpoint.

Properties

createAllAllowed

open override val createAllAllowed: Boolean?

Shows whether the server has indicated that createAll is currently allowed.

open override val createAllowed: Boolean?

Shows whether the server has indicated that create is currently allowed.

open override val errorHandler: ErrorHandler

open override val httpClient: OkHttpClient

open override val linkExtractor: LinkExtractor

var rangeUnit: String

The value used for HttpContentRangeHeader.unit.

open override val readAllAllowed: Boolean?

Shows whether the server has indicated that readAll is currently allowed.

readRangeAllowed

open override var readRangeAllowed: Boolean?

Shows whether the server has indicated that readRange is allowed.

open override var responseCache: ResponseCache?

A cached copy of the last response.

open override val serializers: List<Serializer>

open override val setAllAllowed: Boolean?

Shows whether the server has indicated that setAll is currently allowed.

open override val uri: URI

Functions

open override fun create(entity: TEntity): TElementEndpoint?

Adds an entity as a new element to the collection.

open override fun createAll(entities: Iterable<TEntity>)

Adds (or updates) multiple entities as elements in the collection.

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.

open operator override fun get(entity: TEntity): TElementEndpoint

Returns an ElementEndpoint for a specific child element.

operator fun get(id: String): TElementEndpoint

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.

open override fun link(rel: String): URI

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

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.

open override fun readAll(): List<TEntity>

Returns all entities in the collection.

open override fun readRange(from: Long?, to: Long?): PartialResponse<TEntity>

Returns all entities within a specific range of the collection.

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

Serializes an entity using the first serializer.

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

Serializes a list of entities using the first serializer.

open override fun setAll(entities: Iterable<TEntity>)

Replaces the entire content of the collection with new entities.

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.