com.screenscraper.datamanager

Enum DataManagerSchemalessEvent.FireTime

java.lang.Object

java.lang.Enum<DataManagerSchemalessEvent.FireTime>

com.screenscraper.datamanager.DataManagerSchemalessEvent.FireTime

All Implemented Interfaces:

EventFireTime<DataManagerSchemalessEvent>, java.io.Serializable, java.lang.Comparable<DataManagerSchemalessEvent.FireTime>

Enclosing class:

DataManagerSchemalessEvent

public static enum DataManagerSchemalessEvent.FireTime
extends java.lang.Enum<DataManagerSchemalessEvent.FireTime>
implements EventFireTime<DataManagerSchemalessEvent>

Enum Constant Summary

Enum Constants

Enum Constant and Description
onFlushEnd Fired after writing all data.
onFlushStart Fired when beginning to write the data.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getDefaultReturnValue(DataManagerSchemalessEvent data) Gets the default value to return for this time from the data
static DataManagerSchemalessEvent.FireTime	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DataManagerSchemalessEvent.FireTime[]	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

onFlushStart

public static final DataManagerSchemalessEvent.FireTime onFlushStart

Fired when beginning to write the data. This will fire from the thread where the write will occur, but fires before any writing occurs and before the connection for writing has been acquired (where applicable)

onFlushEnd

public static final DataManagerSchemalessEvent.FireTime onFlushEnd

Fired after writing all data. This will fire from the thread where the write occurred, but fires after all writing occurs and after the connection for writing has been released (where applicable)

Method Detail

values

public static DataManagerSchemalessEvent.FireTime[] 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 (DataManagerSchemalessEvent.FireTime c : DataManagerSchemalessEvent.FireTime.values())
    System.out.println(c);

Returns:

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

valueOf

public static DataManagerSchemalessEvent.FireTime 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(DataManagerSchemalessEvent data)

Description copied from interface: EventFireTime

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

Specified by:

getDefaultReturnValue in interface EventFireTime<DataManagerSchemalessEvent>

Parameters:

data - The event data

Returns:

The value to return by default