uk.co.lothianproductions.httpd.document
Class Document

java.lang.Object
  uk.co.lothianproductions.httpd.document.Document

public abstract class Document

extends java.lang.Object

Represents a Document as served by a RequestHandler. Documents can be obtained from the DocumentSource.

Version:

$Revision: 1.9 $, $Date: 2004/01/02 19:01:33 $

Author:

Aidan Fitzpatrick

Constructor Summary

Document()

Method Summary

abstract long	length() Returns the rendered Document's length.
abstract java.io.InputStream	render(java.lang.String[][] parameters) Renders the Document to an InputStream using the passed parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

Document

public Document()

Method Detail

render

public abstract java.io.InputStream render(java.lang.String[][] parameters)
                                    throws ConfigException,
                                           DocumentRenderException

Renders the Document to an InputStream using the passed parameters.

Throws:

ConfigException

DocumentRenderException

length

public abstract long length()

Returns the rendered Document's length. Given that the Document length can vary depending on the arguments given to the Document as it's rendered the length method should only be called after the Document has been rendered. Returns -1 if the Document's length has not or could not be measured.