Package org.revapi.java.test.support

Class Jar.Builder

java.lang.Object

org.revapi.java.test.support.Jar.Builder

Enclosing class:

Jar

public final class Jar.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
Jar.BuildOutput	build()	Compiles the sources and composes a jar file that comprises of the class files on the specified locations (defined by classPathSources(String, String...) et al.) along with some resources on the specified locations (defined by classPathResources(String, String...) et al.).
Jar.Builder	classPathResources(String root, String... resources)	Adds given resources to the compiled jar file.
Jar.Builder	classPathSources(String root, String... sources)	Finds given sources under given root in the classpath.
Jar.Builder	fileResources(File root, File... resources)	Similar to classPathResources(String, String...) but locates the sources to compile using actual files.
Jar.Builder	fileSources(File root, File... sources)	Similar to classPathSources(String, String...) but locates the sources to compile using actual files.

Methods inherited from class java.lang.Object

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

Method Detail

classPathSources

public Jar.Builder classPathSources(String root,
                                    String... sources)

Finds given sources under given root in the classpath. The resulting jar file will contain the compiled classes on the same relatives paths as the provided sources.

Parameters:

root - the root path in the classloader to resolve the sources against

sources - the list of relative paths on which the source files are located in the classloader

Returns:

this instance

classPathResources

public Jar.Builder classPathResources(String root,
                                      String... resources)

Adds given resources to the compiled jar file. The paths to the resources are resolved in the same way as with sources.

Parameters:

root - the root against which to resolve the resource paths in the classloader

resources - the relative paths of the resources

Returns:

this instance

See Also:

classPathSources(String, String...)

fileSources

public Jar.Builder fileSources(File root,
                               File... sources)

Similar to classPathSources(String, String...) but locates the sources to compile using actual files.

fileResources

public Jar.Builder fileResources(File root,
                                 File... resources)

Similar to classPathResources(String, String...) but locates the sources to compile using actual files.

build

public Jar.BuildOutput build()
                      throws IOException

Compiles the sources and composes a jar file that comprises of the class files on the specified locations (defined by classPathSources(String, String...) et al.) along with some resources on the specified locations (defined by classPathResources(String, String...) et al.).

Returns:

an object to access the results of the compilation

Throws:

IOException - on error