org.coursera.courier.api

Class CourierTemplateSpecGenerator

java.lang.Object

org.coursera.courier.api.CourierTemplateSpecGenerator

public class CourierTemplateSpecGenerator
extends java.lang.Object

Modified version of TemplateSpecGenerator that adds support for Courier specific functionality:

• Typed map key support.
• Use 'scala' instead of 'java' for custom properties.
• Use 'org.coursera.courier.data' as base namespace.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CourierTemplateSpecGenerator.CustomClasses

Constructor Summary

Constructors

Constructor and Description
CourierTemplateSpecGenerator(com.linkedin.data.schema.DataSchemaResolver schemaResolver, java.lang.String dataNamespace) Deprecated. Use below constructor and provide a customTypeLanguage.
CourierTemplateSpecGenerator(com.linkedin.data.schema.DataSchemaResolver schemaResolver, java.lang.String dataNamespace, java.lang.String customTypeLanguage)

Method Summary

Modifier and Type	Method and Description
static java.lang.String	classNameForNamedSchema(com.linkedin.data.schema.NamedDataSchema schema) Return Java class name for a NamedDataSchema.
com.linkedin.pegasus.generator.spec.ClassTemplateSpec	generate(com.linkedin.data.schema.DataSchema schema) Generate ClassTemplateSpec from the specified DataSchema without knowing the location.
com.linkedin.pegasus.generator.spec.ClassTemplateSpec	generate(com.linkedin.data.schema.DataSchema schema, com.linkedin.data.schema.DataSchemaLocation location) Generate ClassTemplateSpec from the specified DataSchema and its location.
com.linkedin.data.schema.DataSchemaLocation	getClassLocation(com.linkedin.pegasus.generator.spec.ClassTemplateSpec classSpec)
static CourierTemplateSpecGenerator.CustomClasses	getCustomClasses(com.linkedin.data.schema.DataSchema schema, java.lang.String customTypeLanguage)
java.util.Collection<com.linkedin.pegasus.generator.spec.ClassTemplateSpec>	getGeneratedSpecs()
void	registerDefinedSchema(com.linkedin.data.schema.DataSchema schema) Instead of generate spec for the specify DataSchema, assume it is already defined in the system.

Methods inherited from class java.lang.Object

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

Constructor Detail

CourierTemplateSpecGenerator

@Deprecated
public CourierTemplateSpecGenerator(com.linkedin.data.schema.DataSchemaResolver schemaResolver,
                                                java.lang.String dataNamespace)

Deprecated. Use below constructor and provide a customTypeLanguage.

CourierTemplateSpecGenerator

public CourierTemplateSpecGenerator(com.linkedin.data.schema.DataSchemaResolver schemaResolver,
                                    java.lang.String dataNamespace,
                                    java.lang.String customTypeLanguage)

Parameters:

dataNamespace - Provides the namespace to use for generated classes that have no other reasonable default namespace. E.g. An generated type for array of ints would be generated in this namespace.

Method Detail

classNameForNamedSchema

public static java.lang.String classNameForNamedSchema(com.linkedin.data.schema.NamedDataSchema schema)

Return Java class name for a NamedDataSchema.

Parameters:

schema - provides the NamedDataSchema.

Returns:

the fully qualified Java class name for the provided NamedDataSchema.

getClassLocation

public com.linkedin.data.schema.DataSchemaLocation getClassLocation(com.linkedin.pegasus.generator.spec.ClassTemplateSpec classSpec)

Returns:

location of the ClassTemplateSpec is originated, most likely the pdsc file that defines it

registerDefinedSchema

public void registerDefinedSchema(com.linkedin.data.schema.DataSchema schema)

Instead of generate spec for the specify DataSchema, assume it is already defined in the system.

generate

public com.linkedin.pegasus.generator.spec.ClassTemplateSpec generate(com.linkedin.data.schema.DataSchema schema)

Generate ClassTemplateSpec from the specified DataSchema without knowing the location.

generate

public com.linkedin.pegasus.generator.spec.ClassTemplateSpec generate(com.linkedin.data.schema.DataSchema schema,
                                                                      com.linkedin.data.schema.DataSchemaLocation location)

Generate ClassTemplateSpec from the specified DataSchema and its location.

getGeneratedSpecs

public java.util.Collection<com.linkedin.pegasus.generator.spec.ClassTemplateSpec> getGeneratedSpecs()

getCustomClasses

public static CourierTemplateSpecGenerator.CustomClasses getCustomClasses(com.linkedin.data.schema.DataSchema schema,
                                                                          java.lang.String customTypeLanguage)