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

Class SettingsCommentComposer

java.lang.Object

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

public class SettingsCommentComposer
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final List<CommentStatement>	APPLY_TO_ALL_UNARY_METHODS_METHOD_COMMENTS
static final CommentStatement	DEFAULT_CREDENTIALS_PROVIDER_BUILDER_METHOD_COMMENT
static final CommentStatement	DEFAULT_EXECUTOR_PROVIDER_BUILDER_METHOD_COMMENT
static final CommentStatement	DEFAULT_SCOPES_COMMENT
static final CommentStatement	DEFAULT_SERVICE_ENDPOINT_METHOD_COMMENT
static final CommentStatement	DEFAULT_SERVICE_MTLS_ENDPOINT_METHOD_COMMENT
static final CommentStatement	DEFAULT_SERVICE_NAME_METHOD_COMMENT
static final CommentStatement	DEFAULT_SERVICE_SCOPES_METHOD_COMMENT
static final CommentStatement	DEFAULT_TRANSPORT_PROVIDER_BUILDER_METHOD_COMMENT
static final CommentStatement	NEW_BUILDER_METHOD_COMMENT
static final CommentStatement	TO_BUILDER_METHOD_COMMENT

Constructor Summary

Constructors

Constructor	Description
SettingsCommentComposer(String transportPrefix)

Method Summary

Modifier and Type	Method	Description
static CommentStatement	createBuilderClassComment(String outerClassName)
static CommentStatement	createCallSettingsBuilderGetterComment(String javaMethodName, boolean isMethodDeprecated)
static CommentStatement	createCallSettingsGetterComment(String javaMethodName, boolean isMethodDeprecated)
static List<CommentStatement>	createClassHeaderComments(String configuredClassName, String defaultHost, boolean isDeprecated, Optional<String> methodNameOpt, Optional<String> sampleCodeOpt, Optional<String> lroMethodNameOpt, Optional<String> lroSampleCodeOpt, TypeNode classType)
CommentStatement	getNewTransportBuilderMethodComment()
CommentStatement	getTransportProviderBuilderMethodComment()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_SCOPES_COMMENT

public static final CommentStatement DEFAULT_SCOPES_COMMENT

DEFAULT_EXECUTOR_PROVIDER_BUILDER_METHOD_COMMENT

public static final CommentStatement DEFAULT_EXECUTOR_PROVIDER_BUILDER_METHOD_COMMENT

DEFAULT_SERVICE_NAME_METHOD_COMMENT

public static final CommentStatement DEFAULT_SERVICE_NAME_METHOD_COMMENT

DEFAULT_SERVICE_ENDPOINT_METHOD_COMMENT

public static final CommentStatement DEFAULT_SERVICE_ENDPOINT_METHOD_COMMENT

DEFAULT_SERVICE_MTLS_ENDPOINT_METHOD_COMMENT

public static final CommentStatement DEFAULT_SERVICE_MTLS_ENDPOINT_METHOD_COMMENT

DEFAULT_SERVICE_SCOPES_METHOD_COMMENT

public static final CommentStatement DEFAULT_SERVICE_SCOPES_METHOD_COMMENT

DEFAULT_CREDENTIALS_PROVIDER_BUILDER_METHOD_COMMENT

public static final CommentStatement DEFAULT_CREDENTIALS_PROVIDER_BUILDER_METHOD_COMMENT

DEFAULT_TRANSPORT_PROVIDER_BUILDER_METHOD_COMMENT

public static final CommentStatement DEFAULT_TRANSPORT_PROVIDER_BUILDER_METHOD_COMMENT

NEW_BUILDER_METHOD_COMMENT

public static final CommentStatement NEW_BUILDER_METHOD_COMMENT

TO_BUILDER_METHOD_COMMENT

public static final CommentStatement TO_BUILDER_METHOD_COMMENT

APPLY_TO_ALL_UNARY_METHODS_METHOD_COMMENTS

public static final List<CommentStatement> APPLY_TO_ALL_UNARY_METHODS_METHOD_COMMENTS

Constructor Details

SettingsCommentComposer

public SettingsCommentComposer(String transportPrefix)

Method Details

getNewTransportBuilderMethodComment

public CommentStatement getNewTransportBuilderMethodComment()

getTransportProviderBuilderMethodComment

public CommentStatement getTransportProviderBuilderMethodComment()

createCallSettingsGetterComment

public static CommentStatement createCallSettingsGetterComment(String javaMethodName,
 boolean isMethodDeprecated)

createBuilderClassComment

public static CommentStatement createBuilderClassComment(String outerClassName)

createCallSettingsBuilderGetterComment

public static CommentStatement createCallSettingsBuilderGetterComment(String javaMethodName,
 boolean isMethodDeprecated)

createClassHeaderComments

public static List<CommentStatement> createClassHeaderComments(String configuredClassName,
 String defaultHost,
 boolean isDeprecated,
 Optional<String> methodNameOpt,
 Optional<String> sampleCodeOpt,
 Optional<String> lroMethodNameOpt,
 Optional<String> lroSampleCodeOpt,
 TypeNode classType)