com.sun.jersey.api
Class JResponse.JResponseBuilder<E>

java.lang.Object
  com.sun.jersey.api.JResponse.AJResponseBuilder<E,JResponse.JResponseBuilder<E>>
      com.sun.jersey.api.JResponse.JResponseBuilder<E>

Type Parameters:

E - The entity type

Enclosing class:

JResponse<E>

public static final class JResponse.JResponseBuilder<E>
extends JResponse.AJResponseBuilder<E,JResponse.JResponseBuilder<E>>

A class used to build JResponse instances that contain metadata instead of or in addition to an entity. An initial instance may be obtained via static methods of the JResponse class, instance methods provide the ability to set metadata. E.g. to create a response that indicates the creation of a new resource:

@POST
 JResponse addWidget(...) {
   Widget w = ...
   URI widgetId = UriBuilder.fromResource(Widget.class)...
   return JResponse.created(widgetId).build();
 }

Several methods have parameters of type URI, UriBuilder provides convenient methods to create such values as does URI.create().

Where multiple variants of the same method are provided, the type of the supplied parameter is retained in the metadata of the built JResponse.

JResponse.JResponseBuilder

public JResponse.JResponseBuilder()

Default constructor.

JResponse.JResponseBuilder

public JResponse.JResponseBuilder(JResponse.JResponseBuilder<E> that)

Construct a shallow copy. The metadata map will be copied but not the key/value references.

Parameters:

that - the JResponseBuilder to copy from.

clone

public JResponse.JResponseBuilder<E> clone()

Create a shallow copy preserving state. The metadata map will be copied but not the key/value references.

Overrides:

clone in class java.lang.Object

Returns:

the copy.

build

public JResponse<E> build()

Create a JResponse instance from the current JResponseBuilder. The builder is reset to a blank state equivalent to calling JResponse.ok().

Returns:

a JResponse instance