org.mule.runtime.api.meta.model.parameter

Enum ParameterRole

java.lang.Object

java.lang.Enum<ParameterRole>

org.mule.runtime.api.meta.model.parameter.ParameterRole

All Implemented Interfaces:

Serializable, Comparable<ParameterRole>

public enum ParameterRole
extends Enum<ParameterRole>

Represents the possible roles that each parameter plays in the context of a ParameterizedModel

Since:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
BEHAVIOUR Indicates that the parameter is only configuring the component's behaviour and doesn't represent data that is being sent to another endpoint
CONTENT Indicates that this parameter holds information to be considered content to be sent to a different system or endpoint.
PRIMARY_CONTENT Indicates that this parameter holds the main piece of content to be sent to another system or endpoint.

Method Summary

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

BEHAVIOUR

public static final ParameterRole BEHAVIOUR

Indicates that the parameter is only configuring the component's behaviour and doesn't represent data that is being sent to another endpoint

CONTENT

public static final ParameterRole CONTENT

Indicates that this parameter holds information to be considered content to be sent to a different system or endpoint. It makes sense to use this when the operation has many content parameters but this one is not the PRIMARY_CONTENT

PRIMARY_CONTENT

public static final ParameterRole PRIMARY_CONTENT

Indicates that this parameter holds the main piece of content to be sent to another system or endpoint. This differentiation becomes specially important when the component has many content parameters. If the component only has one content parameter, then this role will be used to mark such parameter

Method Detail

values

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

Returns:

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

valueOf

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