xyz.maow.jarvae

Class Jars

java.lang.Object

xyz.maow.jarvae.Jars

public final class Jars
extends java.lang.Object

A utility class for operating on instances of JarFile and JarEntry.

This class serves to reduce the total amount of code required by the Jar API by providing common or otherwise useful functionality in the form of static methods.

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
static boolean	contains(java.util.jar.JarFile jar, java.nio.file.Path path) Returns true if the specified jar file contains an entry matching the path.
static xyz.maow.jarvae.Jars.JarEntries	entries(java.util.jar.JarFile jar) Wraps the entries of the specified jar file around an iterable class.
static java.util.List<java.util.jar.JarEntry>	entriesList(java.util.jar.JarFile jar) Creates a new list of jar entries to store the specified jar file's entries.
static java.io.File	extract(java.util.jar.JarFile jar, java.util.jar.JarEntry entry, java.io.File file) Deprecated. To reduce overall complexity, this method has been deprecated.
static java.io.File	extract(java.util.jar.JarFile jar, java.util.jar.JarEntry entry, java.io.File file, int bufferSize) Deprecated. To reduce overall complexity, this method has been deprecated.
static java.nio.file.Path	extract(java.util.jar.JarFile jar, java.util.jar.JarEntry entry, java.nio.file.Path path) Extracts a jar entry to a file at the specified path with the default buffer size of 1024.
static java.nio.file.Path	extract(java.util.jar.JarFile jar, java.util.jar.JarEntry entry, java.nio.file.Path path, int bufferSize) Extracts a jar entry to a file at the specified path with the specified buffer size.
static java.io.File	extract(java.util.jar.JarFile jar, java.util.jar.JarEntry entry, java.lang.String s) Deprecated. To reduce overall complexity, this method has been deprecated.
static java.io.File	extract(java.util.jar.JarFile jar, java.util.jar.JarEntry entry, java.lang.String s, int bufferSize) Deprecated. To reduce overall complexity, this method has been deprecated.
static void	forEach(java.util.jar.JarFile jar, java.util.function.Consumer<java.util.jar.JarEntry> consumer) Iterates over each entry in a jar file, calling a Consumer on them.
static java.nio.file.FileSystem	getJarFileSystem(java.nio.file.Path path) Returns a FileSystem representing the filesystem of the Path as a jar file.
static java.nio.file.FileSystem	getJarFileSystem(java.nio.file.Path path, java.util.Map<java.lang.String,java.lang.String> env) Returns a FileSystem representing the filesystem of the Path as a jar file.
static java.util.stream.Stream<java.lang.String>	lines(java.util.jar.JarFile jar, java.util.jar.JarEntry entry) Returns a Stream that can be used to read the lines of a jar entry.
static java.util.jar.JarInputStream	newInputStream(java.io.File file) Deprecated. To reduce overall complexity, this method has been deprecated.
static java.util.jar.JarInputStream	newInputStream(java.nio.file.Path path) Creates a new jar input stream from a path.
static java.util.jar.JarInputStream	newInputStream(java.lang.String... strings) Deprecated. To reduce overall complexity, this method has been deprecated.
static java.util.jar.JarOutputStream	newOutputStream(java.io.File file) Deprecated. To reduce overall complexity, this method has been deprecated.
static java.util.jar.JarOutputStream	newOutputStream(java.nio.file.Path path) Creates a new jar output stream from a path.
static java.util.jar.JarOutputStream	newOutputStream(java.lang.String... strings) Deprecated. To reduce overall complexity, this method has been deprecated.
static byte[]	readAllBytes(java.util.jar.JarFile jar, java.util.jar.JarEntry entry) Using a jar file, reads the contents of a jar entry as a byte array, using the default buffer size of 1024.
static byte[]	readAllBytes(java.util.jar.JarFile jar, java.util.jar.JarEntry entry, int bufferSize) Using a jar file, reads the contents of a jar entry as a byte array, using the specified buffer size.
static java.util.List<java.lang.String>	readAllLines(java.util.jar.JarFile jar, java.util.jar.JarEntry entry) Reads all the lines in an entry to a List<String>.

Methods inherited from class java.lang.Object

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

Method Detail

contains

public static boolean contains(java.util.jar.JarFile jar,
                               java.nio.file.Path path)

Returns true if the specified jar file contains an entry matching the path.

Parameters:

jar - the specified jar file

path - a path representing a possible entry in the specified jar file

Returns:

whether an entry with the specified path exists in the jar file

Since:

1.1.0

getJarFileSystem

public static java.nio.file.FileSystem getJarFileSystem(java.nio.file.Path path,
                                                        java.util.Map<java.lang.String,java.lang.String> env)
                                                 throws java.io.IOException,
                                                        java.net.URISyntaxException

Returns a FileSystem representing the filesystem of the Path as a jar file.

Instead of constructing a new empty map by hand, use getJarFileSystem(Path).

Parameters:

path - the path of the target jar file

env - provider-specific configuration properties, should be empty instead of null

Returns:

a new instance of FileSystem representing a jar file

Throws:

java.io.IOException - if an I/O exception has occurred

java.net.URISyntaxException - if the URI was unable to be parsed

java.lang.NullPointerException - if path or env are null

Since:

1.1.0

getJarFileSystem

public static java.nio.file.FileSystem getJarFileSystem(java.nio.file.Path path)
                                                 throws java.io.IOException,
                                                        java.net.URISyntaxException

Returns a FileSystem representing the filesystem of the Path as a jar file.

Parameters:

path - the path of the target jar file

Returns:

a new instance of FileSystem representing a jar file

Throws:

java.io.IOException - if an I/O exception has occurred

java.net.URISyntaxException - if the URI was unable to be parsed

java.lang.NullPointerException - if path is null

Since:

1.1.0

lines

public static java.util.stream.Stream<java.lang.String> lines(java.util.jar.JarFile jar,
                                                              java.util.jar.JarEntry entry)
                                                       throws java.io.IOException

Returns a Stream that can be used to read the lines of a jar entry.

As opposed to readAllLines(JarFile, JarEntry), this method is lazily-evaluated. This means that it is better to use this method on large files instead of the mentioned readAllLines.

Parameters:

jar - the jar file this entry resides in

entry - the target jar entry to read

Returns:

a lazily-evaluated Stream containing the lines in this jar entry

Throws:

java.io.IOException - if an I/O exception has occurred

Since:

1.1.0

readAllLines

public static java.util.List<java.lang.String> readAllLines(java.util.jar.JarFile jar,
                                                            java.util.jar.JarEntry entry)
                                                     throws java.io.IOException

Reads all the lines in an entry to a List<String>.

Should not be used when reading larger files, as it will take a lot of memory due to being eagerly-evaluated.

Parameters:

jar - the jar file this entry resides in

entry - the target jar entry to read

Returns:

this entry's contents as a list of strings

Throws:

java.io.IOException - if an I/O exception has occurred

java.lang.NullPointerException - if jar or entry are null

Since:

1.1.0

readAllBytes

public static byte[] readAllBytes(java.util.jar.JarFile jar,
                                  java.util.jar.JarEntry entry,
                                  int bufferSize)
                           throws java.io.IOException

Using a jar file, reads the contents of a jar entry as a byte array, using the specified buffer size.

Parameters:

jar - the jar file

entry - the jar entry being read from

bufferSize - the size of the buffer used to read from the entry

Returns:

the contents of the jar entry as a byte[]

Throws:

java.io.IOException - if an I/O exception has occurred

java.lang.NullPointerException - if jar or entry are null

Since:

1.1.0

readAllBytes

public static byte[] readAllBytes(java.util.jar.JarFile jar,
                                  java.util.jar.JarEntry entry)
                           throws java.io.IOException

Using a jar file, reads the contents of a jar entry as a byte array, using the default buffer size of 1024.

Parameters:

jar - the jar file

entry - the jar entry being read from

Returns:

the contents of the jar entry as a byte[]

Throws:

java.io.IOException - if an I/O exception has occurred

Since:

1.1.0

extract

@Deprecated
public static java.io.File extract(java.util.jar.JarFile jar,
                                                java.util.jar.JarEntry entry,
                                                java.io.File file,
                                                int bufferSize)
                                         throws java.io.IOException

Deprecated. To reduce overall complexity, this method has been deprecated.

Throws:

java.io.IOException

See Also:

extract(JarFile, JarEntry, Path, int)

extract

@Deprecated
public static java.io.File extract(java.util.jar.JarFile jar,
                                                java.util.jar.JarEntry entry,
                                                java.io.File file)
                                         throws java.io.IOException

Deprecated. To reduce overall complexity, this method has been deprecated.

Throws:

java.io.IOException

See Also:

extract(JarFile, JarEntry, Path)

extract

@Deprecated
public static java.io.File extract(java.util.jar.JarFile jar,
                                                java.util.jar.JarEntry entry,
                                                java.lang.String s,
                                                int bufferSize)
                                         throws java.io.IOException

Deprecated. To reduce overall complexity, this method has been deprecated.

Throws:

java.io.IOException

See Also:

extract(JarFile, JarEntry, Path, int)

extract

@Deprecated
public static java.io.File extract(java.util.jar.JarFile jar,
                                                java.util.jar.JarEntry entry,
                                                java.lang.String s)
                                         throws java.io.IOException

Deprecated. To reduce overall complexity, this method has been deprecated.

Throws:

java.io.IOException

See Also:

extract(JarFile, JarEntry, Path)

extract

public static java.nio.file.Path extract(java.util.jar.JarFile jar,
                                         java.util.jar.JarEntry entry,
                                         java.nio.file.Path path,
                                         int bufferSize)
                                  throws java.io.IOException

Extracts a jar entry to a file at the specified path with the specified buffer size.

Parameters:

jar - a jar file

entry - the jar entry to be extracted

path - the path of the file

bufferSize - the size of the buffer being used to read from the entry

Returns:

the instance of Path passed to this method

Throws:

java.io.IOException - if an I/O exception has occurred

extract

public static java.nio.file.Path extract(java.util.jar.JarFile jar,
                                         java.util.jar.JarEntry entry,
                                         java.nio.file.Path path)
                                  throws java.io.IOException

Extracts a jar entry to a file at the specified path with the default buffer size of 1024.

Parameters:

jar - a jar file

entry - the jar entry to be extracted

path - the path of the file

Returns:

the instance of Path passed to this method

Throws:

java.io.IOException - if an I/O exception has occurred

entries

public static xyz.maow.jarvae.Jars.JarEntries entries(java.util.jar.JarFile jar)

Wraps the entries of the specified jar file around an iterable class.

This can be used to iterate over the entries of a jar file using the enhanced for loop (or foreach) syntax.

 for (JarEntry entry : Jars.entries(jar)) {
     ...
 }
 

Parameters:

jar - the specified jar file

Returns:

an iterable wrapper class

entriesList

public static java.util.List<java.util.jar.JarEntry> entriesList(java.util.jar.JarFile jar)

Creates a new list of jar entries to store the specified jar file's entries.

Parameters:

jar - the specified jar file

Returns:

a list of jar entries from the specified jar file

Throws:

java.lang.NullPointerException - if jar is null

forEach

public static void forEach(java.util.jar.JarFile jar,
                           java.util.function.Consumer<java.util.jar.JarEntry> consumer)

Iterates over each entry in a jar file, calling a Consumer on them.

This method serves as a functional alternative to entries(JarFile).

Parameters:

jar - the specified jar file

consumer - the action to perform on each entry

Throws:

java.lang.NullPointerException - if jar or consumer is null

newInputStream

@Deprecated
public static java.util.jar.JarInputStream newInputStream(java.lang.String... strings)
                                                                throws java.io.IOException

Deprecated. To reduce overall complexity, this method has been deprecated.

Throws:

java.io.IOException

See Also:

newInputStream(Path)

newInputStream

@Deprecated
public static java.util.jar.JarInputStream newInputStream(java.io.File file)
                                                                throws java.io.IOException

Deprecated. To reduce overall complexity, this method has been deprecated.

Throws:

java.io.IOException

See Also:

newInputStream(Path)

newInputStream

public static java.util.jar.JarInputStream newInputStream(java.nio.file.Path path)
                                                   throws java.io.IOException

Creates a new jar input stream from a path.

This is purely cosmetic and only serves to reduce clutter.

Parameters:

path - a path representing a jar file

Returns:

a new instance of JarInputStream from the specified path

Throws:

java.io.IOException - if an I/O exception occurred

newOutputStream

@Deprecated
public static java.util.jar.JarOutputStream newOutputStream(java.lang.String... strings)
                                                                  throws java.io.IOException

Deprecated. To reduce overall complexity, this method has been deprecated.

Throws:

java.io.IOException

See Also:

newOutputStream(Path)

newOutputStream

@Deprecated
public static java.util.jar.JarOutputStream newOutputStream(java.io.File file)
                                                                  throws java.io.IOException

Deprecated. To reduce overall complexity, this method has been deprecated.

Throws:

java.io.IOException

See Also:

newOutputStream(Path)

newOutputStream

public static java.util.jar.JarOutputStream newOutputStream(java.nio.file.Path path)
                                                     throws java.io.IOException

Creates a new jar output stream from a path.

This is purely cosmetic and only serves to reduce clutter.

Parameters:

path - a path representing a jar file

Returns:

a new instance of JarOutputStream from the specified path

Throws:

java.io.IOException - if an I/O exception occurred