org.yarnandtail.andhow.compile

Class CompileUtil

java.lang.Object

org.yarnandtail.andhow.compile.CompileUtil

public class CompileUtil
extends Object

Utilities for the AndHow AnnotationProcessor.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JDK8_GEN_CLASS
static String	JDK9UP_GEN_CLASS

Method Summary

Modifier and Type	Method and Description
static String	getGeneratedAnnotationClassName(int jdkMajorVersion) Determine the correct 'Generated' annotation class name based on the Java major version.
static int	getMajorJavaVersion() The major version number of the current runtime.
static int	getMajorJavaVersion(SourceVersion srcVersion) Determine the major version from the SourceVersion.
static int	getMajorJavaVersion(String versionString) Determine the major version from the java.version System property String.
static boolean	isGeneratedVersionDeterministic(int sourceVersion, int jdkMajorVersion) Do we know for sure which JDK version to generate for?

Methods inherited from class java.lang.Object

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

Field Detail

JDK8_GEN_CLASS

public static final String JDK8_GEN_CLASS

See Also:

Constant Field Values

JDK9UP_GEN_CLASS

public static final String JDK9UP_GEN_CLASS

See Also:

Constant Field Values

Method Detail

getGeneratedAnnotationClassName

public static String getGeneratedAnnotationClassName(int jdkMajorVersion)

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:

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

Returns:

The fully qualified class name of the Generated annotation.

isGeneratedVersionDeterministic

public static boolean isGeneratedVersionDeterministic(int sourceVersion,
                                                      int jdkMajorVersion)

Do we know for sure which JDK version to generate for?

There is one case that cannot be determined: When ProcessingEnvironment.getSourceVersion() reports version 8* and the current JDK is greater than 8. See https://github.com/eeverman/andhow/issues/630

*Source versions less than 8 are not supported by AndHow.

Parameters:

sourceVersion -

jdkMajorVersion -

Returns:

getMajorJavaVersion

public static int getMajorJavaVersion(SourceVersion srcVersion)

Determine the major version from the SourceVersion.

SourceVersion is available at compile time to the AnnotationProcessor and it marks the Java version that the source code needs to be compatible with. This may be different than the current JDK.

Parameters:

srcVersion - As given to the AnnotationProcessor in the ProcessingEnvironment.

Returns:

The major version number

getMajorJavaVersion

public static int getMajorJavaVersion()

The major version number of the current runtime.

This uses the System.getProperty("java.version") and the getMajorJavaVersion(String) method.

Returns:

The major version number

getMajorJavaVersion

public static int getMajorJavaVersion(String versionString)

Determine the major version from the java.version System property String.

The java.version string is parsed and major version returned. All versions are integers, thus version `1.8` returns `8`, JDK '10' return 10. A RuntimeException is thrown if the version cannot be parsed.

Java 10 introduces the Runtime.version(), which would remove the need for this method, however, its not available in JDK 8.

Parameters:

versionString - as returned from System.getProperty("java.version")

Returns:

The major version number