org.apache.juneau.rest.helper

Class ResolvingReaderResource.Builder

java.lang.Object

org.apache.juneau.http.ReaderResource.Builder

org.apache.juneau.rest.helper.ResolvingReaderResource.Builder

Enclosing class:

ResolvingReaderResource

public static class ResolvingReaderResource.Builder
extends ReaderResource.Builder

Builder class for constructing ResolvingReaderResource objects.

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

Field Summary

Fields inherited from class org.apache.juneau.http.ReaderResource.Builder

cached, contents, headers, mediaType

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

varResolver

public ResolvingReaderResource.Builder varResolver(VarResolverSession varResolver)

Specifies the variable resolver to use for this resource.

Parameters:

varResolver - The variable resolver.

Returns:

This object (for method chaining).

mediaType

public ResolvingReaderResource.Builder mediaType(String mediaType)

Description copied from class: ReaderResource.Builder

Specifies the resource media type string.

Overrides:

mediaType in class ReaderResource.Builder

Parameters:

mediaType - The resource media type string.

Returns:

This object (for method chaining).

mediaType

public ResolvingReaderResource.Builder mediaType(MediaType mediaType)

Description copied from class: ReaderResource.Builder

Specifies the resource media type string.

Overrides:

mediaType in class ReaderResource.Builder

Parameters:

mediaType - The resource media type string.

Returns:

This object (for method chaining).

contents

public ResolvingReaderResource.Builder contents(Object... contents)

Description copied from class: ReaderResource.Builder

Specifies the contents for this resource.

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

Overrides:

contents in class ReaderResource.Builder

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 ResolvingReaderResource.Builder header(String name,
                                              Object value)

Description copied from class: ReaderResource.Builder

Specifies an HTTP response header value.

Overrides:

header in class ReaderResource.Builder

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 ResolvingReaderResource.Builder headers(Map<String,Object> headers)

Description copied from class: ReaderResource.Builder

Specifies HTTP response header values.

Overrides:

headers in class ReaderResource.Builder

Parameters:

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

Returns:

This object (for method chaining).

cached

public ResolvingReaderResource.Builder cached()

Description copied from class: ReaderResource.Builder

Specifies that this resource is intended to be cached.

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

Overrides:

cached in class ReaderResource.Builder

Returns:

This object (for method chaining).

build

public ResolvingReaderResource build()
                              throws IOException

Create a new ResolvingReaderResource using values in this builder.

Overrides:

build in class ReaderResource.Builder

Returns:

A new immutable ResolvingReaderResource object.

Throws:

IOException - Thrown by underlying stream.