org.mule.runtime.extension.api.loader

Enum DeclarationEnricherPhase

java.lang.Object

java.lang.Enum<DeclarationEnricherPhase>

org.mule.runtime.extension.api.loader.DeclarationEnricherPhase

All Implemented Interfaces:

Serializable, Comparable<DeclarationEnricherPhase>

public enum DeclarationEnricherPhase
extends Enum<DeclarationEnricherPhase>

These phases are use to execute the enrichers in order, grouping them by phases.

Each DeclarationEnricherPhase describes a particular enrichment state from which DeclarationEnrichers can take advantage of.

Since:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
FINALIZE Final phase of DeclarationEnrichers to be executed, enrichers that for some reason should execute at the end of the chain should go in this phase.
INITIALIZE First phase of DeclarationEnrichers to be executed.
LAYOUT This phase contains all DeclarationEnrichers that add display elements to the final enriched extension.
POST_STRUCTURE This phase contains all DeclarationEnrichers that go over the final extension structure and add metadata and properties to the declared elements.
STRUCTURE This phase contains all DeclarationEnrichers that enrich the extension with additional elements, for example adding common parameters.
WIRING This phase contains all DeclarationEnrichers that ensure consistency among elements, required by enrichers in the phase, linking objects created by the STRUCTURE phase together.

Method Summary

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

INITIALIZE

public static final DeclarationEnricherPhase INITIALIZE

First phase of DeclarationEnrichers to be executed.

Basic settings that doesn't change the structure of the loaded extension but are required before the structure enrichment phase is executed should go in this phase.

DeclarationEnrichers added to this phase should not add or change the structure of the extension nor change/add any configuration to the different elements that were loaded (Connections, Configs, Parameters, Etc)

STRUCTURE

public static final DeclarationEnricherPhase STRUCTURE

This phase contains all DeclarationEnrichers that enrich the extension with additional elements, for example adding common parameters.

WIRING

public static final DeclarationEnricherPhase WIRING

This phase contains all DeclarationEnrichers that ensure consistency among elements, required by enrichers in the phase, linking objects created by the STRUCTURE phase together.

POST_STRUCTURE

public static final DeclarationEnricherPhase POST_STRUCTURE

This phase contains all DeclarationEnrichers that go over the final extension structure and add metadata and properties to the declared elements.

LAYOUT

public static final DeclarationEnricherPhase LAYOUT

This phase contains all DeclarationEnrichers that add display elements to the final enriched extension.

FINALIZE

public static final DeclarationEnricherPhase FINALIZE

Final phase of DeclarationEnrichers to be executed, enrichers that for some reason should execute at the end of the chain should go in this phase.

Method Detail

values

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

Returns:

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

valueOf

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