org.cadixdev.atlas.jar

Class JarFile

java.lang.Object

org.cadixdev.atlas.jar.JarFile

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, org.cadixdev.bombe.asm.jar.ClassProvider

public class JarFile
extends java.lang.Object
implements org.cadixdev.bombe.asm.jar.ClassProvider, java.io.Closeable

A representation of a JAR file, with the class entries cached.

Since:

0.1.0

Constructor Summary

Constructors

Constructor and Description
JarFile(java.nio.file.Path path)

Method Summary

Modifier and Type	Method and Description
void	close()
org.cadixdev.bombe.jar.AbstractJarEntry	get(JarPath path) Gets the entry for the given JAR path.
byte[]	get(java.lang.String klass)
org.cadixdev.bombe.jar.JarClassEntry	getClass(JarPath path) Gets the cached class entry, of the given JAR path.
org.cadixdev.bombe.jar.JarClassEntry	getClass(java.lang.String name) Gets the cached class entry, of the given name.
java.lang.String	getName() Gets the name (location on file system) of the JAR file.
void	transform(java.nio.file.Path export, org.cadixdev.bombe.jar.JarEntryTransformer... transformers) Transforms the JAR file, with the given JarEntryTransformers, writing to the given output JAR path.
java.util.stream.Stream<JarPath>	walk(JarVisitOption... options) Walks through the jar entries within the JAR file, omitting those targeted by a JarVisitOption.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cadixdev.bombe.asm.jar.ClassProvider

getAsNode, getAsNode, of, of

Constructor Detail

JarFile

public JarFile(java.nio.file.Path path)
        throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getName

public java.lang.String getName()

Gets the name (location on file system) of the JAR file.

Returns:

The name

get

public org.cadixdev.bombe.jar.AbstractJarEntry get(JarPath path)
                                            throws java.io.IOException

Gets the entry for the given JAR path.

Class entries will be cached upon use.

Parameters:

path - The path of the entry

Returns:

The entry, or null if no entry for the path exists

Throws:

java.io.IOException - Should an issue occur reading the entry

getClass

public org.cadixdev.bombe.jar.JarClassEntry getClass(JarPath path)

Gets the cached class entry, of the given JAR path.

Parameters:

path - The class's JAR entry path

Returns:

The class entry, or null if not present

getClass

public org.cadixdev.bombe.jar.JarClassEntry getClass(java.lang.String name)

Gets the cached class entry, of the given name.

Parameters:

name - The class name

Returns:

The class entry, or null if not present

walk

public java.util.stream.Stream<JarPath> walk(JarVisitOption... options)
                                      throws java.io.IOException

Walks through the jar entries within the JAR file, omitting those targeted by a JarVisitOption.

Parameters:

options - The visit options to use, while walking

Returns:

The jar entries

Throws:

java.io.IOException - Should an issue with reading occur

transform

public void transform(java.nio.file.Path export,
                      org.cadixdev.bombe.jar.JarEntryTransformer... transformers)
               throws java.io.IOException

Transforms the JAR file, with the given JarEntryTransformers, writing to the given output JAR path.

Parameters:

export - The JAR path to write to

transformers - The transformers to use

Throws:

java.io.IOException - Should an issue with reading or writing occur

get

public byte[] get(java.lang.String klass)

Specified by:

get in interface org.cadixdev.bombe.asm.jar.ClassProvider

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException