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

Class AbstractSdkPaginationOperation

java.lang.Object

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

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

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

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

All Implemented Interfaces:

SdkPaginationStrategy

Direct Known Subclasses:

SdkMarkerPaginationOperation, SdkOffsetPaginationOperation, SdkPageNumberPaginationOperation

public abstract class AbstractSdkPaginationOperation
extends AbstractSdkOperation
implements SdkPaginationStrategy

Nested Class Summary

Nested classes/interfaces inherited from class com.mulesoft.connectivity.rest.sdk.templating.sdk.AbstractSdkOperation

AbstractSdkOperation.MessageOutputType

Field Summary

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

ACCEPT_HEADER_NAME, ADD_HEADER_METHOD_NAME, ADD_MULTIPLE_HEADER_METHOD_NAME, ADD_MULTIPLE_QUERY_PARAM_METHOD_NAME, ADD_QUERY_PARAM_METHOD_NAME, allHeaders, allPathParameters, allQueryParameters, content, CONTENT_TYPE_HEADER_NAME, outputMetadataResolver, PARAM_DOC_NAME_DESCRIPTION, sampleDataProvider

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

connectorModel, NAME_MEMBER, outputDir, runConfiguration, VALUE_MEMBER

Constructor Summary

Constructors

Constructor and Description
AbstractSdkPaginationOperation(Path outputDir, com.mulesoft.connectivity.rest.sdk.internal.connectormodel.ConnectorModel connectorModel, SdkConnector sdkConnector, com.mulesoft.connectivity.rest.sdk.internal.connectormodel.ConnectorOperation operation, RestSdkRunConfiguration runConfiguration)

Method Summary

Modifier and Type	Method and Description
com.squareup.javapoet.FieldSpec	generateExpressionLanguageField()
com.squareup.javapoet.TypeName	generateMethodReturn()
com.squareup.javapoet.CodeBlock	generateOperationMethodBody()
protected AbstractSdkOperation.MessageOutputType	getMessageOutputType() Utility method to encapsulate how the "return" type (or the output of the current operation's types) is calculated
com.mulesoft.connectivity.rest.sdk.internal.connectormodel.pagination.Pagination	getPagination()
com.squareup.javapoet.CodeBlock	getPagingMethodOperation()
String	getPayloadExpression()
protected boolean	requiresCallbackParameter()
protected boolean	requiresConnectionParameter()
protected boolean	requiresMediaTypeAnnotation()

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

addContentParameters, addSetBodyMethod, applyTemplates, buildContent, generateCommonOperationMethodBody, generateOperationClass, generateOperationMethod, getJavaClassName, getPackage, getSdkParameter, isVoidOperation, operationMethodRequiresBody

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

Methods inherited from interface com.mulesoft.connectivity.rest.sdk.templating.sdk.SdkPaginationStrategy

getPagingProviderClass

Constructor Detail

AbstractSdkPaginationOperation

public AbstractSdkPaginationOperation(Path outputDir,
                                      com.mulesoft.connectivity.rest.sdk.internal.connectormodel.ConnectorModel connectorModel,
                                      SdkConnector sdkConnector,
                                      com.mulesoft.connectivity.rest.sdk.internal.connectormodel.ConnectorOperation operation,
                                      RestSdkRunConfiguration runConfiguration)
                               throws TemplatingException

Throws:

TemplatingException

Method Detail

getPagination

public com.mulesoft.connectivity.rest.sdk.internal.connectormodel.pagination.Pagination getPagination()

getPagingMethodOperation

public com.squareup.javapoet.CodeBlock getPagingMethodOperation()
                                                         throws TemplatingException

Specified by:

getPagingMethodOperation in interface SdkPaginationStrategy

Throws:

TemplatingException

generateMethodReturn

public com.squareup.javapoet.TypeName generateMethodReturn()

Specified by:

generateMethodReturn in class AbstractSdkOperation

getMessageOutputType

protected AbstractSdkOperation.MessageOutputType getMessageOutputType()

Description copied from class: AbstractSdkOperation

Utility method to encapsulate how the "return" type (or the output of the current operation's types) is calculated

Overrides:

getMessageOutputType in class AbstractSdkOperation

generateOperationMethodBody

public com.squareup.javapoet.CodeBlock generateOperationMethodBody()
                                                            throws TemplatingException

Specified by:

generateOperationMethodBody in class AbstractSdkOperation

Throws:

TemplatingException

generateExpressionLanguageField

public com.squareup.javapoet.FieldSpec generateExpressionLanguageField()

Specified by:

generateExpressionLanguageField in class AbstractSdkOperation

getPayloadExpression

public String getPayloadExpression()

Specified by:

getPayloadExpression in interface SdkPaginationStrategy

requiresConnectionParameter

protected boolean requiresConnectionParameter()

Overrides:

requiresConnectionParameter in class AbstractSdkOperation

requiresCallbackParameter

protected boolean requiresCallbackParameter()

Overrides:

requiresCallbackParameter in class AbstractSdkOperation

requiresMediaTypeAnnotation

protected boolean requiresMediaTypeAnnotation()

Overrides:

requiresMediaTypeAnnotation in class AbstractSdkOperation