GenericResponseBuilder (Beadledom (Parent) 2.7 API)

java.lang.Object
- com.cerner.beadledom.jaxrs.GenericResponseBuilder<T>

```
public abstract class GenericResponseBuilder<T>
extends Object
```
A class for building GenericResponse instances.
An initial instance of a builder can be obtained via the static methods of the GenericResponses class.

Since:

1.3

Author:

John Leacox

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`GenericResponseBuilder(javax.ws.rs.core.Response.ResponseBuilder rawBuilder)` Creates a new `GenericResponseBuilder` that delegates to the underlying `rawBuilder`.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`GenericResponseBuilder<T>`	`allow(Set<String> methods)` Set the list of allowed HTTP methods (e.g.
`GenericResponseBuilder<T>`	`allow(String... methods)` Set the list of allowed HTTP methods (e.g.
`GenericResponse<T>`	`build()` Return a new `GenericResponse` instance from the builder.
`protected abstract GenericResponse<T>`	`build(T body, javax.ws.rs.core.Response rawResponse)` Creates a new `GenericResponse` instance from the provided `body` and `rawResponse`.
`GenericResponseBuilder<T>`	`cacheControl(javax.ws.rs.core.CacheControl cacheControl)` Sets the cache control data of the response.
`GenericResponseBuilder<T>`	`contentLocation(URI location)` Sets the content location.
`GenericResponseBuilder<T>`	`cookie(javax.ws.rs.core.NewCookie... cookies)` Sets the response cookies.
`GenericResponseBuilder<T>`	`encoding(String encoding)` Sets the encoding of the entity body.
`GenericResponseBuilder<T>`	`entity(T entity)` Sets the response entity body on the builder.
`GenericResponseBuilder<T>`	`entity(T entity, Annotation[] annotations)` Sets the response entity body on the builder.
`GenericResponseBuilder<T>`	`errorEntity(Object errorEntity)` Sets the response error entity body on the builder.
`GenericResponseBuilder<T>`	`errorEntity(Object errorEntity, Annotation[] annotations)` Sets the response error entity body on the builder.
`GenericResponseBuilder<T>`	`expires(Date expires)` Sets the expiration date for the response.
`GenericResponseBuilder<T>`	`header(String name, Object value)` Adds a header to the response.
`GenericResponseBuilder<T>`	`language(Locale language)` Sets the response language.
`GenericResponseBuilder<T>`	`language(String language)` Sets the response language.
`GenericResponseBuilder<T>`	`lastModified(Date lastModified)` Sets the response entity last modified date.
`GenericResponseBuilder<T>`	`link(String uri, String rel)` Adds a link header.
`GenericResponseBuilder<T>`	`link(URI uri, String rel)` Adds a link header.
`GenericResponseBuilder<T>`	`links(javax.ws.rs.core.Link... links)` Sets the link headers.
`GenericResponseBuilder<T>`	`location(URI location)` Sets the response location.
`GenericResponseBuilder<T>`	`replaceAll(javax.ws.rs.core.MultivaluedMap<String,Object> headers)` Replaces all of the headers with the these headers.
`GenericResponseBuilder<T>`	`status(int status)` Sets the HTTP status code on the builder.
`GenericResponseBuilder<T>`	`status(javax.ws.rs.core.Response.Status status)` Sets the HTTP status code on the builder.
`GenericResponseBuilder<T>`	`status(javax.ws.rs.core.Response.StatusType status)` Sets the HTTP status code on the builder.
`GenericResponseBuilder<T>`	`tag(javax.ws.rs.core.EntityTag tag)` Sets the response entity tag.
`GenericResponseBuilder<T>`	`tag(String tag)` Sets the response entity tag.
`GenericResponseBuilder<T>`	`type(javax.ws.rs.core.MediaType type)` Sets the response entity media type.
`GenericResponseBuilder<T>`	`type(String type)` Sets the response entity media type.
`GenericResponseBuilder<T>`	`variant(javax.ws.rs.core.Variant variant)` Sets the response variant data.
`GenericResponseBuilder<T>`	`variants(List<javax.ws.rs.core.Variant> variants)` Sets the variant list for the `Vary` header.
`GenericResponseBuilder<T>`	`variants(javax.ws.rs.core.Variant... variants)` Sets the variant list for the `Vary` header.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GenericResponseBuilder
```
protected GenericResponseBuilder(javax.ws.rs.core.Response.ResponseBuilder rawBuilder)
```
    Creates a new GenericResponseBuilder that delegates to the underlying rawBuilder.
- Method Detail
  - build
```
public GenericResponse<T> build()
```
    Return a new GenericResponse instance from the builder.
  - build
```
protected abstract GenericResponse<T> build(T body,
                                            javax.ws.rs.core.Response rawResponse)
```
    Creates a new GenericResponse instance from the provided body and rawResponse.
    
    Parameters:
    
    body - the entity body to build the GenericResponse with (may be null)
    
    rawResponse - the underlying raw response
  - status
```
public GenericResponseBuilder<T> status(int status)
```
    Sets the HTTP status code on the builder.
    
    Parameters:
    
    status - the HTTP status code
    
    Returns:
    
    this builder
  - status
```
public GenericResponseBuilder<T> status(javax.ws.rs.core.Response.Status status)
```
    Sets the HTTP status code on the builder.
    
    Parameters:
    
    status - the HTTP status code
    
    Returns:
    
    this builder
  - status
```
public GenericResponseBuilder<T> status(javax.ws.rs.core.Response.StatusType status)
```
    Sets the HTTP status code on the builder.
    
    Parameters:
    
    status - the HTTP status code
    
    Returns:
    
    this builder
  - entity
```
public GenericResponseBuilder<T> entity(T entity)
```
    Sets the response entity body on the builder.
    A specific media type can be set using the type(...) methods.
    
    Parameters:
    
    entity - the response entity body
    
    Returns:
    
    this builder
    
    See Also:
    
    type(MediaType), type(String)
  - entity
```
public GenericResponseBuilder<T> entity(T entity,
                                        Annotation[] annotations)
```
    Sets the response entity body on the builder.
    A specific media type can be set using the type(...) methods.
    
    Parameters:
    
    entity - the response entity body
    
    annotations - annotations, in addition to the annotations on the resource method returning the response, to be passed to the MessageBodyWriter
    
    Returns:
    
    this builder
    
    See Also:
    
    type(MediaType), type(String)
  - errorEntity
```
public GenericResponseBuilder<T> errorEntity(Object errorEntity)
```
    Sets the response error entity body on the builder.
    A specific media type can be set using the type(...) methods.
    
    Parameters:
    
    errorEntity - the response error entity body
    
    Returns:
    
    this builder
    
    See Also:
    
    type(MediaType), type(String)
  - errorEntity
```
public GenericResponseBuilder<T> errorEntity(Object errorEntity,
                                             Annotation[] annotations)
```
    Sets the response error entity body on the builder.
    A specific media type can be set using the type(...) methods.
    
    Parameters:
    
    errorEntity - the response error entity body
    
    annotations - annotations, in addition to the annotations on the resource method returning the response, to be passed to the MessageBodyWriter
    
    Returns:
    
    this builder
    
    See Also:
    
    type(MediaType), type(String)
  - allow
```
public GenericResponseBuilder<T> allow(String... methods)
```
    Set the list of allowed HTTP methods (e.g. GET, POST, etc.) for the resource.
    
    Parameters:
    
    methods - the HTTP methods that will be listed as allowed for the resource, null will clear list
    
    Returns:
    
    this builder
  - allow
```
public GenericResponseBuilder<T> allow(Set<String> methods)
```
    Set the list of allowed HTTP methods (e.g. GET, POST, etc.) for the resource.
    
    Parameters:
    
    methods - the HTTP methods that will be listed as allowed for the resource, null will clear list
    
    Returns:
    
    this builder
  - cacheControl
```
public GenericResponseBuilder<T> cacheControl(javax.ws.rs.core.CacheControl cacheControl)
```
    Sets the cache control data of the response.
    
    Parameters:
    
    cacheControl - the cache control data, null will clear any existing cache control data
    
    Returns:
    
    this builder
  - encoding
```
public GenericResponseBuilder<T> encoding(String encoding)
```
    Sets the encoding of the entity body.
    
    Parameters:
    
    encoding - the encoding of the entity body, null will clear the existing encoding
    
    Returns:
    
    this builder
  - header
```
public GenericResponseBuilder<T> header(String name,
                                        Object value)
```
    Adds a header to the response.
    
    Parameters:
    
    name - the header name
    
    value - the header value, null will clear any existing headers for the same name
    
    Returns:
    
    this builder
    
    See Also:
    
    Response.ResponseBuilder#header(String, Object)
  - replaceAll
```
public GenericResponseBuilder<T> replaceAll(javax.ws.rs.core.MultivaluedMap<String,Object> headers)
```
    Replaces all of the headers with the these headers.
    
    Parameters:
    
    headers - the new headers to be used, null to remove all existing headers
    
    Returns:
    
    this builder
  - language
```
public GenericResponseBuilder<T> language(String language)
```
    Sets the response language.
    
    Parameters:
    
    language - the language of the response, null will clear the language
    
    Returns:
    
    this builder
  - language
```
public GenericResponseBuilder<T> language(Locale language)
```
    Sets the response language.
    
    Parameters:
    
    language - the language of the response, null will clear the language
    
    Returns:
    
    this builder
  - type
```
public GenericResponseBuilder<T> type(javax.ws.rs.core.MediaType type)
```
    Sets the response entity media type.
    
    Parameters:
    
    type - the response entity media type, null will clear the media type
    
    Returns:
    
    this builder
  - type
```
public GenericResponseBuilder<T> type(String type)
```
    Sets the response entity media type.
    
    Parameters:
    
    type - the response entity media type, null will clear the media type
    
    Returns:
    
    this builder
  - variant
```
public GenericResponseBuilder<T> variant(javax.ws.rs.core.Variant variant)
```
    Sets the response variant data.
    The variant data includes the content type, language, and encoding.
    
    Parameters:
    
    variant - the variant data for the response, null will clear the variant (and associated values)
    
    Returns:
    
    this builder
    
    See Also:
    
    type(MediaType), language(Locale), encoding(String), Variant
  - contentLocation
```
public GenericResponseBuilder<T> contentLocation(URI location)
```
    Sets the content location.
    
    Parameters:
    
    location - the content location, null will clear the content location
    
    Returns:
    
    this builder
  - cookie
```
public GenericResponseBuilder<T> cookie(javax.ws.rs.core.NewCookie... cookies)
```
    Sets the response cookies.
    
    Parameters:
    
    cookies - the cookies for the response, null will clear the response cookies
    
    Returns:
    
    this builder
  - expires
```
public GenericResponseBuilder<T> expires(Date expires)
```
    Sets the expiration date for the response.
    
    Parameters:
    
    expires - the response expiration date, null clears the expires date
    
    Returns:
    
    this builder
  - lastModified
```
public GenericResponseBuilder<T> lastModified(Date lastModified)
```
    Sets the response entity last modified date.
    
    Parameters:
    
    lastModified - the date the response entity was last modified, null will clear the last modified date
    
    Returns:
    
    this builder
  - location
```
public GenericResponseBuilder<T> location(URI location)
```
    Sets the response location.
    
    Parameters:
    
    location - the response location, relative URIs will be converted to absolute URIs, null will clear the location
    
    Returns:
    
    this builder
  - tag
```
public GenericResponseBuilder<T> tag(javax.ws.rs.core.EntityTag tag)
```
    Sets the response entity tag.
    
    Parameters:
    
    tag - the response entity tag, null will clear the entity tag
    
    Returns:
    
    this builder
  - tag
```
public GenericResponseBuilder<T> tag(String tag)
```
    Sets the response entity tag.
    
    Parameters:
    
    tag - the response entity tag, null will clear the entity tag
    
    Returns:
    
    this builder
  - variants
```
public GenericResponseBuilder<T> variants(javax.ws.rs.core.Variant... variants)
```
    Sets the variant list for the Vary header.
    
    Parameters:
    
    variants - the list of variants for the Vary header, null will clear the variants.
    
    Returns:
    
    this builder
  - variants
```
public GenericResponseBuilder<T> variants(List<javax.ws.rs.core.Variant> variants)
```
    Sets the variant list for the Vary header.
    
    Parameters:
    
    variants - the list of variants for the Vary header, null will clear the variants.
    
    Returns:
    
    this builder
  - links
```
public GenericResponseBuilder<T> links(javax.ws.rs.core.Link... links)
```
    Sets the link headers.
    
    Parameters:
    
    links - the links to be added to the response headers, null will clear the link headers
    
    Returns:
    
    this builder
  - link
```
public GenericResponseBuilder<T> link(URI uri,
                                      String rel)
```
    Adds a link header.
    
    Parameters:
    
    uri - the URI of the link header
    
    rel - the value of the rel parameter
    
    Returns:
    
    this builder
  - link
```
public GenericResponseBuilder<T> link(String uri,
                                      String rel)
```
    Adds a link header.
    
    Parameters:
    
    uri - the URI of the link header
    
    rel - the value of the rel parameter
    
    Returns:
    
    this builder

Class GenericResponseBuilder<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GenericResponseBuilder

Method Detail

build

build

status

status

status

entity

entity

errorEntity

errorEntity

allow

allow

cacheControl

encoding

header

replaceAll

language

language

type

type

variant

contentLocation

cookie

expires

lastModified

location

tag

tag

variants

variants

links

link

link