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

Class SdkParameter

java.lang.Object

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

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

com.mulesoft.connectivity.rest.sdk.templating.sdk.parameter.SdkParameter

Direct Known Subclasses:

SdkAuxiliarParameter, SdkPaginationParameter

public class SdkParameter
extends JavaTemplateEntity

Field Summary

Fields

Modifier and Type	Field and Description
protected SdkConnector	connector
protected boolean	generateContentAnnotation
protected com.mulesoft.connectivity.rest.sdk.internal.connectormodel.parameter.Parameter	parameter
protected JavaTemplateEntity	parentElement

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

BASE_CLASSNAME_SUFFIX, BASE_PACKAGE_SUFFIX, connectorModel, FIRST_GENERATION_TEMPLATE, IGNORED_OVERRIDE_TEMPLATE, IGNORED_REFINEMENT_TEMPLATE, NAME_MEMBER, outputDir, REFINEMENT_CLASSNAME_SUFFIX, REFINEMENT_PACKAGE_SUFFIX, runConfiguration, VALUE_MEMBER

Constructor Summary

Constructors

Constructor and Description
SdkParameter(Path outputDir, com.mulesoft.connectivity.rest.sdk.internal.connectormodel.ConnectorModel connectorModel, SdkConnector sdkConnector, String parentJavaName, com.mulesoft.connectivity.rest.sdk.internal.connectormodel.parameter.Parameter parameter, JavaTemplateEntity parentElement, boolean generateContentAnnotation, RestSdkRunConfiguration runConfiguration)
SdkParameter(Path outputDir, com.mulesoft.connectivity.rest.sdk.internal.connectormodel.ConnectorModel connectorModel, SdkConnector sdkConnector, String parentJavaName, com.mulesoft.connectivity.rest.sdk.internal.connectormodel.parameter.Parameter parameter, JavaTemplateEntity parentElement, RestSdkRunConfiguration runConfiguration)

Method Summary

Modifier and Type	Method and Description
void	applyTemplates()
protected void	configureFieldSpecBuilder(com.squareup.javapoet.FieldSpec.Builder fieldSpecBuilder)
protected void	configureParameterSpecBuilder(com.squareup.javapoet.ParameterSpec.Builder paramSpecBuilder)
com.squareup.javapoet.FieldSpec.Builder	generateOAuthParameterField()
com.squareup.javapoet.FieldSpec.Builder	generateParameterField()
com.squareup.javapoet.ParameterSpec.Builder	generateParameterParameter(boolean withAnnotation)
com.squareup.javapoet.ParameterSpec.Builder	generateParameterParameter(com.squareup.javapoet.TypeName forcedTypeName, boolean withAnnotation)
protected Optional<com.squareup.javapoet.AnnotationSpec>	getContentAnnotation()
protected String	getDefaultValue()
String	getDescription()
String	getDisplayName()
protected String	getEnumClassName()
protected String	getEnumClassPackage()
String	getExternalName()
com.squareup.javapoet.CodeBlock	getInnerTypeStringValueGetter(String varName)
protected String	getInternalName()
String	getJavaName()
protected Optional<com.squareup.javapoet.AnnotationSpec>	getMetadataKeyIdAnnotation()
String	getMuleAlias()
com.mulesoft.connectivity.rest.sdk.internal.connectormodel.parameter.ParameterType	getParameterType()
protected boolean	getRequired()
protected SdkResolverTemplate	getSdkValueProvider()
com.squareup.javapoet.CodeBlock	getStringValueGetter()
String	getSummary()
protected com.mulesoft.connectivity.rest.sdk.internal.connectormodel.type.TypeDefinition	getTypeDefinition()
com.squareup.javapoet.TypeName	getTypeName()
protected Optional<com.squareup.javapoet.AnnotationSpec>	getTypeResolverAnnotation()
boolean	isArrayType()

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

generateOptionalGetter, getArgumentsFromValueProvider, getArgumentsFromValueProviderDefinition, getConstantStringField, getConstantStringField, getJavaFileBuilderForClass, getJavaType, getResourcesPath, getSourcesPath, getValueProviderAnnotation, writeClassToFile, writeClassToFile, writeJavaFile, 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

parameter

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

connector

protected final SdkConnector connector

parentElement

protected final JavaTemplateEntity parentElement

generateContentAnnotation

protected boolean generateContentAnnotation

Constructor Detail

SdkParameter

public SdkParameter(Path outputDir,
                    com.mulesoft.connectivity.rest.sdk.internal.connectormodel.ConnectorModel connectorModel,
                    SdkConnector sdkConnector,
                    String parentJavaName,
                    com.mulesoft.connectivity.rest.sdk.internal.connectormodel.parameter.Parameter parameter,
                    JavaTemplateEntity parentElement,
                    RestSdkRunConfiguration runConfiguration)

SdkParameter

public SdkParameter(Path outputDir,
                    com.mulesoft.connectivity.rest.sdk.internal.connectormodel.ConnectorModel connectorModel,
                    SdkConnector sdkConnector,
                    String parentJavaName,
                    com.mulesoft.connectivity.rest.sdk.internal.connectormodel.parameter.Parameter parameter,
                    JavaTemplateEntity parentElement,
                    boolean generateContentAnnotation,
                    RestSdkRunConfiguration runConfiguration)

Method Detail

getDescription

public String getDescription()

getDisplayName

public String getDisplayName()

getSummary

public String getSummary()

getInternalName

protected String getInternalName()

getMuleAlias

public String getMuleAlias()

getExternalName

public String getExternalName()

getTypeDefinition

protected com.mulesoft.connectivity.rest.sdk.internal.connectormodel.type.TypeDefinition getTypeDefinition()

getDefaultValue

protected String getDefaultValue()

getRequired

protected boolean getRequired()

getParameterType

public com.mulesoft.connectivity.rest.sdk.internal.connectormodel.parameter.ParameterType getParameterType()

getEnumClassName

protected String getEnumClassName()

getEnumClassPackage

protected String getEnumClassPackage()

getSdkValueProvider

protected SdkResolverTemplate getSdkValueProvider()

getJavaName

public String getJavaName()

isArrayType

public boolean isArrayType()

getTypeName

public com.squareup.javapoet.TypeName getTypeName()

applyTemplates

public void applyTemplates()
                    throws TemplatingException

Specified by:

applyTemplates in class TemplateEntity

Throws:

TemplatingException

generateParameterParameter

public com.squareup.javapoet.ParameterSpec.Builder generateParameterParameter(boolean withAnnotation)

generateParameterParameter

public com.squareup.javapoet.ParameterSpec.Builder generateParameterParameter(com.squareup.javapoet.TypeName forcedTypeName,
                                                                              boolean withAnnotation)

configureParameterSpecBuilder

protected void configureParameterSpecBuilder(com.squareup.javapoet.ParameterSpec.Builder paramSpecBuilder)

generateParameterField

public com.squareup.javapoet.FieldSpec.Builder generateParameterField()

generateOAuthParameterField

public com.squareup.javapoet.FieldSpec.Builder generateOAuthParameterField()

configureFieldSpecBuilder

protected void configureFieldSpecBuilder(com.squareup.javapoet.FieldSpec.Builder fieldSpecBuilder)

getMetadataKeyIdAnnotation

protected Optional<com.squareup.javapoet.AnnotationSpec> getMetadataKeyIdAnnotation()

getTypeResolverAnnotation

protected Optional<com.squareup.javapoet.AnnotationSpec> getTypeResolverAnnotation()

getContentAnnotation

protected Optional<com.squareup.javapoet.AnnotationSpec> getContentAnnotation()

getStringValueGetter

public com.squareup.javapoet.CodeBlock getStringValueGetter()

getInnerTypeStringValueGetter

public com.squareup.javapoet.CodeBlock getInnerTypeStringValueGetter(String varName)