typedrest/net.typedrest.endpoints.generic/CollectionEndpointImpl

CollectionEndpointImpl

open class CollectionEndpointImpl<TEntity> : GenericCollectionEndpointImpl<TEntity, ElementEndpoint<TEntity>> , CollectionEndpoint<TEntity>

Endpoint for a collection of TEntitys addressable as ElementEndpoints.

Use GenericCollectionEndpointImpl instead if you wish to customize the element endpoint type.

Parameters

TEntity

The type of individual elements in the collection.

Constructors

CollectionEndpointImpl

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

Creates a new element collection endpoint.

constructor(referrer: Endpoint, relativeUri: String, entityType: Class<TEntity>)

Creates a new element collection endpoint.

Properties

createAllAllowed

open override val createAllAllowed: Boolean?

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

createAllowed

open override val createAllowed: Boolean?

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

errorHandler

open override val errorHandler: ErrorHandler

httpClient

open override val httpClient: OkHttpClient

linkExtractor

open override val linkExtractor: LinkExtractor

rangeUnit

var rangeUnit: String

The value used for HttpContentRangeHeader.unit.

readAllAllowed

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.

responseCache

open override var responseCache: ResponseCache?

A cached copy of the last response.

serializers

open override val serializers: List<Serializer>

setAllAllowed

open override val setAllAllowed: Boolean?

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

uri

open override val uri: URI

Functions

create

open override fun create(entity: TEntity): ElementEndpoint<TEntity>?

Adds an entity as a new element to the collection.

createAll

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

Adds (or updates) multiple entities as elements in 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(entity: TEntity): ElementEndpoint<TEntity>

Returns an ElementEndpoint for a specific child element.

operator fun get(id: String): ElementEndpoint<TEntity>

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.

readAll

open override fun readAll(): List<TEntity>

Returns all entities in the collection.

readRange

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

Returns all entities within a specific range of the collection.

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.

setAll

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

Replaces the entire content of the collection with new entities.

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.