capsule

Class Jar

java.lang.Object

capsule.Jar

public class Jar
extends Object

A JAR file that can be easily modified.

Constructor Summary

Constructors

Constructor and Description
Jar() Creates a new, empty, JAR
Jar(File jar) Reads in the JAR from the given File.
Jar(InputStream jar) Reads in the JAR from the given InputStream.
Jar(JarFile jar) Reads in the JAR from the given JarFile.
Jar(Path jar) Reads in the JAR from the given Path.
Jar(String jar) Reads in the JAR from the given path.

Method Summary

Modifier and Type	Method and Description
Jar	addEntry(Path path, InputStream is) Adds an entry to this JAR.
Jar	addEntry(Path path, Path file) Adds an entry to this JAR.
Jar	addEntry(Path path, String file) Adds an entry to this JAR.
Jar	addEntry(String path, File file) Adds an entry to this JAR.
Jar	addEntry(String path, InputStream is) Adds an entry to this JAR.
Jar	addEntry(String path, String file) Adds an entry to this JAR.
String	getAttribute(String name) Returns an attribute's value from this JAR's manifest's main section.
String	getAttribute(String section, String name) Returns an attribute's value from a non-main section of this JAR's manifest.
List<String>	getListAttribute(String name) Returns an attribute's list value from this JAR's manifest's main section.
List<String>	getListAttribute(String section, String name) Returns an attribute's list value from a non-main section of this JAR's manifest.
Manifest	getManifest() Returns the manifest of this JAR.
Jar	setAttribute(String name, String value) Sets an attribute in the main section of the manifest.
Jar	setAttribute(String section, String name, String value)
Jar	setListAttribute(String name, List<String> values) Sets an attribute in the main section of the manifest to a list.
Jar	setListAttribute(String section, String name, List<String> values) Sets an attribute in a non-main section of the manifest to a list.
static InputStream	toInputStream(String str, Charset charset) Turns a String into an InputStream containing the string's encoded characters.
File	write(File file) Writes this JAR to a file.
Path	write(Path path) Writes this JAR to a file.
void	write(String file) Writes this JAR to a file.
<T extends OutputStream> T	write(T os) Writes this JAR to an output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

Jar

public Jar()

Creates a new, empty, JAR

Jar

public Jar(InputStream jar)
    throws IOException

Reads in the JAR from the given InputStream. Modifications will not be made to the original JAR file, but to a new copy, which is then written with write().

Throws:

IOException

Jar

public Jar(JarFile jar)
    throws IOException

Reads in the JAR from the given JarFile. Modifications will not be made to the original JAR file, but to a new copy, which is then written with write().

Throws:

IOException

Jar

public Jar(Path jar)
    throws IOException

Reads in the JAR from the given Path. Modifications will not be made to the original JAR file, but to a new copy, which is then written with write().

Throws:

IOException

Jar

public Jar(File jar)
    throws IOException

Reads in the JAR from the given File. Modifications will not be made to the original JAR file, but to a new copy, which is then written with write().

Throws:

IOException

Jar

public Jar(String jar)
    throws IOException

Reads in the JAR from the given path. Modifications will not be made to the original JAR file, but to a new copy, which is then written with write().

Throws:

IOException

Method Detail

getManifest

public Manifest getManifest()

Returns the manifest of this JAR. Modifications to the manifest will be reflected in the written JAR, provided they are done before any entries are added with addEntry().

setAttribute

public Jar setAttribute(String name,
                        String value)

Sets an attribute in the main section of the manifest.

Parameters:

name - the attribute's name

value - the attribute's value

Returns:

this

Throws:

IllegalStateException - if entries have been added or the JAR has been written prior to calling this methods.

setAttribute

public Jar setAttribute(String section,
                        String name,
                        String value)

setListAttribute

public Jar setListAttribute(String name,
                            List<String> values)

Sets an attribute in the main section of the manifest to a list. The list elements will be joined with a single whitespace character.

Parameters:

name - the attribute's name

values - the attribute's value

Returns:

this

Throws:

IllegalStateException - if entries have been added or the JAR has been written prior to calling this methods.

setListAttribute

public Jar setListAttribute(String section,
                            String name,
                            List<String> values)

Sets an attribute in a non-main section of the manifest to a list. The list elements will be joined with a single whitespace character.

Parameters:

section - the section's name

name - the attribute's name

values - the attribute's value

Returns:

this

Throws:

IllegalStateException - if entries have been added or the JAR has been written prior to calling this methods.

getAttribute

public String getAttribute(String name)

Returns an attribute's value from this JAR's manifest's main section.

Parameters:

name - the attribute's name

getAttribute

public String getAttribute(String section,
                           String name)

Returns an attribute's value from a non-main section of this JAR's manifest.

Parameters:

section - the manifest's section

name - the attribute's name

getListAttribute

public List<String> getListAttribute(String name)

Returns an attribute's list value from this JAR's manifest's main section. The attributes string value will be split on whitespace into the returned list. The returned list may be safely modified.

Parameters:

name - the attribute's name

getListAttribute

public List<String> getListAttribute(String section,
                                     String name)

Returns an attribute's list value from a non-main section of this JAR's manifest. The attributes string value will be split on whitespace into the returned list. The returned list may be safely modified.

Parameters:

section - the manifest's section

name - the attribute's name

addEntry

public Jar addEntry(String path,
                    InputStream is)
             throws IOException

Adds an entry to this JAR.

Parameters:

path - the entry's path within the JAR

is - the entry's content

Returns:

this

Throws:

IOException

addEntry

public Jar addEntry(Path path,
                    InputStream is)
             throws IOException

Adds an entry to this JAR.

Parameters:

path - the entry's path within the JAR

is - the entry's content

Returns:

this

Throws:

IOException

addEntry

public Jar addEntry(Path path,
                    Path file)
             throws IOException

Adds an entry to this JAR.

Parameters:

path - the entry's path within the JAR

file - the file to add as an entry

Returns:

this

Throws:

IOException

addEntry

public Jar addEntry(Path path,
                    String file)
             throws IOException

Adds an entry to this JAR.

Parameters:

path - the entry's path within the JAR

file - the path of the file to add as an entry

Returns:

this

Throws:

IOException

addEntry

public Jar addEntry(String path,
                    File file)
             throws IOException

Adds an entry to this JAR.

Parameters:

path - the entry's path within the JAR

file - the file to add as an entry

Returns:

this

Throws:

IOException

addEntry

public Jar addEntry(String path,
                    String file)
             throws IOException

Adds an entry to this JAR.

Parameters:

path - the entry's path within the JAR

file - the path of the file to add as an entry

Returns:

this

Throws:

IOException

write

public <T extends OutputStream> T write(T os)
                                 throws IOException

Writes this JAR to an output stream.

Throws:

IOException

write

public File write(File file)
           throws IOException

Writes this JAR to a file.

Throws:

IOException

write

public Path write(Path path)
           throws IOException

Writes this JAR to a file.

Throws:

IOException

write

public void write(String file)
           throws IOException

Writes this JAR to a file.

Throws:

IOException

toInputStream

public static InputStream toInputStream(String str,
                                        Charset charset)

Turns a String into an InputStream containing the string's encoded characters.

Parameters:

str - the string

charset - the Charset to use when encoding the string.

Returns:

an InputStream containing the string's encoded characters.