com.mulesoft.connectivity.rest.sdk.templating.sdk

Class AbstractSdkValueProvider

java.lang.Object

com.mulesoft.connectivity.rest.sdk.templating.TemplateEntity

com.mulesoft.connectivity.rest.sdk.templating.JavaTemplateEntity

com.mulesoft.connectivity.rest.sdk.templating.sdk.AbstractSdkValueProvider

Direct Known Subclasses:

SdkValueProviderInline, SdkValueProviderReference, SdkValueProviderReferenceParent

public abstract class AbstractSdkValueProvider
extends JavaTemplateEntity

Field Summary

Fields

Modifier and Type	Field and Description
protected com.mulesoft.connectivity.rest.sdk.internal.connectormodel.valueprovider.ValueProviderDefinition	definition
protected static String	ITEM_NAME_EXPRESSION_FIELD
protected static String	ITEM_VALUE_EXPRESSION_FIELD
protected static String	ITEMS_EXPRESSION_FIELD
protected com.mulesoft.connectivity.rest.sdk.internal.connectormodel.parameter.Parameter	parameter
protected static String	PATH_TEMPLATE_FIELD
protected SdkOperation	sdkOperation

Fields inherited from class com.mulesoft.connectivity.rest.sdk.templating.JavaTemplateEntity

connectorModel, NAME_MEMBER, outputDir, runConfiguration, VALUE_MEMBER

Constructor Summary

Constructors

Constructor and Description
AbstractSdkValueProvider(Path outputDir, com.mulesoft.connectivity.rest.sdk.internal.connectormodel.ConnectorModel connectorModel, com.mulesoft.connectivity.rest.sdk.internal.connectormodel.parameter.Parameter parameter, SdkOperation operation, RestSdkRunConfiguration runConfiguration)

Method Summary

Modifier and Type	Method and Description
void	applyTemplates()
protected void	buildValueProviderClass(com.squareup.javapoet.TypeSpec.Builder valueProviderClassBuilder) Allows extending the default value provider class building
protected abstract com.squareup.javapoet.CodeBlock	generateBuildMethodBody() Generates the 'build' method of the value provider that overrides the abstract one from RestValueProvider.
protected String	getBindingMethod(com.mulesoft.connectivity.rest.sdk.internal.connectormodel.parameter.ParameterType parameterType)
String	getJavaClassName()
String	getPackage()
protected com.squareup.javapoet.TypeName	getSuperClass() Returns the super class the generated value provider will extend.
protected com.squareup.javapoet.CodeBlock.Builder	getValueProviderExpressionBuilder()
protected abstract boolean	isBoundParameter(com.mulesoft.connectivity.rest.sdk.internal.connectormodel.parameter.ParameterType parameterType, SdkParameter sdkParameter) Indicates if a Parameter from the parent operation of the value provider is necessary for this value provider to resolve the available values.
protected boolean	needsClassConstants()
protected boolean	needsConfigureEvaluationContextMethod()

Methods inherited from class com.mulesoft.connectivity.rest.sdk.templating.JavaTemplateEntity

generateGetter, generateOptionalGetter, getConstantStringField, getJavaFileBuilderForClass, getJavaType, getResourcesPath, getSourcesPath, writeClassToFile, writeJavaFile

Methods inherited from class com.mulesoft.connectivity.rest.sdk.templating.TemplateEntity

getTemplateEngine

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ITEMS_EXPRESSION_FIELD

protected static final String ITEMS_EXPRESSION_FIELD

See Also:

Constant Field Values

ITEM_VALUE_EXPRESSION_FIELD

protected static final String ITEM_VALUE_EXPRESSION_FIELD

See Also:

Constant Field Values

ITEM_NAME_EXPRESSION_FIELD

protected static final String ITEM_NAME_EXPRESSION_FIELD

See Also:

Constant Field Values

PATH_TEMPLATE_FIELD

protected static final String PATH_TEMPLATE_FIELD

See Also:

Constant Field Values

sdkOperation

protected final SdkOperation sdkOperation

parameter

protected final com.mulesoft.connectivity.rest.sdk.internal.connectormodel.parameter.Parameter parameter

definition

protected final com.mulesoft.connectivity.rest.sdk.internal.connectormodel.valueprovider.ValueProviderDefinition definition

Constructor Detail

AbstractSdkValueProvider

public AbstractSdkValueProvider(Path outputDir,
                                com.mulesoft.connectivity.rest.sdk.internal.connectormodel.ConnectorModel connectorModel,
                                com.mulesoft.connectivity.rest.sdk.internal.connectormodel.parameter.Parameter parameter,
                                SdkOperation operation,
                                RestSdkRunConfiguration runConfiguration)

Method Detail

getPackage

public String getPackage()

getJavaClassName

public String getJavaClassName()

applyTemplates

public void applyTemplates()
                    throws TemplatingException

Specified by:

applyTemplates in class TemplateEntity

Throws:

TemplatingException

needsClassConstants

protected boolean needsClassConstants()

needsConfigureEvaluationContextMethod

protected boolean needsConfigureEvaluationContextMethod()

getSuperClass

protected com.squareup.javapoet.TypeName getSuperClass()

Returns the super class the generated value provider will extend. This is useful when multiple value providers extend a commons parent one where the logic is implemented. i.e. Reference.

buildValueProviderClass

protected void buildValueProviderClass(com.squareup.javapoet.TypeSpec.Builder valueProviderClassBuilder)

Allows extending the default value provider class building

generateBuildMethodBody

protected abstract com.squareup.javapoet.CodeBlock generateBuildMethodBody()

Generates the 'build' method of the value provider that overrides the abstract one from RestValueProvider. This method creates the actual provider expression, being it an inline definition or a reference to a value provider expression defined in the global context depending on the case. If the returned CodeBlock is null, no build method will be generated.

isBoundParameter

protected abstract boolean isBoundParameter(com.mulesoft.connectivity.rest.sdk.internal.connectormodel.parameter.ParameterType parameterType,
                                            SdkParameter sdkParameter)

Indicates if a Parameter from the parent operation of the value provider is necessary for this value provider to resolve the available values. If this method says is necessary, a @Parameter will be generated in the value provider class. When that @Parameter is generated in the value provider, it is mandatory for it to have an assigned value in the DSL for the resolver to be executed.

Parameters:

parameterType - The kind of parameter that is being checked

sdkParameter - The parameter that is being checked

getBindingMethod

protected String getBindingMethod(com.mulesoft.connectivity.rest.sdk.internal.connectormodel.parameter.ParameterType parameterType)

getValueProviderExpressionBuilder

protected com.squareup.javapoet.CodeBlock.Builder getValueProviderExpressionBuilder()