Package com.itextpdf.commons.actions

Class AbstractProductProcessITextEvent

java.lang.Object

com.itextpdf.commons.actions.AbstractITextEvent

com.itextpdf.commons.actions.AbstractProductITextEvent

com.itextpdf.commons.actions.AbstractContextBasedITextEvent

com.itextpdf.commons.actions.AbstractProductProcessITextEvent

All Implemented Interfaces:

IEvent

Direct Known Subclasses:

AbstractEventWrapper, ITextCoreProductEvent

public abstract class AbstractProductProcessITextEvent
extends AbstractContextBasedITextEvent

Abstract class which defines product process event. Only for internal usage.

Field Summary

Fields

Modifier and Type	Field	Description
private final EventConfirmationType	confirmationType
private final WeakReference<SequenceId>	sequenceId

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractProductProcessITextEvent(ProductData productData, IMetaInfo metaInfo, EventConfirmationType confirmationType)	Creates an event which is not associated with any object.
protected	AbstractProductProcessITextEvent(SequenceId sequenceId, ProductData productData, IMetaInfo metaInfo, EventConfirmationType confirmationType)	Creates an event associated with SequenceId.

Method Summary

Modifier and Type	Method	Description
EventConfirmationType	getConfirmationType()	Retrieves an event confirmation type.
abstract String	getEventType()	Returns an event type.
SequenceId	getSequenceId()	Retrieves an identifier of event source.

Methods inherited from class com.itextpdf.commons.actions.AbstractContextBasedITextEvent

getClassFromContext, getMetaInfo, setMetaInfo

Methods inherited from class com.itextpdf.commons.actions.AbstractProductITextEvent

getProductData, getProductName

Methods inherited from class com.itextpdf.commons.actions.AbstractITextEvent

registerNamespace

Methods inherited from class java.lang.Object

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

Field Details

sequenceId

private final WeakReference<SequenceId> sequenceId

confirmationType

private final EventConfirmationType confirmationType

Constructor Details

AbstractProductProcessITextEvent

protected AbstractProductProcessITextEvent(SequenceId sequenceId,
 ProductData productData,
 IMetaInfo metaInfo,
 EventConfirmationType confirmationType)

Creates an event associated with SequenceId. It may contain auxiliary meta data.

Parameters:

sequenceId - is a general identifier for the event

productData - is a description of the product which has generated an event

metaInfo - is an auxiliary meta info

confirmationType - defines when the event should be confirmed to notify that the associated process has finished successfully

AbstractProductProcessITextEvent

protected AbstractProductProcessITextEvent(ProductData productData,
 IMetaInfo metaInfo,
 EventConfirmationType confirmationType)

Creates an event which is not associated with any object. It may contain auxiliary meta data.

Parameters:

productData - is a description of the product which has generated an event

metaInfo - is an auxiliary meta info

confirmationType - defines when the event should be confirmed to notify that the associated process has finished successfully

Method Details

getSequenceId

public SequenceId getSequenceId()

Retrieves an identifier of event source.

Returns:

an identifier of event source

getEventType

public abstract String getEventType()

Returns an event type.

Returns:

event type

getConfirmationType

public EventConfirmationType getConfirmationType()

Retrieves an event confirmation type.

Returns:

value of event confirmation type which defines when the event should be confirmed to notify that the associated process has finished successfully