GenericResponses (Beadledom (Parent) 2.7 API)

java.lang.Object
- com.cerner.beadledom.jaxrs.GenericResponses

```
public class GenericResponses
extends Object
```
A class that contains most of the static utility methods for GenericResponse corresponding to the utility methods from the Response class.
This utility class is needed because Java 6 does not allow static methods on interfaces.

Since:

1.3

Author:

John Leacox

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <T> GenericResponseBuilder<T>`	`accepted()` Create a new `GenericResponseBuilder` with an ACCEPTED status.
`static <T> GenericResponseBuilder<T>`	`accepted(T entity)` Create a new `GenericResponseBuilder` with a ACCEPTED status and the given entity body.
`static <T> GenericResponseBuilder<T>`	`created(T entity, URI location)` Create a new `GenericResponseBuilder` with a created status and the given entity body and location.
`static <T> GenericResponseBuilder<T>`	`fromResponse(GenericResponse<T> response)` Creates a new `GenericResponseBuilder` by performing a shallow copy of the existing response.
`static <T> GenericResponseBuilder<T>`	`noContent()` Create a new `GenericResponseBuilder` for an empty response.
`static <T> GenericResponseBuilder<T>`	`notAcceptable(List<javax.ws.rs.core.Variant> variants)` Create a new `GenericResponseBuilder` for a not acceptable response.
`static <T> GenericResponseBuilder<T>`	`notModified()` Create a new `GenericResponseBuilder` with a not-modified status.
`static <T> GenericResponseBuilder<T>`	`notModified(javax.ws.rs.core.EntityTag tag)` Create a new `GenericResponseBuilder` with a not-modified status.
`static <T> GenericResponseBuilder<T>`	`notModified(String tag)` Create a new `GenericResponseBuilder` with a not-modified status.
`static <T> GenericResponseBuilder<T>`	`ok()` Create a new `GenericResponseBuilder` with an OK status.
`static <T> GenericResponseBuilder<T>`	`ok(T entity)` Create a new `GenericResponseBuilder` with an OK status and the given entity body.
`static <T> GenericResponseBuilder<T>`	`ok(T entity, javax.ws.rs.core.MediaType type)` Create a new `GenericResponseBuilder` with an OK status and the given entity body and media type.
`static <T> GenericResponseBuilder<T>`	`ok(T entity, String type)` Create a new `GenericResponseBuilder` with an OK status and the given entity body and media type.
`static <T> GenericResponseBuilder<T>`	`ok(T entity, javax.ws.rs.core.Variant variant)` /** Create a new `GenericResponseBuilder` with an OK status and the given entity body and variant data.
`static <T> GenericResponseBuilder<T>`	`seeOther(URI location)` Create a new `GenericResponseBuilder` for a redirection.
`static <T> GenericResponseBuilder<T>`	`serverError()` Create a new `GenericResponseBuilder` with a server error status.
`static <T> GenericResponseBuilder<T>`	`status(int status)` Creates a new `GenericResponseBuilder` with the given HTTP status.
`static <T> GenericResponseBuilder<T>`	`status(int status, T entity)` Creates a new `GenericResponseBuilder` with the given HTTP status and entity body.
`static <T> GenericResponseBuilder<T>`	`status(javax.ws.rs.core.Response.Status status)` Creates a new `GenericResponseBuilder` with the given HTTP status.
`static <T> GenericResponseBuilder<T>`	`status(javax.ws.rs.core.Response.StatusType status)` Creates a new `GenericResponseBuilder` with the given HTTP status.
`static <T> GenericResponseBuilder<T>`	`temporaryRedirect(URI location)` Create a new `GenericResponseBuilder` for a temporary redirection.

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

- Method Detail
  - fromResponse
```
public static <T> GenericResponseBuilder<T> fromResponse(GenericResponse<T> response)
```
    Creates a new GenericResponseBuilder by performing a shallow copy of the existing response.
    
    Parameters:
    
    response - the GenericResponse to create a new builder from.
    
    Returns:
    
    a new builder
    
    See Also:
    
    Response.ResponseBuilder#fromResponse(Response)
  - status
```
public static <T> GenericResponseBuilder<T> status(javax.ws.rs.core.Response.StatusType status)
```
    Creates a new GenericResponseBuilder with the given HTTP status.
    
    Parameters:
    
    status - the response status.
    
    Returns:
    
    a new builder
  - status
```
public static <T> GenericResponseBuilder<T> status(javax.ws.rs.core.Response.Status status)
```
    Creates a new GenericResponseBuilder with the given HTTP status.
    
    Parameters:
    
    status - the response status.
    
    Returns:
    
    a new builder
  - status
```
public static <T> GenericResponseBuilder<T> status(int status)
```
    Creates a new GenericResponseBuilder with the given HTTP status.
    
    Parameters:
    
    status - the response status.
    
    Returns:
    
    a new builder
  - status
```
public static <T> GenericResponseBuilder<T> status(int status,
                                                   T entity)
```
    Creates a new GenericResponseBuilder with the given HTTP status and entity body.
    
    Parameters:
    
    status - the response status
    
    entity - the response entity
    
    Returns:
    
    a new builder
  - ok
```
public static <T> GenericResponseBuilder<T> ok()
```
    Create a new GenericResponseBuilder with an OK status.
    
    Returns:
    
    a new builder
  - ok
```
public static <T> GenericResponseBuilder<T> ok(T entity)
```
    Create a new GenericResponseBuilder with an OK status and the given entity body.
    
    Parameters:
    
    entity - the response entity
    
    Returns:
    
    a new builder
  - ok
```
public static <T> GenericResponseBuilder<T> ok(T entity,
                                               javax.ws.rs.core.MediaType type)
```
    Create a new GenericResponseBuilder with an OK status and the given entity body and media type.
    
    Parameters:
    
    entity - the response entity
    
    type - the response entity media type
    
    Returns:
    
    a new builder
  - ok
```
public static <T> GenericResponseBuilder<T> ok(T entity,
                                               String type)
```
    Create a new GenericResponseBuilder with an OK status and the given entity body and media type.
    
    Parameters:
    
    entity - the response entity
    
    type - the response entity media type
    
    Returns:
    
    a new builder
  - ok
```
public static <T> GenericResponseBuilder<T> ok(T entity,
                                               javax.ws.rs.core.Variant variant)
```
    /** Create a new GenericResponseBuilder with an OK status and the given entity body and variant data.
    The variant data includes the content type, language, and encoding.
    
    Parameters:
    
    entity - the response entity
    
    variant - the variant data
    
    Returns:
    
    a new builder
    
    See Also:
    
    Variant
  - serverError
```
public static <T> GenericResponseBuilder<T> serverError()
```
    Create a new GenericResponseBuilder with a server error status.
  - created
```
public static <T> GenericResponseBuilder<T> created(T entity,
                                                    URI location)
```
    Create a new GenericResponseBuilder with a created status and the given entity body and location.
    
    Parameters:
    
    entity - the response entity
    
    location - the URI of the newly created resource
    
    Returns:
    
    a new builder
  - accepted
```
public static <T> GenericResponseBuilder<T> accepted()
```
    Create a new GenericResponseBuilder with an ACCEPTED status.
    
    Returns:
    
    a new builder
  - accepted
```
public static <T> GenericResponseBuilder<T> accepted(T entity)
```
    Create a new GenericResponseBuilder with a ACCEPTED status and the given entity body.
    
    Parameters:
    
    entity - the response entity
    
    Returns:
    
    a new builder
  - noContent
```
public static <T> GenericResponseBuilder<T> noContent()
```
    Create a new GenericResponseBuilder for an empty response.
    
    Returns:
    
    a new builder
  - notModified
```
public static <T> GenericResponseBuilder<T> notModified()
```
    Create a new GenericResponseBuilder with a not-modified status.
    
    Returns:
    
    a new builder
  - notModified
```
public static <T> GenericResponseBuilder<T> notModified(javax.ws.rs.core.EntityTag tag)
```
    Create a new GenericResponseBuilder with a not-modified status.
    
    Parameters:
    
    tag - the entity tag of the unmodified entity
    
    Returns:
    
    a new builder
  - notModified
```
public static <T> GenericResponseBuilder<T> notModified(String tag)
```
    Create a new GenericResponseBuilder with a not-modified status.
    
    Parameters:
    
    tag - the entity tag of the unmodified entity
    
    Returns:
    
    a new builder
  - seeOther
```
public static <T> GenericResponseBuilder<T> seeOther(URI location)
```
    Create a new GenericResponseBuilder for a redirection.
    
    Parameters:
    
    location - the redirection URI
    
    Returns:
    
    a new builder
    
    See Also:
    
    Response.ResponseBuilder#seeOther(URI)
  - temporaryRedirect
```
public static <T> GenericResponseBuilder<T> temporaryRedirect(URI location)
```
    Create a new GenericResponseBuilder for a temporary redirection.
    
    Parameters:
    
    location - the redirection URI
    
    Returns:
    
    a new builder
    
    See Also:
    
    Response.ResponseBuilder#temporaryRedirect(URI)
  - notAcceptable
```
public static <T> GenericResponseBuilder<T> notAcceptable(List<javax.ws.rs.core.Variant> variants)
```
    Create a new GenericResponseBuilder for a not acceptable response.
    
    Parameters:
    
    variants - list of variants that were available
    
    Returns:
    
    a new builder

Class GenericResponses

Method Summary

Methods inherited from class java.lang.Object

Method Detail

fromResponse

status

status

status

status

ok

ok

ok

ok

ok

serverError

created

accepted

accepted

noContent

notModified

notModified

notModified

seeOther

temporaryRedirect

notAcceptable