com.google.ads.googleads.annotations.impl.generators.messageproxy

Class AbstractMessageProxyGenerator

java.lang.Object

com.google.ads.googleads.annotations.impl.generators.messageproxy.AbstractMessageProxyGenerator

All Implemented Interfaces:

Generator

Direct Known Subclasses:

AbstractSearchResponseMessageProxyGenerator, CreateCustomerClientRequestProxyGenerator, CustomerUserAccessMessageProxyGenerator, FeedMessageProxyGenerator

public abstract class AbstractMessageProxyGenerator
extends Object
implements Generator

Abstracts common functionality for generating message proxy implementations.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	GENERATED_PACKAGE_NAME
protected static String	MESSAGE_PROXY_PACKAGE_NAME
static int	MIN_VERSION_FOR_CHANGE_EVENT
static int	MIN_VERSION_FOR_CUSTOMER_USER_ACCESS
static int	MIN_VERSION_FOR_FEED_PLACES_LOCATION_DATA_EMAIL

Constructor Summary

Constructors

Constructor and Description
AbstractMessageProxyGenerator(Set<Integer> versions, Messager messager, Filer filer)

Method Summary

Modifier and Type	Method and Description
void	generate() Generates a SearchResponseProxy for each version.
protected abstract void	generate(com.squareup.javapoet.TypeSpec.Builder typeBuilder, int version, com.squareup.javapoet.ClassName proxiedClassName, com.squareup.javapoet.ClassName proxiedBuilderClassName) Generates the class content (methods etc.) required for the proxy implementation.
protected static void	generateStringSetter(com.squareup.javapoet.TypeSpec.Builder typeBuilder, com.squareup.javapoet.ClassName proxiedBuilderClassName, String fullNameOfSetterMethod, String filterStatement, String updateStatement, int version, int minVersion) Generates a setter for a string property.
protected static void	generateStringSetter(com.squareup.javapoet.TypeSpec.Builder typeBuilder, com.squareup.javapoet.ClassName proxiedBuilderClassName, String fullNameOfSetterMethod, String filterStatement, String updateStatement, int version, int minVersionForType, int minVersionForFilterAndUpdate) Generates a setter for a string property.
protected abstract com.squareup.javapoet.ClassName	getProxiedClassName(int version) Gets the name of the class that this proxy is for.
protected com.squareup.javapoet.TypeName	getProxyInterfaceParameterizedName(int version, com.squareup.javapoet.ClassName interfaceRawType, com.squareup.javapoet.ClassName proxiedClassName, com.squareup.javapoet.ClassName proxiedBuilderClassName) Gets the type of interface to be implemented.
protected abstract com.squareup.javapoet.ClassName	getProxyInterfaceRawName() Gets the name of the super interface that the generated proxy should implement.
protected static String	getResourcesPackage(int version) Gets the package where the API resource classes are located.
protected static String	getServicesPackage(int version) Gets the package where the API generated services classes are located.

Methods inherited from class java.lang.Object

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

Field Detail

MIN_VERSION_FOR_CUSTOMER_USER_ACCESS

public static final int MIN_VERSION_FOR_CUSTOMER_USER_ACCESS

See Also:

Constant Field Values

MIN_VERSION_FOR_CHANGE_EVENT

public static final int MIN_VERSION_FOR_CHANGE_EVENT

See Also:

Constant Field Values

MIN_VERSION_FOR_FEED_PLACES_LOCATION_DATA_EMAIL

public static final int MIN_VERSION_FOR_FEED_PLACES_LOCATION_DATA_EMAIL

See Also:

Constant Field Values

MESSAGE_PROXY_PACKAGE_NAME

protected static final String MESSAGE_PROXY_PACKAGE_NAME

See Also:

Constant Field Values

GENERATED_PACKAGE_NAME

protected static final String GENERATED_PACKAGE_NAME

See Also:

Constant Field Values

Constructor Detail

AbstractMessageProxyGenerator

public AbstractMessageProxyGenerator(Set<Integer> versions,
                                     Messager messager,
                                     Filer filer)

Method Detail

generate

public void generate()

Generates a SearchResponseProxy for each version.

Specified by:

generate in interface Generator

generate

protected abstract void generate(com.squareup.javapoet.TypeSpec.Builder typeBuilder,
                                 int version,
                                 com.squareup.javapoet.ClassName proxiedClassName,
                                 com.squareup.javapoet.ClassName proxiedBuilderClassName)

Generates the class content (methods etc.) required for the proxy implementation.

getProxyInterfaceParameterizedName

protected com.squareup.javapoet.TypeName getProxyInterfaceParameterizedName(int version,
                                                                            com.squareup.javapoet.ClassName interfaceRawType,
                                                                            com.squareup.javapoet.ClassName proxiedClassName,
                                                                            com.squareup.javapoet.ClassName proxiedBuilderClassName)

Gets the type of interface to be implemented. By default this is

InterfaceRawType

It can be useful to override this in cases where the proxied type doesn't exist in a version. Rather than having a null proxy implementation (complicating client code), we can generate a default implementation which gracefully returns the builder unchanged.

generateStringSetter

protected static void generateStringSetter(com.squareup.javapoet.TypeSpec.Builder typeBuilder,
                                           com.squareup.javapoet.ClassName proxiedBuilderClassName,
                                           String fullNameOfSetterMethod,
                                           String filterStatement,
                                           String updateStatement,
                                           int version,
                                           int minVersion)

Generates a setter for a string property.

Parameters:

typeBuilder - the type which should contain the new setter.

proxiedBuilderClassName - the builder for the type which is being proxied.

fullNameOfSetterMethod - the name of the new method.

filterStatement - a filter which should be applied prior to setting the new value. The builder will be available from a variable named builder.

updateStatement - a statement to update the value. The builder will be available from a variable named builder.

version - the version this setter is generated for.

minVersion - the minimum version required to access the type, and execute filter + update statements.

generateStringSetter

protected static void generateStringSetter(com.squareup.javapoet.TypeSpec.Builder typeBuilder,
                                           com.squareup.javapoet.ClassName proxiedBuilderClassName,
                                           String fullNameOfSetterMethod,
                                           String filterStatement,
                                           String updateStatement,
                                           int version,
                                           int minVersionForType,
                                           int minVersionForFilterAndUpdate)

Generates a setter for a string property.

Parameters:

typeBuilder - the type which should contain the new setter.

proxiedBuilderClassName - the builder for the type which is being proxied.

fullNameOfSetterMethod - the name of the new method.

filterStatement - a filter which should be applied prior to setting the new value. The builder will be available from a variable named builder.

updateStatement - a statement to update the value. The builder will be available from a variable named builder.

version - the version this setter is generated for.

minVersionForFilterAndUpdate - the minimum version required to access the type.

minVersionForFilterAndUpdate - the minimum version required to support the filter + update statements.

getProxyInterfaceRawName

protected abstract com.squareup.javapoet.ClassName getProxyInterfaceRawName()

Gets the name of the super interface that the generated proxy should implement.

getProxiedClassName

protected abstract com.squareup.javapoet.ClassName getProxiedClassName(int version)

Gets the name of the class that this proxy is for.

getServicesPackage

protected static String getServicesPackage(int version)

Gets the package where the API generated services classes are located.

getResourcesPackage

protected static String getResourcesPackage(int version)

Gets the package where the API resource classes are located.