com.orientechnologies.orient.core.hook

Enum ORecordHook.SCOPE

java.lang.Object

java.lang.Enum<ORecordHook.SCOPE>

com.orientechnologies.orient.core.hook.ORecordHook.SCOPE

All Implemented Interfaces:

Serializable, Comparable<ORecordHook.SCOPE>

Enclosing interface:

ORecordHook

public static enum ORecordHook.SCOPE
extends Enum<ORecordHook.SCOPE>

Defines available scopes for scoped hooks.

Basically, each scope defines some subset of ORecordHook.TYPE, this limits the set of events the hook interested in and lowers the number of useless hook invocations.

See Also:

ORecordHook.getScopes()

Enum Constant Summary

Enum Constants

Enum Constant and Description
CREATE The create scope, includes: ORecordHook.TYPE.BEFORE_CREATE, ORecordHook.TYPE.AFTER_CREATE, ORecordHook.TYPE.FINALIZE_CREATION, ORecordHook.TYPE.CREATE_REPLICATED and ORecordHook.TYPE.CREATE_FAILED.
DELETE The delete scope, includes: ORecordHook.TYPE.BEFORE_DELETE, ORecordHook.TYPE.AFTER_DELETE, ORecordHook.TYPE.DELETE_REPLICATED, ORecordHook.TYPE.DELETE_FAILED and ORecordHook.TYPE.FINALIZE_DELETION.
READ The read scope, includes: ORecordHook.TYPE.BEFORE_READ, ORecordHook.TYPE.AFTER_READ, ORecordHook.TYPE.READ_REPLICATED and ORecordHook.TYPE.READ_FAILED.
UPDATE The update scope, includes: ORecordHook.TYPE.BEFORE_UPDATE, ORecordHook.TYPE.AFTER_UPDATE, ORecordHook.TYPE.FINALIZE_UPDATE, ORecordHook.TYPE.UPDATE_REPLICATED and ORecordHook.TYPE.UPDATE_FAILED.

Method Summary

Modifier and Type	Method and Description
static ORecordHook.SCOPE	typeToScope(ORecordHook.TYPE type) Maps the ORecordHook.TYPE to ORecordHook.SCOPE.
static ORecordHook.SCOPE	valueOf(String name) Returns the enum constant of this type with the specified name.
static ORecordHook.SCOPE[]	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

CREATE

public static final ORecordHook.SCOPE CREATE

The create scope, includes: ORecordHook.TYPE.BEFORE_CREATE, ORecordHook.TYPE.AFTER_CREATE, ORecordHook.TYPE.FINALIZE_CREATION, ORecordHook.TYPE.CREATE_REPLICATED and ORecordHook.TYPE.CREATE_FAILED.

READ

public static final ORecordHook.SCOPE READ

The read scope, includes: ORecordHook.TYPE.BEFORE_READ, ORecordHook.TYPE.AFTER_READ, ORecordHook.TYPE.READ_REPLICATED and ORecordHook.TYPE.READ_FAILED.

UPDATE

public static final ORecordHook.SCOPE UPDATE

The update scope, includes: ORecordHook.TYPE.BEFORE_UPDATE, ORecordHook.TYPE.AFTER_UPDATE, ORecordHook.TYPE.FINALIZE_UPDATE, ORecordHook.TYPE.UPDATE_REPLICATED and ORecordHook.TYPE.UPDATE_FAILED.

DELETE

public static final ORecordHook.SCOPE DELETE

The delete scope, includes: ORecordHook.TYPE.BEFORE_DELETE, ORecordHook.TYPE.AFTER_DELETE, ORecordHook.TYPE.DELETE_REPLICATED, ORecordHook.TYPE.DELETE_FAILED and ORecordHook.TYPE.FINALIZE_DELETION.

Method Detail

values

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

Returns:

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

valueOf

public static ORecordHook.SCOPE valueOf(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:

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

NullPointerException - if the argument is null

typeToScope

public static ORecordHook.SCOPE typeToScope(ORecordHook.TYPE type)

Maps the ORecordHook.TYPE to ORecordHook.SCOPE.

Parameters:

type - the hook type to map.

Returns:

the mapped scope.