Package software.amazon.awssdk.codegen.poet.paginators

Class SyncResponseClassSpec

java.lang.Object

software.amazon.awssdk.codegen.poet.paginators.PaginatorsClassSpec

software.amazon.awssdk.codegen.poet.paginators.SyncResponseClassSpec

All Implemented Interfaces:

ClassSpec

Direct Known Subclasses:

SameTokenSyncResponseClassSpec

public class SyncResponseClassSpec
extends PaginatorsClassSpec

Java poet ClassSpec to generate the response class for sync paginated operations.

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	ITERATOR_METHOD

Fields inherited from class software.amazon.awssdk.codegen.poet.paginators.PaginatorsClassSpec

c2jOperationName, CLIENT_MEMBER, HAS_NEXT_PAGE_METHOD, LAST_SUCCESSFUL_PAGE_LITERAL, model, NEXT_PAGE_FETCHER_MEMBER, NEXT_PAGE_METHOD, operationModel, paginationDocs, paginatorDefinition, poetExtensions, PREVIOUS_PAGE_METHOD_ARGUMENT, REQUEST_MEMBER, RESPONSE_LITERAL, RESUME_METHOD, typeProvider

Constructor Summary

Constructors

Constructor	Description
SyncResponseClassSpec(IntermediateModel model, String c2jOperationName, PaginatorDefinition paginatorDefinition)

Method Summary

Modifier and Type	Method	Description
com.squareup.javapoet.ClassName	className()
protected com.squareup.javapoet.MethodSpec	constructor()
protected Stream<com.squareup.javapoet.FieldSpec>	fields()
protected com.squareup.javapoet.ClassName	getClientInterfaceName()
protected com.squareup.javapoet.MethodSpec	iteratorMethod()	A MethodSpec for the overridden iterator() method which is inherited from the interface.
protected String	nextPageFetcherArgument()
protected com.squareup.javapoet.TypeSpec.Builder	nextPageFetcherClass()	Generates a inner class that implements SyncPageFetcher.
com.squareup.javapoet.TypeSpec	poetSpec()
protected com.squareup.javapoet.FieldSpec	syncClientInterfaceField()

Methods inherited from class software.amazon.awssdk.codegen.poet.paginators.PaginatorsClassSpec

codeToGetNextPageIfOldResponseIsNotNull, constructRequestFromLastPage, fluentGetterMethodForResponseMember, fluentGetterMethodsForOutputToken, getIteratorLambdaBlock, getTypeForResultKey, hasNextPageMethodBody, memberModelForResponseMember, nextPageFetcherClassName, nextPageMethodBody, requestClassField, requestType, responseType, resumeMethodBuilder

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.codegen.poet.ClassSpec

staticImports

Field Detail

ITERATOR_METHOD

protected static final String ITERATOR_METHOD

See Also:

Constant Field Values

Constructor Detail

SyncResponseClassSpec

public SyncResponseClassSpec(IntermediateModel model,
                             String c2jOperationName,
                             PaginatorDefinition paginatorDefinition)

Method Detail

poetSpec

public com.squareup.javapoet.TypeSpec poetSpec()

Returns:

The actual class specification generated from a PoetSpec.builder()... implementation

className

public com.squareup.javapoet.ClassName className()

Returns:

The Poet representation of the class being generated, this may be used by other classes

getClientInterfaceName

protected com.squareup.javapoet.ClassName getClientInterfaceName()

Returns:

A Poet ClassName for the sync client interface

fields

protected Stream<com.squareup.javapoet.FieldSpec> fields()

syncClientInterfaceField

protected com.squareup.javapoet.FieldSpec syncClientInterfaceField()

constructor

protected com.squareup.javapoet.MethodSpec constructor()

iteratorMethod

protected com.squareup.javapoet.MethodSpec iteratorMethod()

A MethodSpec for the overridden iterator() method which is inherited from the interface.

nextPageFetcherArgument

protected String nextPageFetcherArgument()

nextPageFetcherClass

protected com.squareup.javapoet.TypeSpec.Builder nextPageFetcherClass()

Generates a inner class that implements SyncPageFetcher. An instance of this class is passed to PaginatedResponsesIterator to be used while iterating through pages.