Top Description Constructors Methods
org.apache.poi

public abstract Class POIReadOnlyDocument

extends POIDocument
Class Inheritance
Imports
java.io.File, .OutputStream, org.apache.poi.poifs.filesystem.DirectoryNode, .POIFSFileSystem
This holds the common functionality for all read-only POI Document classes, i.e. ones which don't support writing.
Since
POI 3.15 beta 3

Constructor Summary

AccessConstructor and Description
protected
POIReadOnlyDocument(DirectoryNode dir)

protected
POIReadOnlyDocument(POIFSFileSystem fs)

Method Summary

Modifier and TypeMethod and Description
private static void
notImplemented()

public void
write()

Implements abstract org.apache.poi.POIDocument.write.

Note - writing is not yet supported for this file format, sorry.

public void
write(File
The new File to write to.
file)

Implements abstract org.apache.poi.POIDocument.write.

Note - writing is not yet supported for this file format, sorry.

public void
write(OutputStream
The stream to write to.
out)

Implements abstract org.apache.poi.POIDocument.write.

Note - writing is not yet supported for this file format, sorry.

Inherited from org.apache.poi.POIDocument:
clearDirectoryclosecreateInformationPropertiesgetDirectorygetDocumentSummaryInformationgetEncryptedPropertyStreamNamegetEncryptionInfogetPropertySetgetPropertySetgetSummaryInformationinitDirectoryreadPropertiesreadPropertiesreplaceDirectoryvalidateInPlaceWritePossiblewritePropertieswritePropertieswriteProperties

Constructor Detail

POIReadOnlyDocumentback to summary
protected POIReadOnlyDocument(DirectoryNode dir)
POIReadOnlyDocumentback to summary
protected POIReadOnlyDocument(POIFSFileSystem fs)

Method Detail

notImplementedback to summary
private static void notImplemented()
writeback to summary
public void write()

Implements abstract org.apache.poi.POIDocument.write.

Note - writing is not yet supported for this file format, sorry.

Annotations
@Override
Exceptions
IllegalStateException:
If you call the method, as writing is not supported
writeback to summary
public void write(File file)

Implements abstract org.apache.poi.POIDocument.write.

Note - writing is not yet supported for this file format, sorry.

Parameters
file:File

Doc from org.apache.poi.POIDocument.write.

The new File to write to.

Annotations
@Override
Exceptions
IllegalStateException:
If you call the method, as writing is not supported
writeback to summary
public void write(OutputStream out)

Implements abstract org.apache.poi.POIDocument.write.

Note - writing is not yet supported for this file format, sorry.

Parameters
out:OutputStream

Doc from org.apache.poi.POIDocument.write.

The stream to write to.

Annotations
@Override
Exceptions
IllegalStateException:
If you call the method, as writing is not supported