com.screenscraper.events.misc

Enum StringOperationEventFireTime

java.lang.Object

java.lang.Enum<StringOperationEventFireTime>

com.screenscraper.events.misc.StringOperationEventFireTime

All Implemented Interfaces:

EventFireTime<StringEventData>, java.io.Serializable, java.lang.Comparable<StringOperationEventFireTime>

public enum StringOperationEventFireTime
extends java.lang.Enum<StringOperationEventFireTime>
implements EventFireTime<StringEventData>

Event Firing times for miscellaneous string operations

Version:

6.0.55a

Enum Constant Summary

Enum Constants

Enum Constant and Description
HttpParameterEncodeKey Called when an http parameter key (GET or POST) is encoded.
HttpParameterEncodeValue Called when an http parameter value (GET or POST) is encoded.

Method Summary

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

HttpParameterEncodeKey

public static final StringOperationEventFireTime HttpParameterEncodeKey

Called when an http parameter key (GET or POST) is encoded. The input string will be the value that is already encoded, and the return value should be the value to actually use

HttpParameterEncodeValue

public static final StringOperationEventFireTime HttpParameterEncodeValue

Called when an http parameter value (GET or POST) is encoded. The input string will be the value that is already encoded, and the return value should be the value to actually use

Method Detail

values

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

Returns:

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

valueOf

public static StringOperationEventFireTime 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(@NotNull
                                                         StringEventData data)

Description copied from interface: EventFireTime

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

Specified by:

getDefaultReturnValue in interface EventFireTime<StringEventData>

Parameters:

data - The event data

Returns:

The value to return by default