Class ObjectPlusFilesInputStream

java.lang.Object

java.io.InputStream

java.io.ObjectInputStream

org.archive.io.ObjectPlusFilesInputStream

All Implemented Interfaces:

Closeable, DataInput, ObjectInput, ObjectStreamConstants, AutoCloseable

public class ObjectPlusFilesInputStream
extends ObjectInputStream

Enhanced ObjectOutputStream with support for restoring files that had been saved, in parallel with object serialization.

Author:

gojomo

Nested Class Summary

Nested classes/interfaces inherited from class java.io.ObjectInputStream

ObjectInputStream.GetField

Field Summary

Fields

Modifier and Type	Field	Description
protected LinkedList<File>	auxiliaryDirectoryStack
protected LinkedList<Runnable>	postRestoreTasks

Fields inherited from interface java.io.ObjectStreamConstants

baseWireHandle, PROTOCOL_VERSION_1, PROTOCOL_VERSION_2, SC_BLOCK_DATA, SC_ENUM, SC_EXTERNALIZABLE, SC_SERIALIZABLE, SC_WRITE_METHOD, STREAM_MAGIC, STREAM_VERSION, SUBCLASS_IMPLEMENTATION_PERMISSION, SUBSTITUTION_PERMISSION, TC_ARRAY, TC_BASE, TC_BLOCKDATA, TC_BLOCKDATALONG, TC_CLASS, TC_CLASSDESC, TC_ENDBLOCKDATA, TC_ENUM, TC_EXCEPTION, TC_LONGSTRING, TC_MAX, TC_NULL, TC_OBJECT, TC_PROXYCLASSDESC, TC_REFERENCE, TC_RESET, TC_STRING

Constructor Summary

Constructors

Constructor	Description
ObjectPlusFilesInputStream(InputStream in, File storeDir)	Instantiate over the given stream and using the supplied auxiliary storage directory.

Method Summary

Modifier and Type	Method	Description
void	close()	In addition to default, do any registered cleanup tasks.
File	getAuxiliaryDirectory()	Return the top auxiliary directory, from which saved files are restored.
void	popAuxiliaryDirectory()	Discard the top auxiliary directory.
void	pushAuxiliaryDirectory(String dir)	Push another default storage directory for use until popped.
void	registerFinishTask(Runnable task)	Register a task to be done when the ObjectPlusFilesInputStream is closed.
void	restoreFile(File destination)	Restore a file from storage, using the name and length info on the serialization stream and the file from the current auxiliary directory, to the given File.
void	restoreFileTo(File directory)	Restore a file from storage, using the name and length info on the serialization stream and the file from the current auxiliary directory, to the given File.

Methods inherited from class java.io.ObjectInputStream

available, defaultReadObject, enableResolveObject, read, read, readBoolean, readByte, readChar, readClassDescriptor, readDouble, readFields, readFloat, readFully, readFully, readInt, readLine, readLong, readObject, readObjectOverride, readShort, readStreamHeader, readUnshared, readUnsignedByte, readUnsignedShort, readUTF, registerValidation, resolveClass, resolveObject, resolveProxyClass, skipBytes

Methods inherited from class java.io.InputStream

mark, markSupported, read, reset, skip

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.ObjectInput

read, skip

Field Details

auxiliaryDirectoryStack

protected LinkedList<File> auxiliaryDirectoryStack

postRestoreTasks

protected LinkedList<Runnable> postRestoreTasks

Constructor Details

ObjectPlusFilesInputStream

public ObjectPlusFilesInputStream(InputStream in,
 File storeDir)
                           throws IOException

Instantiate over the given stream and using the supplied auxiliary storage directory.

Parameters:

in -

storeDir -

Throws:

IOException

Method Details

pushAuxiliaryDirectory

public void pushAuxiliaryDirectory(String dir)

Push another default storage directory for use until popped.

Parameters:

dir -

popAuxiliaryDirectory

public void popAuxiliaryDirectory()

Discard the top auxiliary directory.

getAuxiliaryDirectory

public File getAuxiliaryDirectory()

Return the top auxiliary directory, from which saved files are restored.

Returns:

Auxillary directory.

restoreFile

public void restoreFile(File destination)
                 throws IOException

Restore a file from storage, using the name and length info on the serialization stream and the file from the current auxiliary directory, to the given File.

Parameters:

destination -

Throws:

IOException

restoreFileTo

public void restoreFileTo(File directory)
                   throws IOException

Restore a file from storage, using the name and length info on the serialization stream and the file from the current auxiliary directory, to the given File.

Parameters:

directory -

Throws:

IOException

registerFinishTask

public void registerFinishTask(Runnable task)

Register a task to be done when the ObjectPlusFilesInputStream is closed.

Parameters:

task -

close

public void close()
           throws IOException

In addition to default, do any registered cleanup tasks.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface ObjectInput

Overrides:

close in class ObjectInputStream

Throws:

IOException

See Also:

• InputStream.close()