Package io.microsphere.util.jar

Class JarUtils

java.lang.Object

io.microsphere.util.jar.JarUtils

All Implemented Interfaces:

Utils

public abstract class JarUtils
extends java.lang.Object
implements Utils

Jar Utility class

Since:

1.0.0

Author:

Mercy

See Also:

JarEntry, JarFile

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	MANIFEST_RESOURCE_PATH	The resource path of Manifest file in JAR archive.

Method Summary

Modifier and Type	Method	Description
protected static void	assertJarURLProtocol(java.net.URL jarURL)	Assert jarURL argument is valid , only supported protocols : jar and file
protected static void	doExtract(java.util.jar.JarFile jarFile, java.lang.Iterable<java.util.jar.JarEntry> jarEntries, java.io.File targetDirectory)
protected static java.util.List<java.util.jar.JarEntry>	doFilter(java.lang.Iterable<java.util.jar.JarEntry> jarEntries, JarEntryFilter jarEntryFilter)
static void	extract(java.io.File jarSourceFile, java.io.File targetDirectory)	Extract the source JarFile to target directory
static void	extract(java.io.File jarSourceFile, java.io.File targetDirectory, JarEntryFilter jarEntryFilter)	Extract the source JarFile to target directory with specified JarEntryFilter
static void	extract(java.net.URL jarResourceURL, java.io.File targetDirectory, JarEntryFilter jarEntryFilter)	Extract the source JarFile to target directory with specified JarEntryFilter
static void	extract(java.util.jar.JarFile jarFile, java.io.File targetDirectory, JarEntryFilter jarEntryFilter)	Extract the source JarFile to target directory with specified JarEntryFilter
static java.util.List<java.util.jar.JarEntry>	filter(java.util.jar.JarFile jarFile, JarEntryFilter jarEntryFilter)	Filter JarEntry list from JarFile
static java.util.jar.JarEntry	findJarEntry(java.net.URL jarURL)	Find JarEntry from specified url
static java.lang.String	resolveJarAbsolutePath(java.net.URL jarURL)	Resolve absolute path from the URL of JarEntry
static java.lang.String	resolveRelativePath(java.net.URL jarURL)	Resolve Relative path from Jar URL
static java.util.jar.JarFile	toJarFile(java.net.URL jarURL)	Create a JarFile from specified URL of JarFile

Methods inherited from class java.lang.Object

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

Field Detail

MANIFEST_RESOURCE_PATH

public static final java.lang.String MANIFEST_RESOURCE_PATH

The resource path of Manifest file in JAR archive. Typically located under META-INF/MANIFEST.MF in standard Java archives.

See Also:

Constant Field Values

Method Detail

toJarFile

public static java.util.jar.JarFile toJarFile(java.net.URL jarURL)
                                       throws java.io.IOException

Create a JarFile from specified URL of JarFile

Parameters:

jarURL - URL of JarFile or JarEntry

Returns:

JarFile

Throws:

java.io.IOException - If jar file is invalid, see JarFile(String)

assertJarURLProtocol

protected static void assertJarURLProtocol(java.net.URL jarURL)
                                    throws java.lang.NullPointerException,
                                           java.lang.IllegalArgumentException

Assert jarURL argument is valid , only supported protocols : jar and file

Parameters:

jarURL - URL of JarFile or JarEntry

Throws:

java.lang.NullPointerException - If jarURL is null

java.lang.IllegalArgumentException - If URL.getProtocol() is not jar or file

resolveRelativePath

@Nonnull
public static java.lang.String resolveRelativePath(java.net.URL jarURL)
                                            throws java.lang.NullPointerException,
                                                   java.lang.IllegalArgumentException

Resolve Relative path from Jar URL

Parameters:

jarURL - URL of JarFile or JarEntry

Returns:

Non-null

Throws:

java.lang.NullPointerException - see assertJarURLProtocol(URL)

java.lang.IllegalArgumentException - see assertJarURLProtocol(URL)

resolveJarAbsolutePath

@Nonnull
public static java.lang.String resolveJarAbsolutePath(java.net.URL jarURL)
                                               throws java.lang.NullPointerException,
                                                      java.lang.IllegalArgumentException

Resolve absolute path from the URL of JarEntry

Parameters:

jarURL - URL of JarFile or JarEntry

Returns:

If URL.getProtocol() equals jar or file , resolves absolute path, or return null

Throws:

java.lang.NullPointerException - see assertJarURLProtocol(URL)

java.lang.IllegalArgumentException - see assertJarURLProtocol(URL)

filter

@Nonnull
public static java.util.List<java.util.jar.JarEntry> filter(java.util.jar.JarFile jarFile,
                                                            JarEntryFilter jarEntryFilter)

Filter JarEntry list from JarFile

Parameters:

jarFile - JarFile

jarEntryFilter - JarEntryFilter

Returns:

Read-only List

doFilter

protected static java.util.List<java.util.jar.JarEntry> doFilter(java.lang.Iterable<java.util.jar.JarEntry> jarEntries,
                                                                 JarEntryFilter jarEntryFilter)

findJarEntry

public static java.util.jar.JarEntry findJarEntry(java.net.URL jarURL)
                                           throws java.io.IOException

Find JarEntry from specified url

Parameters:

jarURL - jar resource url

Returns:

If found , return JarEntry

Throws:

java.io.IOException

extract

public static void extract(java.io.File jarSourceFile,
                           java.io.File targetDirectory)
                    throws java.io.IOException

Extract the source JarFile to target directory

Parameters:

jarSourceFile - the source JarFile

targetDirectory - target directory

Throws:

java.io.IOException - When the source jar file is an invalid JarFile

extract

public static void extract(java.io.File jarSourceFile,
                           java.io.File targetDirectory,
                           JarEntryFilter jarEntryFilter)
                    throws java.io.IOException

Extract the source JarFile to target directory with specified JarEntryFilter

Parameters:

jarSourceFile - the source JarFile

targetDirectory - target directory

jarEntryFilter - JarEntryFilter

Throws:

java.io.IOException - When the source jar file is an invalid JarFile

extract

public static void extract(java.util.jar.JarFile jarFile,
                           java.io.File targetDirectory,
                           JarEntryFilter jarEntryFilter)
                    throws java.io.IOException

Extract the source JarFile to target directory with specified JarEntryFilter

Parameters:

jarFile - the source JarFile

targetDirectory - target directory

jarEntryFilter - JarEntryFilter

Throws:

java.io.IOException - When the source jar file is an invalid JarFile

extract

public static void extract(java.net.URL jarResourceURL,
                           java.io.File targetDirectory,
                           JarEntryFilter jarEntryFilter)
                    throws java.io.IOException

Extract the source JarFile to target directory with specified JarEntryFilter

Parameters:

jarResourceURL - The resource URL of JarFile or JarEntry

targetDirectory - target directory

jarEntryFilter - JarEntryFilter

Throws:

java.io.IOException - When the source jar file is an invalid JarFile

doExtract

protected static void doExtract(java.util.jar.JarFile jarFile,
                                java.lang.Iterable<java.util.jar.JarEntry> jarEntries,
                                java.io.File targetDirectory)
                         throws java.io.IOException

Throws:

java.io.IOException