Package com.twelvemonkeys.io.ole2
Class CompoundDocument
java.lang.Object
com.twelvemonkeys.io.ole2.CompoundDocument
- All Implemented Interfaces:
AutoCloseable
Represents a read-only OLE2 compound document.
NOTE: This class is not synchronized. Accessing the document or its entries from different threads, will need synchronization on the document instance.
- Version:
- $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/ole2/CompoundDocument.java#4 $
- Author:
- Harald Kuhr, last modified by $Author: haku $
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final long
The epoch offset of CompoundDocument time stampsstatic final int
-
Constructor Summary
ConstructorsConstructorDescriptionCompoundDocument
(File file) Creates a (for now) read onlyCompoundDocument
.CompoundDocument
(InputStream pInput) Creates a read onlyCompoundDocument
.CompoundDocument
(ImageInputStream input) Creates a read onlyCompoundDocument
. -
Method Summary
Modifier and TypeMethodDescriptionstatic boolean
void
close()
This method will close the underlyingRandomAccessFile
if any, but will leave any stream created outside the document open.static long
toJavaTimeInMillis
(long pMSTime) Converts the given time stamp to standard Java time representation, milliseconds since January 1, 1970.toString()
-
Field Details
-
HEADER_SIZE
public static final int HEADER_SIZE- See Also:
-
EPOCH_OFFSET
public static final long EPOCH_OFFSETThe epoch offset of CompoundDocument time stamps- See Also:
-
-
Constructor Details
-
CompoundDocument
Creates a (for now) read onlyCompoundDocument
.Warning! You must invoke
close()
on the compound document created from this constructor when done, to avoid leaking file descriptors.- Parameters:
file
- the file to read from- Throws:
IOException
- if an I/O exception occurs while reading the header
-
CompoundDocument
Creates a read onlyCompoundDocument
.- Parameters:
pInput
- the input to read from.- Throws:
IOException
- if an I/O exception occurs while reading the header
-
CompoundDocument
Creates a read onlyCompoundDocument
.- Parameters:
input
- the input to read from- Throws:
IOException
- if an I/O exception occurs while reading the header
-
-
Method Details
-
close
This method will close the underlyingRandomAccessFile
if any, but will leave any stream created outside the document open.- Specified by:
close
in interfaceAutoCloseable
- Throws:
IOException
- if an I/O error occurs.- See Also:
-
canRead
-
getRootEntry
- Throws:
IOException
-
toString
-
toJavaTimeInMillis
public static long toJavaTimeInMillis(long pMSTime) Converts the given time stamp to standard Java time representation, milliseconds since January 1, 1970. The time stamp parameter is assumed to be in units of 100 nano seconds since January 1, 1601.If the timestamp is
0L
(meaning not specified), no conversion is done, to behave likejava.io.File
.- Parameters:
pMSTime
- an unsigned long value representing the time stamp (in units of 100 nano seconds since January 1, 1601).- Returns:
- the time stamp converted to Java time stamp in milliseconds,
or
0L
ifpMSTime == 0L
-