loci.poi.poifs.filesystem

Class POIFSWriterEvent

java.lang.Object

loci.poi.poifs.filesystem.POIFSWriterEvent

public class POIFSWriterEvent
extends Object

Class POIFSWriterEvent

Version:

%I%, %G%

Author:

Marc Johnson (mjohnson at apache dot org)

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
POIFSWriterEvent(DocumentOutputStream stream, POIFSDocumentPath path, String documentName, int limit) package scoped constructor

Method Summary

Methods

Modifier and Type	Method and Description
int	getLimit()
String	getName()
POIFSDocumentPath	getPath()
DocumentOutputStream	getStream()

Methods inherited from class java.lang.Object

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

Field Detail

stream

private DocumentOutputStream stream

path

private POIFSDocumentPath path

documentName

private String documentName

limit

private int limit

Constructor Detail

POIFSWriterEvent

POIFSWriterEvent(DocumentOutputStream stream,
                POIFSDocumentPath path,
                String documentName,
                int limit)

package scoped constructor

Parameters:

stream - the DocumentOutputStream, freshly opened

path - the path of the document

documentName - the name of the document

limit - the limit, in bytes, that can be written to the stream

Method Detail

getStream

public DocumentOutputStream getStream()

Returns:

the DocumentOutputStream, freshly opened

getPath

public POIFSDocumentPath getPath()

Returns:

the document's path

getName

public String getName()

Returns:

the document's name

getLimit

public int getLimit()

Returns:

the limit on writing, in bytes