org.springframework.extensions.surf.resource

Interface ResourceContent

All Known Subinterfaces:

ResourceJSONContent, ResourceXMLContent

All Known Implementing Classes:

ResourceContentImpl, ResourceJSONContentImpl, ResourceXMLContentImpl

public interface ResourceContent

Interface to describe content around a Resource.

Author:

muzquiano, kevinr

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getBytes() Gets the bytes.
InputStream	getInputStream() Retrieves an input stream to the resource content.
Reader	getReader() Gets the reader for the resource content.
Resource	getResource() A link back to the resource of which this content is a part.
String	getStringContent() Returns the String content for the resource.

Method Detail

getResource

Resource getResource()

A link back to the resource of which this content is a part.

Returns:

Resource

getBytes

byte[] getBytes()
                throws IOException

Gets the bytes. Use with caution only, if you know the content encoding.

Returns:

the bytes

Throws:

IOException

getInputStream

InputStream getInputStream()
                           throws IOException

Retrieves an input stream to the resource content. Use with caution only, if you know the content encoding.

Returns:

the input stream

Throws:

IOException - Signals that an I/O exception has occurred.

getReader

Reader getReader()
                 throws IOException

Gets the reader for the resource content. Reader will use the appropriate character encoding as specified in the resource response.

Returns:

the reader

Throws:

IOException - Signals that an I/O exception has occurred.

getStringContent

String getStringContent()
                        throws IOException

Returns the String content for the resource. Will use the appropriate character encoding as specified in the resource response.

Returns:

String content for the resource

Throws:

IOException - Signals that an I/O exception has occurred.