org.cadixdev.atlas

Class Atlas

java.lang.Object

org.cadixdev.atlas.Atlas

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class Atlas
extends java.lang.Object
implements java.io.Closeable

An Atlas describes transformations, and an environment to transform Java binaries.

Atlases are independent of the specific binary being processed, allowing them to be used for multiple binary transformations.

Since:

0.1.0

Constructor Summary

Constructors

Constructor and Description
Atlas()

Method Summary

Modifier and Type	Method and Description
void	close() Note that this will clear the classpath!
Atlas	install(java.util.function.Function<AtlasTransformerContext,org.cadixdev.bombe.jar.JarEntryTransformer> transformer) Installs a transformer to the Atlas, noting that each installed transformer will be constructed once for each binary processed.
void	run(JarFile jar, java.nio.file.Path output) Runs the Atlas on the given input jar, saving the result to the given output path.
void	run(java.nio.file.Path input, java.nio.file.Path output) Runs the Atlas on the given input binary, saving the result to the output path.
Atlas	use(java.nio.file.Path jar) Adds the given JAR file to the Atlas classpath, allowing the inheritance provider to have a more complete view of the environment.

Methods inherited from class java.lang.Object

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

Constructor Detail

Atlas

public Atlas()

Method Detail

use

public Atlas use(java.nio.file.Path jar)
          throws java.io.IOException

Adds the given JAR file to the Atlas classpath, allowing the inheritance provider to have a more complete view of the environment.

Parameters:

jar - The path to the JAR file

Returns:

this, for chaining

Throws:

java.io.IOException - Should an issue occur reading the JAR file

install

public Atlas install(java.util.function.Function<AtlasTransformerContext,org.cadixdev.bombe.jar.JarEntryTransformer> transformer)

Installs a transformer to the Atlas, noting that each installed transformer will be constructed once for each binary processed.

Parameters:

transformer - The transformer constructor

Returns:

this, for chaining

run

public void run(java.nio.file.Path input,
                java.nio.file.Path output)
         throws java.io.IOException

Runs the Atlas on the given input binary, saving the result to the output path.

Parameters:

input - The input binary

output - The output binary

Throws:

java.io.IOException - Should an issue occur reading the input JAR, or reading the output JAR

See Also:

run(JarFile, Path)

run

public void run(JarFile jar,
                java.nio.file.Path output)
         throws java.io.IOException

Runs the Atlas on the given input jar, saving the result to the given output path.

Parameters:

jar - The input jar

output - The output binary

Throws:

java.io.IOException - Should an issue occur reading the input JAR, or reading the output JAR

close

public void close()
           throws java.io.IOException

Note that this will clear the classpath!

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException