typedrest/net.typedrest.endpoints.generic

Package-level declarations

Generic endpoints allow you to model collections and elements.

Types

AbstractCachingEndpoint

abstract class AbstractCachingEndpoint(referrer: Endpoint, relativeUri: URI) : AbstractEndpoint, CachingEndpoint

Base class for building endpoints that use ETags and Last-Modified timestamps for caching and to avoid lost updates.

CollectionEndpoint

interface CollectionEndpoint<TEntity> : GenericCollectionEndpoint<TEntity, ElementEndpoint<TEntity>>

Endpoint for a collection of TEntitys addressable as ElementEndpoints.

CollectionEndpointImpl

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

Endpoint for a collection of TEntitys addressable as ElementEndpoints.

ElementEndpoint

interface ElementEndpoint<TEntity> : Endpoint

Endpoint for an individual resource.

ElementEndpointImpl

open class ElementEndpointImpl<TEntity>(referrer: Endpoint, relativeUri: URI, entityType: Class<TEntity>) : AbstractCachingEndpoint, ElementEndpoint<TEntity>

Endpoint for an individual resource.

GenericCollectionEndpoint

interface GenericCollectionEndpoint<TEntity, out TElementEndpoint : ElementEndpoint<TEntity>>

Endpoint for a collection of TEntitys addressable as TElementEndpoints.

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.

IndexerEndpoint

interface IndexerEndpoint<out TElementEndpoint : Endpoint> : Endpoint

Endpoint that addresses child TElementEndpoints by ID.

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.

Functions

fun <TEntity, TElementEndpoint : ElementEndpoint<TEntity>> GenericCollectionEndpoint<TEntity, TElementEndpoint>.contains(entity: TEntity): Boolean

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

Determines whether the collection contains a specific element.

fun <TEntity, TElementEndpoint : ElementEndpoint<TEntity>> GenericCollectionEndpoint<TEntity, TElementEndpoint>.delete(entity: TEntity)

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

Deletes an existing element from the collection.

fun <TEntity, TElementEndpoint : ElementEndpoint<TEntity>> GenericCollectionEndpoint<TEntity, TElementEndpoint>.merge(entity: TEntity): TEntity?

Modifies an existing element in the collection by merging changes on the server-side.

fun <TEntity, TElementEndpoint : ElementEndpoint<TEntity>> GenericCollectionEndpoint<TEntity, TElementEndpoint>.set(entity: TEntity): TEntity?

Sets/replaces an existing element in the collection.