net.eusashead.parquet.http.response

Interface GetResponseBuilder

All Superinterfaces:

ETagResponseBuilder, net.eusashead.parquet.entity.MutableEntity, ResponseBuilder

All Known Implementing Classes:

DeleteResponseBuilderImpl, ErrorResponseBuilderImpl, GetResponseBuilderImpl, OptionsResponseBuilderImpl, PatchResponseBuilderImpl, PostResponseBuilderImpl, PutResponseBuilderImpl, ResponseBuilderImpl

public interface GetResponseBuilder
extends ETagResponseBuilder

Method Summary

Methods

Modifier and Type	Method and Description
GetResponseBuilder	body(net.eusashead.parquet.entity.Entity entity) Set the body to the supplied Entity
<T> GetResponseBuilder	body(T target, net.eusashead.parquet.entity.EntityConverter<T> converter)
GetResponseBuilder	embed(java.lang.String rel, net.eusashead.parquet.entity.Entity entity)
<T> GetResponseBuilder	embed(java.lang.String rel, T target, net.eusashead.parquet.entity.EntityConverter<T> converter)
GetResponseBuilder	eTag() Set a weak validating ETag using a hash of the embedded entity.
GetResponseBuilder	eTag(ETag version) Set the ETag header
GetResponseBuilder	expires(java.lang.Long millis) Set the expiry time in milliseconds that this resource should be cached for Sets Date, CacheControl and Expires headers
<T> GetResponseBuilder	forEach(java.lang.String rel, java.lang.Iterable<T> target, net.eusashead.parquet.entity.EntityConverter<T> converter)
GetResponseBuilder	lastModified(HttpDate lastModified) Set the Last-Modified header to the specified Date
GetResponseBuilder	link(net.eusashead.parquet.entity.Link link)
GetResponseBuilder	property(java.lang.String name, java.lang.Object value)
GetResponseBuilder	property(java.lang.String name, java.lang.Object value, net.eusashead.parquet.entity.PropertyConverter<?,java.lang.Object> converter)
GetResponseBuilder	status(HttpStatus status) HTTP status code to send

Methods inherited from interface net.eusashead.parquet.http.response.ResponseBuilder

build, checkPrecondition, entityFactory, request, requirePrecondition, send

Method Detail

eTag

GetResponseBuilder eTag(ETag version)

Description copied from interface: ETagResponseBuilder

Set the ETag header

Specified by:

eTag in interface ETagResponseBuilder

Parameters:

version - ETag

Returns:

this ETagResponseBuilder

eTag

GetResponseBuilder eTag()

Description copied from interface: ETagResponseBuilder

Set a weak validating ETag using a hash of the embedded entity. The hash is created using the HashStrategy specified for this ResponseBuilder on the string returned from the Entity toString() method. Note: If the Entity state is modified after the ETag is created it will not be valid

Specified by:

eTag in interface ETagResponseBuilder

Returns:

this ETagResponseBuilder

lastModified

GetResponseBuilder lastModified(HttpDate lastModified)

Description copied from interface: ETagResponseBuilder

Set the Last-Modified header to the specified Date

Specified by:

lastModified in interface ETagResponseBuilder

Parameters:

lastModified - Date this entity last changed

Returns:

this ETagResponseBuilder

expires

GetResponseBuilder expires(java.lang.Long millis)

Set the expiry time in milliseconds that this resource should be cached for Sets Date, CacheControl and Expires headers

Parameters:

millis - Long expiry time in milliseconds

Returns:

this GetResponseBuilder

status

GetResponseBuilder status(HttpStatus status)

Description copied from interface: ResponseBuilder

HTTP status code to send

Specified by:

status in interface ResponseBuilder

Parameters:

status - HttpStatus to use

Returns:

this ResponseBuilder

property

GetResponseBuilder property(java.lang.String name,
                          java.lang.Object value)

Specified by:

property in interface net.eusashead.parquet.entity.MutableEntity

Specified by:

property in interface ResponseBuilder

property

GetResponseBuilder property(java.lang.String name,
                          java.lang.Object value,
                          net.eusashead.parquet.entity.PropertyConverter<?,java.lang.Object> converter)

Specified by:

property in interface net.eusashead.parquet.entity.MutableEntity

Specified by:

property in interface ResponseBuilder

embed

GetResponseBuilder embed(java.lang.String rel,
                       net.eusashead.parquet.entity.Entity entity)

Specified by:

embed in interface net.eusashead.parquet.entity.MutableEntity

Specified by:

embed in interface ResponseBuilder

embed

<T> GetResponseBuilder embed(java.lang.String rel,
                           T target,
                           net.eusashead.parquet.entity.EntityConverter<T> converter)

Specified by:

embed in interface net.eusashead.parquet.entity.MutableEntity

Specified by:

embed in interface ResponseBuilder

forEach

<T> GetResponseBuilder forEach(java.lang.String rel,
                             java.lang.Iterable<T> target,
                             net.eusashead.parquet.entity.EntityConverter<T> converter)

Specified by:

forEach in interface net.eusashead.parquet.entity.MutableEntity

Specified by:

forEach in interface ResponseBuilder

link

GetResponseBuilder link(net.eusashead.parquet.entity.Link link)

Specified by:

link in interface net.eusashead.parquet.entity.MutableEntity

Specified by:

link in interface ResponseBuilder

body

GetResponseBuilder body(net.eusashead.parquet.entity.Entity entity)

Description copied from interface: ResponseBuilder

Set the body to the supplied Entity

Specified by:

body in interface ResponseBuilder

Returns:

this ResponseBuilder

body

<T> GetResponseBuilder body(T target,
                          net.eusashead.parquet.entity.EntityConverter<T> converter)

Specified by:

body in interface ResponseBuilder

Returns: