org.mule.tooling.client.api.extension.model.parameter

Class ParameterRole

java.lang.Object

org.mule.tooling.client.api.types.UnknownType

org.mule.tooling.client.api.extension.model.parameter.ParameterRole

public class ParameterRole
extends UnknownType

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

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
ParameterRole(String value)

Method Summary

Modifier and Type	Method and Description
static ParameterRole	behaviourParameterRole(String value)
static ParameterRole	contentParameterRole(String value)
boolean	isBehaviour()
boolean	isContent()
boolean	isPrimaryContent()
static ParameterRole	primaryContentParameterRole(String value)

Methods inherited from class org.mule.tooling.client.api.types.UnknownType

equals, getValue, hashCode, isUnknown, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ParameterRole

public ParameterRole(String value)

Method Detail

behaviourParameterRole

public static ParameterRole behaviourParameterRole(String value)

contentParameterRole

public static ParameterRole contentParameterRole(String value)

primaryContentParameterRole

public static ParameterRole primaryContentParameterRole(String value)

isBehaviour

public boolean isBehaviour()

Returns:

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

isContent

public boolean isContent()

Returns:

if true, 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 isPrimaryContent()

isPrimaryContent

public boolean isPrimaryContent()

Returns:

if true, 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