org.apache.jackrabbit.server.io

Class AbstractExportContext

java.lang.Object

org.apache.jackrabbit.server.io.AbstractExportContext

All Implemented Interfaces:

ExportContext, IOContext

Direct Known Subclasses:

ExportContextImpl

public abstract class AbstractExportContext
extends Object
implements ExportContext

AbstractExportContext covers methods common to most ExportContext implementations.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	completed

Constructor Summary

Constructors

Constructor and Description
AbstractExportContext(Item exportRoot, boolean hasStream, IOListener ioListener)

Method Summary

Modifier and Type	Method and Description
protected void	checkCompleted()
Item	getExportRoot() Returns the item to be exported
IOListener	getIOListener() Returns the IOListener.
boolean	hasStream() Return true if the given export context can provide an output stream
void	informCompleted(boolean success) Informs this context that it will not be used for further exports any more.
boolean	isCompleted() Returns true if this context already has been completed.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.jackrabbit.server.io.ExportContext

getOutputStream, setContentLanguage, setContentLength, setContentType, setCreationTime, setETag, setModificationTime, setProperty

Field Detail

completed

protected boolean completed

Constructor Detail

AbstractExportContext

public AbstractExportContext(Item exportRoot,
                             boolean hasStream,
                             IOListener ioListener)

Method Detail

getIOListener

public IOListener getIOListener()

Description copied from interface: IOContext

Returns the IOListener.

Specified by:

getIOListener in interface IOContext

getExportRoot

public Item getExportRoot()

Description copied from interface: ExportContext

Returns the item to be exported

Specified by:

getExportRoot in interface ExportContext

hasStream

public boolean hasStream()

Description copied from interface: IOContext

Return true if the given export context can provide an output stream

Specified by:

hasStream in interface IOContext

informCompleted

public void informCompleted(boolean success)

Description copied from interface: IOContext

Informs this context that it will not be used for further exports any more. A boolean flag indicates about the success of the export.

Specified by:

informCompleted in interface IOContext

isCompleted

public boolean isCompleted()

Description copied from interface: IOContext

Returns true if this context already has been completed.

Specified by:

isCompleted in interface IOContext

Returns:

true if this context already has been completed.

checkCompleted

protected void checkCompleted()