org.attribyte.api.http

Class ResponseBuilder

java.lang.Object

org.attribyte.api.http.ResponseBuilder

public class ResponseBuilder
extends java.lang.Object

Builds immutable HTTP responses.

Constructor Summary

Constructors

Constructor and Description
ResponseBuilder() Creates a response builder.
ResponseBuilder(int statusCode) Creates a response builder with a response code.
ResponseBuilder(int statusCode, byte[] body) Creates a response builder with a response code and body as bytes.
ResponseBuilder(int statusCode, ByteSource bodySource) Creates a response builder with a response code and body as a ByteSource.
ResponseBuilder(int statusCode, java.lang.String body) Creates a response builder with a response code and body as a string.

Method Summary

Modifier and Type	Method and Description
ResponseBuilder	addAttribute(java.lang.String name, java.lang.Object object) Adds an attribute.
ResponseBuilder	addAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes) Adds a map of attributes.
ResponseBuilder	addHeader(java.lang.String name, java.lang.String value) Adds a header.
ResponseBuilder	addHeaders(java.util.Map<?,?> headerMap) Adds a map of headers.
Response	create() Creates an immutable response.
StreamedResponse	createStreamed() Creates an immutable streamed response.
ResponseBuilder	putHeaders(java.util.Collection<Header> headers) Adds a collection of headers.
ResponseBuilder	setBody(byte[] body) Sets the response body bytes.
ResponseBuilder	setBody(ByteSource body) Sets a ByteSource for the response body.
ResponseBuilder	setBody(java.lang.String body) Sets the response body as a string.
ResponseBuilder	setStatusCode(int statusCode) Sets the response code.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResponseBuilder

public ResponseBuilder()

Creates a response builder.

ResponseBuilder

public ResponseBuilder(int statusCode)

Creates a response builder with a response code.

Parameters:

statusCode - The response code.

ResponseBuilder

public ResponseBuilder(int statusCode,
                       byte[] body)

Creates a response builder with a response code and body as bytes.

Parameters:

statusCode - The response code.

body - The response body.

ResponseBuilder

public ResponseBuilder(int statusCode,
                       java.lang.String body)

Creates a response builder with a response code and body as a string.

Parameters:

statusCode - The response code.

body - The response body.

ResponseBuilder

public ResponseBuilder(int statusCode,
                       ByteSource bodySource)

Creates a response builder with a response code and body as a ByteSource.

Parameters:

statusCode - The response code.

bodySource - The response body source.

Method Detail

setStatusCode

public ResponseBuilder setStatusCode(int statusCode)

Sets the response code.

Parameters:

statusCode - The response code.

Returns:

A self-reference.

setBody

public ResponseBuilder setBody(byte[] body)

Sets the response body bytes.

Parameters:

body - The body.

Returns:

A self-reference.

setBody

public ResponseBuilder setBody(java.lang.String body)

Sets the response body as a string.

Parameters:

body - The body.

Returns:

A self-reference.

setBody

public ResponseBuilder setBody(ByteSource body)

Sets a ByteSource for the response body.

Parameters:

body - The body byte source.

Returns:

A self-reference.

create

public Response create()

Creates an immutable response.

Returns:

The response.

createStreamed

public StreamedResponse createStreamed()

Creates an immutable streamed response.

Returns:

The response.

addHeader

public ResponseBuilder addHeader(java.lang.String name,
                                 java.lang.String value)

Adds a header.

Parameters:

name - The header name.

value - The header value.

Returns:

A self-reference.

putHeaders

public ResponseBuilder putHeaders(java.util.Collection<Header> headers)

Adds a collection of headers.

Parameters:

headers - The headers to add.

Returns:

A self-reference.

addHeaders

public ResponseBuilder addHeaders(java.util.Map<?,?> headerMap)

Adds a map of headers.

Parameters:

headerMap - The map of headers.

Returns:

A self-reference.

addAttribute

public ResponseBuilder addAttribute(java.lang.String name,
                                    java.lang.Object object)

Adds an attribute.

Parameters:

name - The attribute name.

object - The attribute value.

Returns:

A self-reference.

addAttributes

public ResponseBuilder addAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)

Adds a map of attributes.

Parameters:

attributes - The map of attributes.

Returns:

A self-reference.