Package org.revapi.java.test.support

Class Jar

java.lang.Object

org.revapi.java.test.support.Jar

All Implemented Interfaces:

org.junit.rules.TestRule

public class Jar
extends Object
implements org.junit.rules.TestRule

This class can be used in tests to make it easy to compile custom source code into jars and then use the Java Annotation processing API to analyze the compiled classes.

Simply declare a JUnit rule field:

    @Rule
     public Jar jar = new Jar();
 

and then use it in your test methods to compile and use code:

     Jar.BuildOutput build = jar.from()
         .classPathSources("/", "my/package/MySource.java")
         .classPathResources("/", "META-INF/my-file-in-jar.txt")
         .build();

     Jar.Environment env = build.analyze();
     TypeElement mySourceClass = env.elements().getElement("my.package.MySource");
     ...
     File jarFile = build.jarFile();
     Files.copy(jarFile.toPath(), Paths.get("/"));
     ...
 

If you use this class as a JUnit rule, you don't have to handle cleanup of the compilation results. It will be done automagically.

Since:

0.1.0

Author:

Lukas Krejci

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	Jar.Builder
class	Jar.BuildOutput	Gives access to the compilation results.
static interface	Jar.Environment

Constructor Summary

Constructors

Constructor	Description
Jar()

Method Summary

Modifier and Type	Method	Description
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement base, org.junit.runner.Description description)	Applies a jar rule to a test method.
void	cleanUp()	If you're using the Jar instance as a JUnit rule, you don't have to call this method.
Jar.Builder	from()	Instantiates a builder using which the contents of a compiled jar file can be composed.

Methods inherited from class java.lang.Object

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

Constructor Detail

Jar

public Jar()

Method Detail

apply

public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base,
                                               org.junit.runner.Description description)

Applies a jar rule to a test method. Don't call directly but instead let JUnit handle it.

Specified by:

apply in interface org.junit.rules.TestRule

from

public Jar.Builder from()

Instantiates a builder using which the contents of a compiled jar file can be composed.

Returns:

a builder to gather sources and resources to compile and compose a jar file

cleanUp

public void cleanUp()

If you're using the Jar instance as a JUnit rule, you don't have to call this method. Otherwise this can be used to remove the compiled jar files from the filesystem.