Module org.mule.sdk.api

Package org.mule.sdk.api.annotation.route

Enum Class ChainExecutionOccurrence

java.lang.Object

java.lang.Enum<ChainExecutionOccurrence>

org.mule.sdk.api.annotation.route.ChainExecutionOccurrence

All Implemented Interfaces:

Serializable, Comparable<ChainExecutionOccurrence>, Constable

@MinMuleVersion("4.7")
@DoNotEnforceMinMuleVersion
public enum ChainExecutionOccurrence
extends Enum<ChainExecutionOccurrence>

Describes how many times the inner chain in a scope or route is expected to be called each time the owning component is executed.

Since:

1.7.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AT_LEAST_ONCE	Chain may be executed multiple times, but will for sure be executed at least once
MULTIPLE_OR_NONE	Chain may be executed multiple times or non at all
ONCE	Chain execution may not be skipped, but will only be executed once
ONCE_OR_NONE	Chain execution may be skipped, but will not be executed more than once
UNKNOWN	The owning component does not provide information about how the chain will be used.

Method Summary

Modifier and Type	Method	Description
static ChainExecutionOccurrence	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ChainExecutionOccurrence[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ONCE_OR_NONE

public static final ChainExecutionOccurrence ONCE_OR_NONE

Chain execution may be skipped, but will not be executed more than once

ONCE

public static final ChainExecutionOccurrence ONCE

Chain execution may not be skipped, but will only be executed once

AT_LEAST_ONCE

public static final ChainExecutionOccurrence AT_LEAST_ONCE

Chain may be executed multiple times, but will for sure be executed at least once

MULTIPLE_OR_NONE

public static final ChainExecutionOccurrence MULTIPLE_OR_NONE

Chain may be executed multiple times or non at all

UNKNOWN

public static final ChainExecutionOccurrence UNKNOWN

The owning component does not provide information about how the chain will be used. This is the default value that legacy components will return

Method Details

values

public static ChainExecutionOccurrence[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ChainExecutionOccurrence valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null