org.apache.juneau.http

Class ReaderResource.Builder

java.lang.Object

org.apache.juneau.http.ReaderResource.Builder

Direct Known Subclasses:

ResolvingReaderResource.Builder

Enclosing class:

ReaderResource

public static class ReaderResource.Builder
extends Object

Builder class for constructing ReaderResource objects.

• Overview > juneau-rest-server > @RestMethod > ReaderResource

Field Summary

Fields

Modifier and Type	Field and Description
boolean	cached
ArrayList<Object>	contents
Map<String,Object>	headers
MediaType	mediaType

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ReaderResource	build() Create a new ReaderResource using values in this builder.
ReaderResource.Builder	cached() Specifies that this resource is intended to be cached.
ReaderResource.Builder	contents(Object... contents) Specifies the contents for this resource.
ReaderResource.Builder	header(String name, Object value) Specifies an HTTP response header value.
ReaderResource.Builder	headers(Map<String,Object> headers) Specifies HTTP response header values.
ReaderResource.Builder	mediaType(MediaType mediaType) Specifies the resource media type string.
ReaderResource.Builder	mediaType(String mediaType) Specifies the resource media type string.

Methods inherited from class java.lang.Object

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

Field Detail

contents

public ArrayList<Object> contents

mediaType

public MediaType mediaType

headers

public Map<String,Object> headers

cached

public boolean cached

Constructor Detail

Builder

public Builder()

Method Detail

mediaType

public ReaderResource.Builder mediaType(String mediaType)

Specifies the resource media type string.

Parameters:

mediaType - The resource media type string.

Returns:

This object (for method chaining).

mediaType

public ReaderResource.Builder mediaType(MediaType mediaType)

Specifies the resource media type string.

Parameters:

mediaType - The resource media type string.

Returns:

This object (for method chaining).

contents

public ReaderResource.Builder contents(Object... contents)

Specifies the contents for this resource.

This method can be called multiple times to add more content.

Parameters:

contents - The resource contents.
If multiple contents are specified, the results will be concatenated.
Contents can be any of the following:

• InputStream
• Reader - Converted to UTF-8 bytes.
• File
• CharSequence - Converted to UTF-8 bytes.

Returns:

This object (for method chaining).

header

public ReaderResource.Builder header(String name,
                                     Object value)

Specifies an HTTP response header value.

Parameters:

name - The HTTP header name.

value - The HTTP header value.
Will be converted to a String using Object.toString().

Returns:

This object (for method chaining).

headers

public ReaderResource.Builder headers(Map<String,Object> headers)

Specifies HTTP response header values.

Parameters:

headers - The HTTP headers.
Values will be converted to Strings using Object.toString().

Returns:

This object (for method chaining).

cached

public ReaderResource.Builder cached()

Specifies that this resource is intended to be cached.

This will trigger the contents to be loaded into a String for fast serializing.

Returns:

This object (for method chaining).

build

public ReaderResource build()
                     throws IOException

Create a new ReaderResource using values in this builder.

Returns:

A new immutable ReaderResource object.

Throws:

IOException - Thrown by underlying stream.