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

Class AbstractSdkPaginationOperation

java.lang.Object

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

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

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

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

All Implemented Interfaces:

SdkPaginationStrategy

Direct Known Subclasses:

SdkMarkerPaginationOperation, SdkOffsetPaginationOperation, SdkPageNumberPaginationOperation

public abstract class AbstractSdkPaginationOperation
extends AbstractSdkOperation
implements SdkPaginationStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static String	PAGING_RESPONSE_EXPRESSION

Fields inherited from class com.mulesoft.connectivity.rest.sdk.internal.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.internal.templating.JavaTemplateEntity

connectorModel, NAME_MEMBER, outputDir, runConfiguration, VALUE_MEMBER

Constructor Summary

Constructors

Constructor and Description
AbstractSdkPaginationOperation(Path outputDir, ConnectorModel connectorModel, SdkConnector sdkConnector, ConnectorOperation operation, RestSdkRunConfiguration runConfiguration)

Method Summary

Modifier and Type	Method and Description
com.squareup.javapoet.AnnotationSpec	buildDefaultAnnotation()
com.squareup.javapoet.AnnotationSpec	buildSummaryAnnotation()
com.squareup.javapoet.FieldSpec	generateExpressionLanguageField()
com.squareup.javapoet.ParameterSpec	generateInitialPagingParameter()
com.squareup.javapoet.TypeName	generateMethodReturn()
com.squareup.javapoet.CodeBlock	generateOperationMethodBody()
abstract String	getInitialPagingParameterSummary()
String	getInitialValue()
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.internal.templating.sdk.AbstractSdkOperation

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

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

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

Methods inherited from class com.mulesoft.connectivity.rest.sdk.internal.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.internal.templating.sdk.SdkPaginationStrategy

getInitialParamName, getPagingProvider, getTokenParamName

Field Detail

PAGING_RESPONSE_EXPRESSION

public static final String PAGING_RESPONSE_EXPRESSION

See Also:

Constant Field Values

Constructor Detail

AbstractSdkPaginationOperation

public AbstractSdkPaginationOperation(Path outputDir,
                                      ConnectorModel connectorModel,
                                      SdkConnector sdkConnector,
                                      ConnectorOperation operation,
                                      RestSdkRunConfiguration runConfiguration)
                               throws TemplatingException

Throws:

TemplatingException

Method Detail

getInitialPagingParameterSummary

public abstract String getInitialPagingParameterSummary()

getPagination

public Pagination getPagination()

buildSummaryAnnotation

public com.squareup.javapoet.AnnotationSpec buildSummaryAnnotation()

buildDefaultAnnotation

public com.squareup.javapoet.AnnotationSpec buildDefaultAnnotation()

generateInitialPagingParameter

public com.squareup.javapoet.ParameterSpec generateInitialPagingParameter()

Specified by:

generateInitialPagingParameter in class AbstractSdkOperation

getPagingMethodOperation

public com.squareup.javapoet.CodeBlock getPagingMethodOperation()

Specified by:

getPagingMethodOperation in interface SdkPaginationStrategy

generateMethodReturn

public com.squareup.javapoet.TypeName generateMethodReturn()

Specified by:

generateMethodReturn in class AbstractSdkOperation

generateOperationMethodBody

public com.squareup.javapoet.CodeBlock generateOperationMethodBody()

Specified by:

generateOperationMethodBody in class AbstractSdkOperation

generateExpressionLanguageField

public com.squareup.javapoet.FieldSpec generateExpressionLanguageField()

Specified by:

generateExpressionLanguageField in class AbstractSdkOperation

getInitialValue

public String getInitialValue()

Specified by:

getInitialValue in interface SdkPaginationStrategy

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