com.screenscraper.datamanager

Enum DataManagerEventSource.EventFireTime

java.lang.Object

java.lang.Enum<DataManagerEventSource.EventFireTime>

com.screenscraper.datamanager.DataManagerEventSource.EventFireTime

All Implemented Interfaces:

EventFireTime<DataManagerEvent>, java.io.Serializable, java.lang.Comparable<DataManagerEventSource.EventFireTime>

Enclosing class:

DataManagerEventSource

public static enum DataManagerEventSource.EventFireTime
extends java.lang.Enum<DataManagerEventSource.EventFireTime>
implements EventFireTime<DataManagerEvent>

A set of possible event fire times

Enum Constant Summary

Enum Constants

Enum Constant and Description
afterWrite called immediately after the DataNode is written (DataWriter.write), at this point any values that the write has added are present.
onAddData called whenever DataManager.addData is called
onCommit called when DataManager.commit is called, after nodes are linked together
onCreate called whenever the DataManager creates a new DataNode (DataManager.getNewDataNode)
onInsert Called immediately before a write is performed
onNothingToUpdate Called after values are checked for an update call and there is nothing to be updated so no write will occur.
onUpdate Called when values are to be updated in the underlying datasource as opposed to written as new values
onUpdatingValues Called after values are checked for an update call and there is something to be updated.
onWrite called immediately before the DataNode is written (DataWriter.write), after all internal data transformations, additions
onWriteError Called when the data manager receives an exception on a write

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getDefaultReturnValue(DataManagerEvent data) Gets the default value to return for this time from the data
static DataManagerEventSource.EventFireTime	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DataManagerEventSource.EventFireTime[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

onCreate

public static final DataManagerEventSource.EventFireTime onCreate

called whenever the DataManager creates a new DataNode (DataManager.getNewDataNode)

onWrite

public static final DataManagerEventSource.EventFireTime onWrite

called immediately before the DataNode is written (DataWriter.write), after all internal data transformations, additions

onUpdate

public static final DataManagerEventSource.EventFireTime onUpdate

Called when values are to be updated in the underlying datasource as opposed to written as new values

onNothingToUpdate

public static final DataManagerEventSource.EventFireTime onNothingToUpdate

Called after values are checked for an update call and there is nothing to be updated so no write will occur. Note modifying the node at this point does nothing.

Since:

7.0.12a

onUpdatingValues

public static final DataManagerEventSource.EventFireTime onUpdatingValues

Called after values are checked for an update call and there is something to be updated. Note modifying the node at this point does nothing to the write that is about to happen

Since:

7.0.12a

afterWrite

public static final DataManagerEventSource.EventFireTime afterWrite

called immediately after the DataNode is written (DataWriter.write), at this point any values that the write has added are present. Setting the node to aborted status will cause the write to be rolled back if that operation is supported by the database

onCommit

public static final DataManagerEventSource.EventFireTime onCommit

called when DataManager.commit is called, after nodes are linked together

onAddData

public static final DataManagerEventSource.EventFireTime onAddData

called whenever DataManager.addData is called

onInsert

public static final DataManagerEventSource.EventFireTime onInsert

Called immediately before a write is performed

onWriteError

public static final DataManagerEventSource.EventFireTime onWriteError

Called when the data manager receives an exception on a write

Method Detail

values

public static DataManagerEventSource.EventFireTime[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DataManagerEventSource.EventFireTime c : DataManagerEventSource.EventFireTime.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DataManagerEventSource.EventFireTime valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getDefaultReturnValue

@Nullable
public java.lang.Object getDefaultReturnValue(DataManagerEvent data)

Description copied from interface: EventFireTime

Gets the default value to return for this time from the data

Specified by:

getDefaultReturnValue in interface EventFireTime<DataManagerEvent>

Parameters:

data - The event data

Returns:

The value to return by default