com.levigo.jadice.demo.pagestash

Class PageStashWriter

java.lang.Object

com.levigo.jadice.demo.pagestash.PageStashWriter

Direct Known Subclasses:

FilePageStashWriter

public abstract class PageStashWriter
extends Object

Writes a stash of selected pages to some kind of holding area. This area acts as an "extended clipboard", holding stashes which can be uncovered and re-instantiated or added to existing documents later. The exact mechanism used to hold the stashes is up to sub-classes.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CURRENT_FORMAT_VERSION
static String	STASH_MIME_TYPE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PageStashWriter(DocumentMarshaller documentMarshaller)

Method Summary

Modifier and Type	Method and Description
abstract PageStash	writeStash(Document document, List<Page> pages) Write the given pages belonging to the given document as a PageStash.
void	writeStash(Document document, List<Page> pages, OutputStream os) Write a page stash to the given output stream.

Methods inherited from class java.lang.Object

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

Field Detail

STASH_MIME_TYPE

public static final String STASH_MIME_TYPE

See Also:

Constant Field Values

CURRENT_FORMAT_VERSION

public static final String CURRENT_FORMAT_VERSION

See Also:

Constant Field Values

Constructor Detail

PageStashWriter

protected PageStashWriter(DocumentMarshaller documentMarshaller)

Method Detail

writeStash

public abstract PageStash writeStash(Document document,
                                     List<Page> pages)
                              throws IOException

Write the given pages belonging to the given document as a PageStash. How this happens and where the stash ends up is up to implementors. Return a handle to the created page stash.

Parameters:

document - the document to which the pages belong

pages - the selected pages

Returns:

handle to the created stash

Throws:

IOException - in case of problems during writing

writeStash

public void writeStash(Document document,
                       List<Page> pages,
                       OutputStream os)
                throws IOException

Write a page stash to the given output stream. This method is intended primarily for subclasses implementing PageStashWriters but may also be used independently to create a compatible stash stream.

Parameters:

document - the document to which the pages belong

pages - the selected pages

os - sink to which the resulting bytes are written

Throws:

IOException - in case of problems during writing