org.yarnandtail.andhow.compile

Class CompileUtil

java.lang.Object

org.yarnandtail.andhow.compile.CompileUtil

public class CompileUtil
extends Object

Utilities for the AndHow AnnotationProcessor.

Constructor Summary

Constructors

Constructor and Description
CompileUtil()

Method Summary

Modifier and Type	Method and Description
static String	getGeneratedAnnotationClassName() Determine the correct 'Generated' annotation class name based on the current Java runtime.
static String	getGeneratedAnnotationClassName(int javaMajorVersion) Determine the correct 'Generated' annotation class name based on the Java major version.
static int	getMajorJavaVersion(String versionString) Determine the major version of the Java runtime based on a version string.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompileUtil

public CompileUtil()

Method Detail

getGeneratedAnnotationClassName

public static String getGeneratedAnnotationClassName()

Determine the correct 'Generated' annotation class name based on the current Java runtime. This method fetches the version of the current runtime via getMajorJavaVersion() and uses that to call getGeneratedAnnotationClassName(int).

Returns:

A the fully qualified class name of the Generated annotation.

getGeneratedAnnotationClassName

public static String getGeneratedAnnotationClassName(int javaMajorVersion)

Determine the correct 'Generated' annotation class name based on the Java major version. Java 8 uses the @javax.annotation.Generated annotation to mark a generated class. Java 9 and beyond uses @javax.annotation.processing.Generated Both annotations are SOURCE level retention, so they are only present in the source code and no record of them is compiled into the binary. Thus, the determination of which one to use is based only on the Java version used to compile, not the -source or -target settings.

Parameters:

javaMajorVersion - The Java version in integer form. Use '8' for 1.8.

Returns:

A the fully qualified class name of the Generated annotation.

getMajorJavaVersion

public static int getMajorJavaVersion(String versionString)

Determine the major version of the Java runtime based on a version string. All versions are integers, thus version `1.8` returns `8`. Java 10 introduces the Runtime.version(), which would remove the need for this method, however, at the moment the code is still Java 8 compatable.

Parameters:

versionString - As returned from SystemProperties.getProperty("java.version")

Returns: