com.gnostice.documents

Class ConverterBeginInputDocumentEvent

java.lang.Object

java.util.EventObject

com.gnostice.documents.ConverterEvent

com.gnostice.documents.ConverterBeginInputDocumentEvent

All Implemented Interfaces:

Serializable

public class ConverterBeginInputDocumentEvent
extends ConverterEvent

This class represents an event when a user class instance implementing the ConverterListener begins processing a document for conversion.

See Also:

ConverterListener.beginDocument(ConverterBeginInputDocumentEvent), Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConverterBeginInputDocumentEvent(Object source, ConverterJobInfoEvent jobInfo, ConverterInputDocumentInfoEvent inputDocumentInfo)

Method Summary

Modifier and Type	Method and Description
ConverterInputDocumentInfoEvent	getInputDocumentInfo() Returns details about the document to be converted.
boolean	isSkipDocument() Returns whether the current document is not set to be converted.
void	setSkipDocument(boolean skipDocument) Specifies whether current document should not be converted.

Methods inherited from class com.gnostice.documents.ConverterEvent

getJobInfo, isCancel, setCancel

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ConverterBeginInputDocumentEvent

public ConverterBeginInputDocumentEvent(Object source,
                                        ConverterJobInfoEvent jobInfo,
                                        ConverterInputDocumentInfoEvent inputDocumentInfo)

Method Detail

getInputDocumentInfo

public ConverterInputDocumentInfoEvent getInputDocumentInfo()

Returns details about the document to be converted.

Returns:

details about the document to be converted

isSkipDocument

public boolean isSkipDocument()

Returns whether the current document is not set to be converted.

Returns:

true if the document is not set to be converted; false if otherwise

setSkipDocument

public void setSkipDocument(boolean skipDocument)

Specifies whether current document should not be converted.

Parameters:

skipDocument - true if current document should not be converted; false if otherwise