org.apache.avro.compiler.specific

Class SpecificCompiler

java.lang.Object

org.apache.avro.compiler.specific.SpecificCompiler

public class SpecificCompiler
extends Object

Generate specific Java interfaces and classes for protocols and schemas. Java reserved keywords are mangled to preserve compilation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpecificCompiler.FieldVisibility
static class	SpecificCompiler.Slf4jLogChute

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	MAX_FIELD_PARAMETER_UNIT_COUNT

Constructor Summary

Constructors

Constructor and Description
SpecificCompiler(Protocol protocol)
SpecificCompiler(Schema schema)

Method Summary

Methods

Modifier and Type	Method and Description
protected int	calcAllArgConstructorParameterUnits(Schema record) Returns the number of parameter units required by fields for the AllArgsConstructor.
static void	compileProtocol(File[] srcFiles, File dest) Generates Java interface and classes for a number of protocol files.
static void	compileProtocol(File src, File dest) Generates Java interface and classes for a protocol.
static void	compileSchema(File[] srcFiles, File dest) Generates Java classes for a number of schema files.
static void	compileSchema(File src, File dest) Generates Java classes for a schema.
void	compileToDestination(File src, File dst) Generate output under dst, unless existing file is newer than src.
String	conversionInstance(Schema schema)
boolean	deprecatedFields()
static String	escapeForJavadoc(String s) Utility for template use.
static long	fingerprint64(Schema schema) Utility for use by templates.
static String	generateClearMethod(Schema schema, Schema.Field field) Generates the name of a field "clear" method.
static String	generateGetBuilderMethod(Schema schema, Schema.Field field) Generates the name of a field Builder accessor method.
static String	generateGetMethod(Schema schema, Schema.Field field) Generates the name of a field accessor method.
static String	generateHasBuilderMethod(Schema schema, Schema.Field field) Generates the name of a field Builder "has" method.
static String	generateHasMethod(Schema schema, Schema.Field field) Generates the name of a field "has" method.
static String	generateSetBuilderMethod(Schema schema, Schema.Field field) Generates the name of a field Builder mutator method.
static String	generateSetMethod(Schema schema, Schema.Field field) Generates the name of a field mutator method.
static boolean	hasBuilder(Schema schema) Utility for use by templates.
boolean	hasLogicalTypeField(Schema schema)
boolean	isCreateAllArgsConstructor()
boolean	isCreateSetters()
static boolean	isUnboxedJavaTypeNullable(Schema schema) Tests whether an unboxed Java type can be set to null
String[]	javaAnnotations(JsonProperties props) Utility for template use.
static String	javaEscape(Object o) Utility for template use.
String	javaSplit(String s) Utility for template use.
String	javaType(Schema schema) Utility for template use.
String	javaUnbox(Schema schema) Utility for template use.
static void	main(String[] args)
static String	mangle(String word) Utility for template use.
static String	mangle(String word, boolean isError) Utility for template use.
static String	mangle(String word, Set<String> reservedWords) Utility for template use.
static String	mangle(String word, Set<String> reservedWords, boolean isMethod) Utility for template use.
static String	nullToEmpty(String x) Utility for template use.
boolean	privateFields()
boolean	publicFields()
void	setCreateSetters(boolean createSetters) Set to false to not create setter methods for the fields of the record.
void	setFieldVisibility(SpecificCompiler.FieldVisibility fieldVisibility) Sets the field visibility option.
void	setOutputCharacterEncoding(String outputCharacterEncoding) Sets character encoding for generated java file
void	setStringType(GenericData.StringType t) Set the Java type to be emitted for string schemas.
void	setTemplateDir(String templateDir) Set the resource directory where templates reside.
protected void	validateRecordForCompilation(Schema record)

Methods inherited from class java.lang.Object

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

Field Detail

MAX_FIELD_PARAMETER_UNIT_COUNT

protected static final int MAX_FIELD_PARAMETER_UNIT_COUNT

See Also:

Constant Field Values

Constructor Detail

SpecificCompiler

public SpecificCompiler(Protocol protocol)

SpecificCompiler

public SpecificCompiler(Schema schema)

Method Detail

isCreateAllArgsConstructor

public boolean isCreateAllArgsConstructor()

setTemplateDir

public void setTemplateDir(String templateDir)

Set the resource directory where templates reside. First, the compiler checks the system path for the specified file, if not it is assumed that it is present on the classpath.

deprecatedFields

public boolean deprecatedFields()

Returns:

true if the record fields should be marked as deprecated

publicFields

public boolean publicFields()

Returns:

true if the record fields should be public

privateFields

public boolean privateFields()

Returns:

true if the record fields should be private

setFieldVisibility

public void setFieldVisibility(SpecificCompiler.FieldVisibility fieldVisibility)

Sets the field visibility option.

isCreateSetters

public boolean isCreateSetters()

setCreateSetters

public void setCreateSetters(boolean createSetters)

Set to false to not create setter methods for the fields of the record.

compileProtocol

public static void compileProtocol(File src,
                   File dest)
                            throws IOException

Generates Java interface and classes for a protocol.

Parameters:

src - the source Avro protocol file

dest - the directory to place generated files in

Throws:

IOException

compileProtocol

public static void compileProtocol(File[] srcFiles,
                   File dest)
                            throws IOException

Generates Java interface and classes for a number of protocol files.

Parameters:

srcFiles - the source Avro protocol files

dest - the directory to place generated files in

Throws:

IOException

compileSchema

public static void compileSchema(File src,
                 File dest)
                          throws IOException

Generates Java classes for a schema.

Throws:

IOException

compileSchema

public static void compileSchema(File[] srcFiles,
                 File dest)
                          throws IOException

Generates Java classes for a number of schema files.

Throws:

IOException

compileToDestination

public void compileToDestination(File src,
                        File dst)
                          throws IOException

Generate output under dst, unless existing file is newer than src.

Throws:

IOException

calcAllArgConstructorParameterUnits

protected int calcAllArgConstructorParameterUnits(Schema record)

Returns the number of parameter units required by fields for the AllArgsConstructor.

Parameters:

record - a Record schema

validateRecordForCompilation

protected void validateRecordForCompilation(Schema record)

setStringType

public void setStringType(GenericData.StringType t)

Set the Java type to be emitted for string schemas.

javaType

public String javaType(Schema schema)

Utility for template use. Returns the java type for a Schema.

javaUnbox

public String javaUnbox(Schema schema)

Utility for template use. Returns the unboxed java type for a Schema.

hasLogicalTypeField

public boolean hasLogicalTypeField(Schema schema)

conversionInstance

public String conversionInstance(Schema schema)

javaAnnotations

public String[] javaAnnotations(JsonProperties props)

Utility for template use. Returns the java annotations for a schema.

javaSplit

public String javaSplit(String s)
                 throws IOException

Utility for template use. Takes a (potentially overly long) string and splits it into a quoted, comma-separted sequence of escaped strings.

Parameters:

s - The string to split

Returns:

A sequence of quoted, comma-separated, escaped strings

Throws:

IOException

javaEscape

public static String javaEscape(Object o)

Utility for template use. Escapes quotes and backslashes.

escapeForJavadoc

public static String escapeForJavadoc(String s)

Utility for template use. Escapes comment end with HTML entities.

nullToEmpty

public static String nullToEmpty(String x)

Utility for template use. Returns empty string for null.

mangle

public static String mangle(String word)

Utility for template use. Adds a dollar sign to reserved words.

mangle

public static String mangle(String word,
            boolean isError)

Utility for template use. Adds a dollar sign to reserved words.

mangle

public static String mangle(String word,
            Set<String> reservedWords)

Utility for template use. Adds a dollar sign to reserved words.

mangle

public static String mangle(String word,
            Set<String> reservedWords,
            boolean isMethod)

Utility for template use. Adds a dollar sign to reserved words.

fingerprint64

public static long fingerprint64(Schema schema)

Utility for use by templates. Return schema fingerprint as a long.

generateGetMethod

public static String generateGetMethod(Schema schema,
                       Schema.Field field)

Generates the name of a field accessor method.

Parameters:

schema - the schema in which the field is defined.

field - the field for which to generate the accessor name.

Returns:

the name of the accessor method for the given field.

generateSetMethod

public static String generateSetMethod(Schema schema,
                       Schema.Field field)

Generates the name of a field mutator method.

Parameters:

schema - the schema in which the field is defined.

field - the field for which to generate the mutator name.

Returns:

the name of the mutator method for the given field.

generateHasMethod

public static String generateHasMethod(Schema schema,
                       Schema.Field field)

Generates the name of a field "has" method.

Parameters:

schema - the schema in which the field is defined.

field - the field for which to generate the "has" method name.

Returns:

the name of the has method for the given field.

generateClearMethod

public static String generateClearMethod(Schema schema,
                         Schema.Field field)

Generates the name of a field "clear" method.

Parameters:

schema - the schema in which the field is defined.

field - the field for which to generate the accessor name.

Returns:

the name of the has method for the given field.

hasBuilder

public static boolean hasBuilder(Schema schema)

Utility for use by templates. Does this schema have a Builder method?

generateGetBuilderMethod

public static String generateGetBuilderMethod(Schema schema,
                              Schema.Field field)

Generates the name of a field Builder accessor method.

Parameters:

schema - the schema in which the field is defined.

field - the field for which to generate the Builder accessor name.

Returns:

the name of the Builder accessor method for the given field.

generateSetBuilderMethod

public static String generateSetBuilderMethod(Schema schema,
                              Schema.Field field)

Generates the name of a field Builder mutator method.

Parameters:

schema - the schema in which the field is defined.

field - the field for which to generate the Builder mutator name.

Returns:

the name of the Builder mutator method for the given field.

generateHasBuilderMethod

public static String generateHasBuilderMethod(Schema schema,
                              Schema.Field field)

Generates the name of a field Builder "has" method.

Parameters:

schema - the schema in which the field is defined.

field - the field for which to generate the "has" Builder method name.

Returns:

the name of the "has" Builder method for the given field.

isUnboxedJavaTypeNullable

public static boolean isUnboxedJavaTypeNullable(Schema schema)

Tests whether an unboxed Java type can be set to null

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception

setOutputCharacterEncoding

public void setOutputCharacterEncoding(String outputCharacterEncoding)

Sets character encoding for generated java file

Parameters:

outputCharacterEncoding - Character encoding for output files (defaults to system encoding)