Top Description Fields Constructors Methods

org.apache.poi.poifs.filesystem

public Class POIFSWriterEvent

Class Inheritance

extends Object

java.lang.Object
org.apache.poi.poifs.filesystem.POIFSWriterEvent

Class POIFSWriterEvent

Field Summary

Modifier and Type	Field and Description
private String	documentName
private int	limit
private POIFSDocumentPath	path
private DocumentOutputStream	stream

Constructor Summary

Access	Constructor and Description
pack-priv	POIFSWriterEvent(final DocumentOutputStream the DocumentOutputStream, freshly opened stream, final POIFSDocumentPath the path of the document path, final String the name of the document documentName, final int the limit, in bytes, that can be written to the stream limit) package scoped constructor

Method Summary

Modifier and Type	Method and Description
public int	Returns: the limit on writing, in bytes getLimit()
public String	Returns: the document's name getName()
public POIFSDocumentPath	Returns: the document's path getPath()
public DocumentOutputStream	Returns: the DocumentOutputStream, freshly opened getStream()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

documentName	back to summary
private String documentName

limit	back to summary
private int limit

path	back to summary
private POIFSDocumentPath path

stream	back to summary
private DocumentOutputStream stream

Constructor Detail

POIFSWriterEvent

back to summary

pack-priv POIFSWriterEvent(final DocumentOutputStream stream, final POIFSDocumentPath path, final String documentName, final int limit)

package scoped constructor

Parameters

stream:DocumentOutputStream: the DocumentOutputStream, freshly opened
path:POIFSDocumentPath: the path of the document
documentName:String: the name of the document
limit:int: the limit, in bytes, that can be written to the stream

Method Detail

getLimit	back to summary
public int getLimit() Returns:int the limit on writing, in bytes

getName	back to summary
public String getName() Returns:String the document's name

getPath	back to summary
public POIFSDocumentPath getPath() Returns:POIFSDocumentPath the document's path

getStream	back to summary
public DocumentOutputStream getStream() Returns:DocumentOutputStream the DocumentOutputStream, freshly opened