org.sonar.api.batch

Interface DecoratorBarriers

public interface DecoratorBarriers

Barriers are used to define the order of execution of Decorators. Decorators must be annotated with the following :

• @DependsUpon(BARRIER) in order to be executed after BARRIER
• @DependedUpon(BARRIER) in order to be executed before BARRIER

Since:

2.3

Field Summary

Fields

Modifier and Type	Field and Description
static String	END_OF_TIME_MACHINE Any kinds of time machine data are calculated before this barrier.
static String	END_OF_VIOLATION_PERSISTENCE Deprecated. in 3.6. Issues are persisted at the end of analysis
static String	END_OF_VIOLATION_TRACKING Deprecated. in 3.6. Replaced by ISSUES_TRACKED
static String	END_OF_VIOLATIONS_GENERATION Deprecated. in 3.6. Replaced by ISSUES_ADDED
static String	ISSUES_ADDED This barrier is before ISSUES_TRACKED.
static String	ISSUES_TRACKED This barrier is after ISSUES_ADDED.
static String	START_VIOLATION_PERSISTENCE Deprecated. in 3.6. Issues are persisted at the end of analysis.
static String	START_VIOLATION_TRACKING Deprecated. in 3.6. Not required anymore.
static String	START_VIOLATIONS_GENERATION Deprecated. in 3.6. Not required anymore.

Field Detail

ISSUES_ADDED

static final String ISSUES_ADDED

This barrier is before ISSUES_TRACKED. The decorators that register issues must be declared before this barrier : @DependedUpon(value=DecoratorBarriers.ISSUES_ADDED)

Since:

3.6

See Also:

Constant Field Values

ISSUES_TRACKED

static final String ISSUES_TRACKED

This barrier is after ISSUES_ADDED. The decorators that need to list all issues must be declared after this barrier : @DependsUpon(value=DecoratorBarriers.ISSUES_TRACKED)

Since:

3.6

See Also:

Constant Field Values

START_VIOLATIONS_GENERATION

@Deprecated
static final String START_VIOLATIONS_GENERATION

Deprecated. in 3.6. Not required anymore.

See Also:

Constant Field Values

END_OF_VIOLATIONS_GENERATION

@Deprecated
static final String END_OF_VIOLATIONS_GENERATION

Deprecated. in 3.6. Replaced by ISSUES_ADDED

This barrier is used by a decorator in order to :

• be executed after all the decorators which generate violations : @DependsUpon(value=DecoratorBarriers.END_OF_VIOLATIONS_GENERATION
• declare that it generates violations : @DependedUpon(value=DecoratorBarriers.END_OF_VIOLATIONS_GENERATION

See Also:

Constant Field Values

START_VIOLATION_TRACKING

@Deprecated
static final String START_VIOLATION_TRACKING

Deprecated. in 3.6. Not required anymore.

Extensions which call the method Violation#setSwitchedOff must be executed before this barrier (@DependedUpon(value=DecoratorBarriers.VIOLATION_TRACKING)

This barrier is after END_OF_VIOLATIONS_GENERATION

Since:

2.8

See Also:

Constant Field Values

END_OF_VIOLATION_TRACKING

@Deprecated
static final String END_OF_VIOLATION_TRACKING

Deprecated. in 3.6. Replaced by ISSUES_TRACKED

This barrier is after END_OF_VIOLATIONS_GENERATION and START_VIOLATION_TRACKING. Decorators executed after this barrier (@DependsUpon(value=DecoratorBarriers.END_OF_VIOLATION_TRACKING) can benefit from all the features of violation tracking :

• Violation#getCreatedAt()
• Violation#isSwitchedOff(), usually to know if a violation has been flagged as false-positives in UI

Since:

2.8

See Also:

Constant Field Values

START_VIOLATION_PERSISTENCE

@Deprecated
static final String START_VIOLATION_PERSISTENCE

Deprecated. in 3.6. Issues are persisted at the end of analysis.

Since:

2.13

See Also:

Constant Field Values

END_OF_VIOLATION_PERSISTENCE

@Deprecated
static final String END_OF_VIOLATION_PERSISTENCE

Deprecated. in 3.6. Issues are persisted at the end of analysis

Since:

2.13

See Also:

Constant Field Values

END_OF_TIME_MACHINE

static final String END_OF_TIME_MACHINE

Any kinds of time machine data are calculated before this barrier. Decorators executed after this barrier can use Measure#getVariationValue() method.

Since:

2.5

See Also:

Constant Field Values