com.espertech.esper.client.annotation
Enum AuditEnum

java.lang.Object
  java.lang.Enum<AuditEnum>
      com.espertech.esper.client.annotation.AuditEnum

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AuditEnum>

public enum AuditEnum
extends java.lang.Enum<AuditEnum>

Enumeration of audit values. Since audits may be a comma-separate list in a single @Audit annotation they are listed as enumeration values here.

Enum Constant Summary

CONTEXTPARTITION
For use with insert-into audit.

DATAFLOW_OP
For use with data flow (non-source and source) operators.

DATAFLOW_SOURCE
For use with data flow source operators.

DATAFLOW_TRANSITION
For use with data flows specifically for transitions.

EXPRDEF
For use with expression-definition audit.

EXPRESSION
For use with expression audit.

EXPRESSION_NESTED
For use with expression audit.

INSERT
For use with insert-into audit.

PATTERN
For use with pattern audit.

PATTERNINSTANCES
For use with pattern audit.

PROPERTY
For use with property audit.

SCHEDULE
For use with schedule-audit.

STREAM
For use with stream-audit.

VIEW
For use with view audit.

Method Summary

Audit	getAudit(java.lang.annotation.Annotation[] annotations) Check if the hint is present in the annotations provided.
java.lang.String	getPrettyPrintText() Returns text used for the category of the audit log item.
java.lang.String	getValue() Returns the constant.
static AuditEnum	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AuditEnum[]	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

PROPERTY

public static final AuditEnum PROPERTY

For use with property audit.

EXPRESSION

public static final AuditEnum EXPRESSION

For use with expression audit.

EXPRESSION_NESTED

public static final AuditEnum EXPRESSION_NESTED

For use with expression audit.

EXPRDEF

public static final AuditEnum EXPRDEF

For use with expression-definition audit.

VIEW

public static final AuditEnum VIEW

For use with view audit.

PATTERN

public static final AuditEnum PATTERN

For use with pattern audit.

PATTERNINSTANCES

public static final AuditEnum PATTERNINSTANCES

For use with pattern audit.

STREAM

public static final AuditEnum STREAM

For use with stream-audit.

SCHEDULE

public static final AuditEnum SCHEDULE

For use with schedule-audit.

INSERT

public static final AuditEnum INSERT

For use with insert-into audit.

DATAFLOW_SOURCE

public static final AuditEnum DATAFLOW_SOURCE

For use with data flow source operators.

DATAFLOW_OP

public static final AuditEnum DATAFLOW_OP

For use with data flow (non-source and source) operators.

DATAFLOW_TRANSITION

public static final AuditEnum DATAFLOW_TRANSITION

For use with data flows specifically for transitions.

CONTEXTPARTITION

public static final AuditEnum CONTEXTPARTITION

For use with insert-into audit.

Method Detail

values

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

Returns:

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

valueOf

public static AuditEnum 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

getValue

public java.lang.String getValue()

Returns the constant.

Returns:

constant

getPrettyPrintText

public java.lang.String getPrettyPrintText()

Returns text used for the category of the audit log item.

Returns:

category name

getAudit

public Audit getAudit(java.lang.annotation.Annotation[] annotations)

Check if the hint is present in the annotations provided.

Parameters:

annotations - the annotations to inspect

Returns:

indicator