Package software.amazon.awssdk.codegen.poet.client

Class AsyncClientInterface

java.lang.Object

software.amazon.awssdk.codegen.poet.client.AsyncClientInterface

All Implemented Interfaces:

ClassSpec

Direct Known Subclasses:

AsyncClientClass, DelegatingAsyncClientClass

public class AsyncClientInterface
extends Object
implements ClassSpec

Field Summary

Fields

Modifier and Type	Field	Description
protected com.squareup.javapoet.ClassName	className
protected String	clientPackageName
protected IntermediateModel	model
static com.squareup.javapoet.TypeVariableName	STREAMING_TYPE_VARIABLE

Constructor Summary

Constructors

Constructor	Description
AsyncClientInterface(IntermediateModel model)

Method Summary

Modifier and Type	Method	Description
protected void	addAdditionalMethods(com.squareup.javapoet.TypeSpec.Builder type)
protected void	addAnnotations(com.squareup.javapoet.TypeSpec.Builder type)
protected void	addCloseMethod(com.squareup.javapoet.TypeSpec.Builder type)
protected void	addFields(com.squareup.javapoet.TypeSpec.Builder type)
protected void	addInterfaceClass(com.squareup.javapoet.TypeSpec.Builder type)
protected void	addModifiers(com.squareup.javapoet.TypeSpec.Builder type)
protected void	addWaiterMethod(com.squareup.javapoet.TypeSpec.Builder type)
com.squareup.javapoet.ClassName	className()
protected com.squareup.javapoet.TypeSpec.Builder	createTypeSpec()
protected com.squareup.javapoet.MethodSpec.Builder	operationBody(com.squareup.javapoet.MethodSpec.Builder builder, OperationModel operationModel)	Add the implementation body.
protected Iterable<com.squareup.javapoet.MethodSpec>	operations()
protected com.squareup.javapoet.MethodSpec.Builder	paginatedMethodBody(com.squareup.javapoet.MethodSpec.Builder builder, OperationModel operationModel)
protected com.squareup.javapoet.MethodSpec	paginatedTraditionalMethod(OperationModel opModel)
com.squareup.javapoet.TypeSpec	poetSpec()
protected com.squareup.javapoet.MethodSpec	serviceClientConfigMethod()
protected com.squareup.javapoet.MethodSpec	traditionalMethod(OperationModel opModel)
protected com.squareup.javapoet.MethodSpec	utilitiesMethod()
protected com.squareup.javapoet.MethodSpec.Builder	utilitiesOperationBody(com.squareup.javapoet.MethodSpec.Builder builder)
protected com.squareup.javapoet.MethodSpec.Builder	waiterOperationBody(com.squareup.javapoet.MethodSpec.Builder builder)

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

STREAMING_TYPE_VARIABLE

public static final com.squareup.javapoet.TypeVariableName STREAMING_TYPE_VARIABLE

model

protected final IntermediateModel model

className

protected final com.squareup.javapoet.ClassName className

clientPackageName

protected final String clientPackageName

Constructor Detail

AsyncClientInterface

public AsyncClientInterface(IntermediateModel model)

Method Detail

poetSpec

public com.squareup.javapoet.TypeSpec poetSpec()

Specified by:

poetSpec in interface ClassSpec

Returns:

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

createTypeSpec

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

addInterfaceClass

protected void addInterfaceClass(com.squareup.javapoet.TypeSpec.Builder type)

addAnnotations

protected void addAnnotations(com.squareup.javapoet.TypeSpec.Builder type)

addModifiers

protected void addModifiers(com.squareup.javapoet.TypeSpec.Builder type)

addCloseMethod

protected void addCloseMethod(com.squareup.javapoet.TypeSpec.Builder type)

addFields

protected void addFields(com.squareup.javapoet.TypeSpec.Builder type)

addAdditionalMethods

protected void addAdditionalMethods(com.squareup.javapoet.TypeSpec.Builder type)

addWaiterMethod

protected void addWaiterMethod(com.squareup.javapoet.TypeSpec.Builder type)

className

public com.squareup.javapoet.ClassName className()

Specified by:

className in interface ClassSpec

Returns:

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

operations

protected Iterable<com.squareup.javapoet.MethodSpec> operations()

Returns:

List generated of methods for all operations.

paginatedTraditionalMethod

protected com.squareup.javapoet.MethodSpec paginatedTraditionalMethod(OperationModel opModel)

paginatedMethodBody

protected com.squareup.javapoet.MethodSpec.Builder paginatedMethodBody(com.squareup.javapoet.MethodSpec.Builder builder,
                                                                       OperationModel operationModel)

operationBody

protected com.squareup.javapoet.MethodSpec.Builder operationBody(com.squareup.javapoet.MethodSpec.Builder builder,
                                                                 OperationModel operationModel)

Add the implementation body. The interface implements all methods by throwing an UnsupportedOperationException except for simple method overloads which just delegate to the traditional request/response method. This is overridden in AsyncClientClass to add an actual implementation.

Parameters:

builder - Current MethodSpec.Builder to add implementation to.

operationModel - Operation to generate method body for.

Returns:

Builder with method body added.

traditionalMethod

protected com.squareup.javapoet.MethodSpec traditionalMethod(OperationModel opModel)

utilitiesMethod

protected com.squareup.javapoet.MethodSpec utilitiesMethod()

serviceClientConfigMethod

protected com.squareup.javapoet.MethodSpec serviceClientConfigMethod()

utilitiesOperationBody

protected com.squareup.javapoet.MethodSpec.Builder utilitiesOperationBody(com.squareup.javapoet.MethodSpec.Builder builder)

waiterOperationBody

protected com.squareup.javapoet.MethodSpec.Builder waiterOperationBody(com.squareup.javapoet.MethodSpec.Builder builder)