org.apache.juneau.http

Class StreamResource.Builder

java.lang.Object

org.apache.juneau.http.StreamResource.Builder

Enclosing class:

StreamResource

public static class StreamResource.Builder
extends Object

Builder class for constructing StreamResource objects.

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

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

Constructor Detail

Builder

public Builder()

Method Detail

mediaType

public StreamResource.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 StreamResource.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 StreamResource.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:

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

Returns:

This object (for method chaining).

header

public StreamResource.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 StreamResource.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 StreamResource.Builder cached()

Specifies that this resource is intended to be cached.

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

Returns:

This object (for method chaining).

build

public StreamResource build()
                     throws IOException

Create a new StreamResource using values in this builder.

Returns:

A new immutable StreamResource object.

Throws:

IOException - Thrown by underlying stream.