org.mule.devkit.model

Interface Variable<P extends Identifiable>

All Superinterfaces:

Accessible, Annotable, Documentable, Generifiable, Identifiable<VariableElement>, Parentable<P>

All Known Subinterfaces:

Field<P>, OAuthCallbackParameterField, Parameter<P>, RestField, RestParameter

All Known Implementing Classes:

AnnotationProcessorField, AnnotationProcessorOAuthCallbackParameterField, AnnotationProcessorParameter, AnnotationProcessorRestField, AnnotationProcessorRestParameter, AnnotationProcessorVariable, ParameterAdapter

public interface Variable<P extends Identifiable>
extends Identifiable<VariableElement>, Parentable<P>

Method Summary

Methods

Modifier and Type	Method and Description
String	getAlternativeName() Alternative name of the attribute to be generated
String	getDefaultValue() Returns the given element's default value
String	getEmailDomain() Returns the email domain if one configured otherwise empty domain
String	getJavaType() Returns the fully qualified name of the underlying variable.
int	getMaxSizeLimit() Returns the max size limit value
int	getMinSizeLimit() Returns the min size limit value
String	getPattern() Returns the pattern
boolean	hasDefaultEmailDomain() Whether the email has an default domain or not
boolean	hasDefaultValue() Whether the given element is has a default value
boolean	hasEmailPattern() Whether the given element is has a default value
boolean	hasPattern() Whether the given element has pattern
boolean	hasSizeLimit() Whether the given element has a size limit
boolean	isMetaDataKey() If the variable is annotated with MetaDataKeyParam
boolean	isMetaDataStaticKey() If the variable is annotated with MetaDataStaticKey
boolean	isOptional() Whether the given element is marked as optional
boolean	isPayload() Whether the given element is marked with Payload
boolean	isQuery() If the variable is annotated with Query
boolean	isRefOnly() The variable can be passed by reference only.
boolean	isText() Returns true if the variable is annotated with Text

Methods inherited from interface org.mule.devkit.model.Identifiable

accept, asType, asTypeMirror, getName, isReservedIdentifier, unwrap

Methods inherited from interface org.mule.devkit.model.Annotable

getAnnotation, getAnnotationMirrors, hasAnnotation

Methods inherited from interface org.mule.devkit.model.Documentable

getJavaDocParameterSummary, getJavaDocSummary, getJavaDocTagContent, getThrowsComment, hasJavaDocTag

Methods inherited from interface org.mule.devkit.model.Accessible

isAbstract, isFinal, isPrivate, isProtected, isPublic, isStatic

Methods inherited from interface org.mule.devkit.model.Generifiable

getTypeArguments, getXmlDeclaredChilds, hasTypeArguments

Methods inherited from interface org.mule.devkit.model.Parentable

parent

Method Detail

getJavaType

String getJavaType()

Returns the fully qualified name of the underlying variable.

isOptional

boolean isOptional()

Whether the given element is marked as optional

isPayload

boolean isPayload()

Whether the given element is marked with Payload

hasSizeLimit

boolean hasSizeLimit()

Whether the given element has a size limit

hasPattern

boolean hasPattern()

Whether the given element has pattern

getPattern

String getPattern()

Returns the pattern

getMinSizeLimit

int getMinSizeLimit()

Returns the min size limit value

getMaxSizeLimit

int getMaxSizeLimit()

Returns the max size limit value

hasDefaultValue

boolean hasDefaultValue()

Whether the given element is has a default value

getDefaultValue

String getDefaultValue()

Returns the given element's default value

isText

boolean isText()

Returns true if the variable is annotated with Text

getAlternativeName

String getAlternativeName()

Alternative name of the attribute to be generated

isRefOnly

boolean isRefOnly()

The variable can be passed by reference only.

hasEmailPattern

boolean hasEmailPattern()

Whether the given element is has a default value

getEmailDomain

String getEmailDomain()

Returns the email domain if one configured otherwise empty domain

hasDefaultEmailDomain

boolean hasDefaultEmailDomain()

Whether the email has an default domain or not

isMetaDataKey

boolean isMetaDataKey()

If the variable is annotated with MetaDataKeyParam

isMetaDataStaticKey

boolean isMetaDataStaticKey()

If the variable is annotated with MetaDataStaticKey

isQuery

boolean isQuery()

If the variable is annotated with Query