Package io.joshworks.snappy.loader.archive

Class Archive

java.lang.Object

io.joshworks.snappy.loader.archive.Archive

Direct Known Subclasses:

ExplodedArchive, FilteredArchive, JarFileArchive

public abstract class Archive
extends java.lang.Object

An archive that can be launched by the Launcher.

Author:

Phillip Webb

See Also:

JarFileArchive

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Archive.Entry	Represents a single entry in the archive.
static interface	Archive.EntryFilter	Strategy interface to filter Entries.
static interface	Archive.EntryRenameFilter	Strategy interface to filter or rename Entries.

Constructor Summary

Constructors

Constructor	Description
Archive()

Method Summary

Modifier and Type	Method	Description
abstract java.util.Collection<Archive.Entry>	getEntries()	Returns all entries from the archive.
abstract Archive	getFilteredArchive(Archive.EntryRenameFilter filter)	Returns a filtered version of the archive.
java.lang.String	getMainClass()	Obtain the main class that should be used to launch the application.
abstract java.util.jar.Manifest	getManifest()	Returns the manifest of the archive.
abstract java.util.List<Archive>	getNestedArchives(Archive.EntryFilter filter)	Returns nested Archives for entries that match the specified filter.
abstract java.net.URL	getUrl()	Returns a URL that can be used to load the archive.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Archive

public Archive()

Method Detail

getUrl

public abstract java.net.URL getUrl()
                             throws java.net.MalformedURLException

Returns a URL that can be used to load the archive.

Returns:

the archive URL

Throws:

java.net.MalformedURLException - if the URL is malformed

getMainClass

public java.lang.String getMainClass()
                              throws java.lang.Exception

Obtain the main class that should be used to launch the application. By default this method uses a Start-Class manifest entry.

Returns:

the main class

Throws:

java.lang.Exception - if the main class cannot be obtained

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getManifest

public abstract java.util.jar.Manifest getManifest()
                                            throws java.io.IOException

Returns the manifest of the archive.

Returns:

the manifest

Throws:

java.io.IOException - if the manifest cannot be read

getEntries

public abstract java.util.Collection<Archive.Entry> getEntries()

Returns all entries from the archive.

Returns:

the archive entries

getNestedArchives

public abstract java.util.List<Archive> getNestedArchives(Archive.EntryFilter filter)
                                                   throws java.io.IOException

Returns nested Archives for entries that match the specified filter.

Parameters:

filter - the filter used to limit entries

Returns:

nested archives

Throws:

java.io.IOException - if nested archives cannot be read

getFilteredArchive

public abstract Archive getFilteredArchive(Archive.EntryRenameFilter filter)
                                    throws java.io.IOException

Returns a filtered version of the archive.

Parameters:

filter - the filter to apply

Returns:

a filter archive

Throws:

java.io.IOException - if the archive cannot be read