Package com.google.api.generator.gapic.composer.comment

Class ServiceClientCommentComposer

java.lang.Object

com.google.api.generator.gapic.composer.comment.ServiceClientCommentComposer

public class ServiceClientCommentComposer
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final CommentStatement	GET_OPERATIONS_CLIENT_METHOD_COMMENT

Constructor Summary

Constructors

Constructor	Description
ServiceClientCommentComposer()

Method Summary

Modifier and Type	Method	Description
static List<CommentStatement>	createClassHeaderComments(Map<String,List<String>> methodVariantsForClientHeader, Service service, String classMethodSampleCode, String credentialsSampleCode, String endpointSampleCode, String transportSampleCode, String primaryTransport, String secondaryTransport)
static CommentStatement	createCreateMethodStubArgComment(String serviceName, TypeNode settingsType)
static CommentStatement	createMethodNoArgComment(String serviceName)
static CommentStatement	createMethodSettingsArgComment(String serviceName)
static CommentStatement	createProtectedCtorSettingsArgComment(String serviceName)
static List<CommentStatement>	createRpcCallableMethodHeaderComment(Method method, Optional<String> sampleCodeOpt)
static List<CommentStatement>	createRpcMethodHeaderComment(Method method, List<MethodArgument> methodArguments, Optional<String> sampleCodeOpt)
static List<CommentStatement>	createRpcMethodHeaderComment(Method method, Optional<String> sampleCodeOpt)

Methods inherited from class java.lang.Object

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

Field Details

GET_OPERATIONS_CLIENT_METHOD_COMMENT

public static final CommentStatement GET_OPERATIONS_CLIENT_METHOD_COMMENT

Constructor Details

ServiceClientCommentComposer

public ServiceClientCommentComposer()

Method Details

createClassHeaderComments

public static List<CommentStatement> createClassHeaderComments(Map<String,List<String>> methodVariantsForClientHeader,
 Service service,
 String classMethodSampleCode,
 String credentialsSampleCode,
 String endpointSampleCode,
 String transportSampleCode,
 String primaryTransport,
 String secondaryTransport)

createCreateMethodStubArgComment

public static CommentStatement createCreateMethodStubArgComment(String serviceName,
 TypeNode settingsType)

createRpcMethodHeaderComment

public static List<CommentStatement> createRpcMethodHeaderComment(Method method,
 List<MethodArgument> methodArguments,
 Optional<String> sampleCodeOpt)

createRpcMethodHeaderComment

public static List<CommentStatement> createRpcMethodHeaderComment(Method method,
 Optional<String> sampleCodeOpt)

createMethodNoArgComment

public static CommentStatement createMethodNoArgComment(String serviceName)

createProtectedCtorSettingsArgComment

public static CommentStatement createProtectedCtorSettingsArgComment(String serviceName)

createMethodSettingsArgComment

public static CommentStatement createMethodSettingsArgComment(String serviceName)

createRpcCallableMethodHeaderComment

public static List<CommentStatement> createRpcCallableMethodHeaderComment(Method method,
 Optional<String> sampleCodeOpt)