org.dellroad.stuff.vaadin7

Class WritableResource

java.lang.Object

com.vaadin.server.StreamResource

org.dellroad.stuff.vaadin7.WritableResource

All Implemented Interfaces:

ConnectorResource, Resource, Serializable, WriteCallback

public abstract class WritableResource
extends StreamResource
implements WriteCallback

Support superclass for StreamResource implementations that can be more easily implemented by writing to an OutputStream than providing an InputStream.

See Also:

Vaadin Ticket #5145, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.server.StreamResource

StreamResource.StreamSource

Field Summary

Fields inherited from interface com.vaadin.server.ConnectorResource

CONNECTOR_PATH

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WritableResource(String filename) Constructor.
protected	WritableResource(String filename, String mimeType) Convenience constructor that also sets the MIME type.

Method Summary

Modifier and Type	Method and Description
abstract void	writeTo(OutputStream output) Write the resource contents to the given OutputStream and then close it.

Methods inherited from class com.vaadin.server.StreamResource

equals, getBufferSize, getCacheTime, getFilename, getMIMEType, getStream, getStreamSource, hashCode, setBufferSize, setCacheTime, setFilename, setMIMEType, setStreamSource

Methods inherited from class java.lang.Object

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

Constructor Detail

WritableResource

protected WritableResource(String filename)

Constructor.

Parameters:

filename - resource file name

WritableResource

protected WritableResource(String filename,
                           String mimeType)

Convenience constructor that also sets the MIME type.

Parameters:

filename - resource file name

mimeType - resource MIME type

Method Detail

writeTo

public abstract void writeTo(OutputStream output)
                      throws IOException

Write the resource contents to the given OutputStream and then close it.

Note that the VaadinSession associated with this resource will not be locked when this method is invoked.

Specified by:

writeTo in interface WriteCallback

Parameters:

output - resource output stream

Throws:

IOException - if an I/O error occurs