org.yarnandtail.andhow.compile

Class PropertyRegistrarClassGenerator

java.lang.Object

org.yarnandtail.andhow.compile.PropertyRegistrarClassGenerator

public class PropertyRegistrarClassGenerator
extends Object

Generates the source code for a class generated as an AndHow proxy for an application class that contains AndHow Properties.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ANNOTATION_TEMPLATE_PATH
protected static String	CLASS_TEMPLATE_PATH
protected static String	COMMENTED_ANNOTATION_TEMPLATE_PATH

Constructor Summary

Constructors

Constructor and Description
PropertyRegistrarClassGenerator(CompileUnit compUnit, Class<?> generatingClass, Calendar runDate, int srcMajorVersion, int jdkMajorVersion) Create a new instance w all info needed to generateSource a PropertyRegistrar file.

Method Summary

Modifier and Type	Method and Description
protected String	buildGeneratedClassFullName() The complete canonical name of the generated class, including the package.
protected String	buildGeneratedClassSimpleName() The simple class name of the generated class.
protected String	buildPackageString() The package declaration of the generated class.
protected String	buildRegistrationAddsString() Builds the source code for the content of the addPropertyRegistrations method.
protected String	buildRunDateString() A formatted date appropriate for the `Generated` annotation.
String	generateAnnotationSource() Generates the source for the 'Generated' annotation to place on the generated class.
String	generateSource() Generates the complete source for the AndHow proxy class as a String.
String	getTemplate(String path) Loads a text file as a String from a classpath path.

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_TEMPLATE_PATH

protected static final String CLASS_TEMPLATE_PATH

See Also:

Constant Field Values

ANNOTATION_TEMPLATE_PATH

protected static final String ANNOTATION_TEMPLATE_PATH

See Also:

Constant Field Values

COMMENTED_ANNOTATION_TEMPLATE_PATH

protected static final String COMMENTED_ANNOTATION_TEMPLATE_PATH

See Also:

Constant Field Values

Constructor Detail

PropertyRegistrarClassGenerator

public PropertyRegistrarClassGenerator(CompileUnit compUnit,
                                       Class<?> generatingClass,
                                       Calendar runDate,
                                       int srcMajorVersion,
                                       int jdkMajorVersion)

Create a new instance w all info needed to generateSource a PropertyRegistrar file.

Annotation Processor generated classes should have an @Generated annotation, however, the package of that class changed between JDK8 and JDK9. The srcMajorVersion is used to distinguish which annotation to use. JDK 1.8 = version 8, and so on.

Parameters:

compUnit - CompileUnit instance w/ all needed class and property info

generatingClass - The class of our AnnotationProcessor to be listed as the generator in the Generated annotation.

runDate - The Calendar date-time of the run, used for annotation. Passed in so all generated files can have the same timestamp.

srcMajorVersion - The major java lang version the output needs to be compatible with.

jdkMajorVersion - The major version of the JDK currently running.

Method Detail

getTemplate

public String getTemplate(String path)
                   throws Exception

Loads a text file as a String from a classpath path.

Parameters:

path - A path on the classpath, beginning with a slash.

Returns:

A String with the content of the file.

Throws:

Exception - IF the file cannot be read.

generateAnnotationSource

public String generateAnnotationSource()
                                throws Exception

Generates the source for the 'Generated' annotation to place on the generated class.

Returns:

A String containing an annotation, which may be commented out.

Throws:

Exception - If the template file for the annotation cannot be found.

generateSource

public String generateSource()
                      throws Exception

Generates the complete source for the AndHow proxy class as a String.

Returns:

A string containing the source code for a generated class.

Throws:

Exception - If any of the template files used for creating the class cannot be read.

buildPackageString

protected String buildPackageString()

The package declaration of the generated class.

This should match the class its proxying, including an empty string for classes in the default package.

Returns:

A String that can be directly used as the package declaration of the generated class.

buildGeneratedClassSimpleName

protected String buildGeneratedClassSimpleName()

The simple class name of the generated class.

As per Java conventions, a generated class starts with a '$'. The rest of the class name matches the class it proxies followed by "_AndHowProps".

Returns:

The simple class name (i.e. no package info).

buildGeneratedClassFullName

protected String buildGeneratedClassFullName()

The complete canonical name of the generated class, including the package.

The package portion matches the package of the class being proxied. The class name as described in buildGeneratedClassSimpleName().

Returns:

The canonical name of the generated class.

buildRunDateString

protected String buildRunDateString()

A formatted date appropriate for the `Generated` annotation.

Returns:

A formatted date and time.

buildRegistrationAddsString

protected String buildRegistrationAddsString()

Builds the source code for the content of the addPropertyRegistrations method.

Returns:

A String of source code.