Package com.atlassian.oai.validator.model

Class SimpleResponse.Builder

java.lang.Object

com.atlassian.oai.validator.model.SimpleResponse.Builder

Enclosing class:

SimpleResponse

public static class SimpleResponse.Builder
extends Object

A builder for constructing new SimpleResponse instances.

Constructor Summary

Constructors

Constructor	Description
Builder(int status)	Creates a SimpleResponse.Builder with the given HTTP status code.

Method Summary

Modifier and Type	Method	Description
static SimpleResponse.Builder	badRequest()	A convenience method for creating a SimpleResponse.Builder with the HTTP status code 400.
SimpleResponse	build()	Builds a SimpleResponse out of this builder.
static SimpleResponse.Builder	noContent()	A convenience method for creating a SimpleResponse.Builder with the HTTP status code 204.
static SimpleResponse.Builder	notFound()	A convenience method for creating a SimpleResponse.Builder with the HTTP status code 404.
static SimpleResponse.Builder	ok()	A convenience method for creating a SimpleResponse.Builder with the HTTP status code 200.
static SimpleResponse.Builder	serverError()	A convenience method for creating a SimpleResponse.Builder with the HTTP status code 500.
static SimpleResponse.Builder	status(int status)	Creates a SimpleResponse.Builder with the given HTTP status code.
static SimpleResponse.Builder	unauthorized()	A convenience method for creating a SimpleResponse.Builder with the HTTP status code 401.
SimpleResponse.Builder	withBody(byte[] content)	Adds a response body as byte array to this builder.
SimpleResponse.Builder	withBody(InputStream content)	Adds a response body as InputStream to this builder.
SimpleResponse.Builder	withBody(String content)	Adds a response body to this builder.
SimpleResponse.Builder	withBody(String content, Charset charset)	Adds a response body as String and its Charset to this builder.
SimpleResponse.Builder	withContentType(String contentType)	Sets the content type header on this builder.
SimpleResponse.Builder	withHeader(String name, String... values)	Adds a response header to this builder.
SimpleResponse.Builder	withHeader(String name, List<String> values)	Adds a response header to this builder.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(int status)

Creates a SimpleResponse.Builder with the given HTTP status code.

Parameters:

status - the responses HTTP status code

Method Details

status

public static SimpleResponse.Builder status(int status)

Creates a SimpleResponse.Builder with the given HTTP status code.

Parameters:

status - the responses HTTP status code

Returns:

a prepared SimpleResponse.Builder

ok

public static SimpleResponse.Builder ok()

A convenience method for creating a SimpleResponse.Builder with the HTTP status code 200.

Returns:

a prepared SimpleResponse.Builder

noContent

public static SimpleResponse.Builder noContent()

A convenience method for creating a SimpleResponse.Builder with the HTTP status code 204.

Returns:

a prepared SimpleResponse.Builder

badRequest

public static SimpleResponse.Builder badRequest()

A convenience method for creating a SimpleResponse.Builder with the HTTP status code 400.

Returns:

a prepared SimpleResponse.Builder

unauthorized

public static SimpleResponse.Builder unauthorized()

A convenience method for creating a SimpleResponse.Builder with the HTTP status code 401.

Returns:

a prepared SimpleResponse.Builder

notFound

public static SimpleResponse.Builder notFound()

A convenience method for creating a SimpleResponse.Builder with the HTTP status code 404.

Returns:

a prepared SimpleResponse.Builder

serverError

public static SimpleResponse.Builder serverError()

A convenience method for creating a SimpleResponse.Builder with the HTTP status code 500.

Returns:

a prepared SimpleResponse.Builder

withBody

public SimpleResponse.Builder withBody(String content)

Adds a response body to this builder.

The charset of the response body will be extracted from the content-type header during build(). If no such header is specified UTF-8 is used.

For better performance use withBody(byte[]) or withBody(InputStream) if possible.

Parameters:

content - the response body

Returns:

this builder

See Also:

• withBody(String, Charset)

withBody

public SimpleResponse.Builder withBody(String content,
 Charset charset)

Adds a response body as String and its Charset to this builder.

For better performance use withBody(byte[]) or withBody(InputStream) if possible.

Parameters:

content - the request body

charset - the Charset of the request body

Returns:

this builder

withBody

public SimpleResponse.Builder withBody(byte[] content)

Adds a response body as byte array to this builder.

Parameters:

content - the response body

Returns:

this builder

withBody

public SimpleResponse.Builder withBody(InputStream content)

Adds a response body as InputStream to this builder.

Parameters:

content - the response body stream

Returns:

this builder

withHeader

public SimpleResponse.Builder withHeader(String name,
 List<String> values)

Adds a response header to this builder. If there was already a header with this name the values will be added.

Headers are treated case insensitive.

Parameters:

name - the header name

values - the values for this header

Returns:

this builder

withHeader

public SimpleResponse.Builder withHeader(String name,
 String... values)

Adds a response header to this builder. If there was already a header with this name the values will be added.

Headers are treated case insensitive.

Parameters:

name - the header name

values - the values for this header

Returns:

this builder

withContentType

public SimpleResponse.Builder withContentType(String contentType)

Sets the content type header on this builder.

Equivalent to:

withHeader("Content-Type", contentType);

Parameters:

contentType - The content type to set

Returns:

this builder

build

public SimpleResponse build()

Builds a SimpleResponse out of this builder.

Returns:

the build SimpleResponse