com.screenscraper.events.extractor

Enum ExtractorPatternEventFireTime

java.lang.Object

java.lang.Enum<ExtractorPatternEventFireTime>

com.screenscraper.events.extractor.ExtractorPatternEventFireTime

All Implemented Interfaces:

EventFireTime<ExtractorPatternEventData>, java.io.Serializable, java.lang.Comparable<ExtractorPatternEventFireTime>

public enum ExtractorPatternEventFireTime
extends java.lang.Enum<ExtractorPatternEventFireTime>
implements EventFireTime<ExtractorPatternEventData>

Event firing times for extractor pattern events

Version:

6.0.55a

Enum Constant Summary

Enum Constants

Enum Constant and Description
AfterEachExtractorMatch After each match of an extractor.
AfterExtractorPattern After an extractor is applied (including after any scripts on it run)
AfterExtractorPatternAppliedButBeforeScripts After an extractor is applied (but before any scripts on it run -- including the after each pattern match scripts)
BeforeExtractorPattern Before an extractor is applied (including before any scripts on it run).

Method Summary

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

BeforeExtractorPattern

public static final ExtractorPatternEventFireTime BeforeExtractorPattern

Before an extractor is applied (including before any scripts on it run). The returned value should be a boolean and indicates whether the extractor should be run or not. Any non-boolean result is the same as true. Also note that regardless of whether the extractor will be run or not, the event for after extractor pattern will still be fired

AfterExtractorPatternAppliedButBeforeScripts

public static final ExtractorPatternEventFireTime AfterExtractorPatternAppliedButBeforeScripts

After an extractor is applied (but before any scripts on it run -- including the after each pattern match scripts)

AfterEachExtractorMatch

public static final ExtractorPatternEventFireTime AfterEachExtractorMatch

After each match of an extractor. This will be applied before any of the "After each pattern match" scripts are applied

AfterExtractorPattern

public static final ExtractorPatternEventFireTime AfterExtractorPattern

After an extractor is applied (including after any scripts on it run)

Method Detail

values

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

Returns:

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

valueOf

public static ExtractorPatternEventFireTime 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(ExtractorPatternEventData data)

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

Specified by:

getDefaultReturnValue in interface EventFireTime<ExtractorPatternEventData>

Parameters:

data - The default value to return

Returns:

The value to return by default