org.apache.juneau.rest.helper

Class ResolvingReaderResource

java.lang.Object

org.apache.juneau.http.ReaderResource

org.apache.juneau.rest.helper.ResolvingReaderResource

All Implemented Interfaces:

Writable

public class ResolvingReaderResource
extends ReaderResource

An extension of ReaderResource that allows automatic resolution of SVL variables.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResolvingReaderResource.Builder Builder class for constructing ResolvingReaderResource objects.

Field Summary

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

contents

Constructor Summary

Constructors

Modifier	Constructor and Description
	ResolvingReaderResource(MediaType mediaType, Map<String,Object> headers, boolean cached, VarResolverSession varSession, Object... contents) Constructor.
protected	ResolvingReaderResource(ResolvingReaderResource.Builder b) Constructor.

Method Summary

Modifier and Type	Method and Description
static ResolvingReaderResource.Builder	create() Creates a new instance of a ResolvingReaderResource.Builder for this class.
Writer	writeTo(Writer w) Serialize this object to the specified writer.

Methods inherited from class org.apache.juneau.http.ReaderResource

getContents, getHeaders, getMediaType, toCommentStrippedString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ResolvingReaderResource

protected ResolvingReaderResource(ResolvingReaderResource.Builder b)
                           throws IOException

Constructor.

Parameters:

b - Builder containing values to initialize this object with.

Throws:

IOException - Thrown by underlying stream.

ResolvingReaderResource

public ResolvingReaderResource(MediaType mediaType,
                               Map<String,Object> headers,
                               boolean cached,
                               VarResolverSession varSession,
                               Object... contents)
                        throws IOException

Constructor.

Parameters:

mediaType - The resource media type.

headers - The HTTP response headers for this streamed resource.

varSession - Optional variable resolver for resolving variables in the string.

cached - Identifies if this resource is cached in memory.
If true, the contents will be loaded into a String for fast retrieval.

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.

Throws:

IOException - Thrown by underlying stream.

Method Detail

create

public static ResolvingReaderResource.Builder create()

Creates a new instance of a ResolvingReaderResource.Builder for this class.

Returns:

A new instance of a ResolvingReaderResource.Builder.

writeTo

@ResponseBody
public Writer writeTo(Writer w)
                             throws IOException

Description copied from interface: Writable

Serialize this object to the specified writer.

Specified by:

writeTo in interface Writable

Overrides:

writeTo in class ReaderResource

Parameters:

w - The writer to write to.

Returns:

The same writer passed in.

Throws:

IOException - Thrown by underlying stream.