com.reportmill.base

Class RMJarFile

java.lang.Object

com.reportmill.base.RMJarFile

public class RMJarFile
extends java.lang.Object

A class to represent a Jar file or class directory.

Constructor Summary

Constructors

Constructor and Description
RMJarFile(java.lang.ClassLoader aClassLoader, java.lang.String aKnownResourcePath) Creates a new RMJarFile from given class, class loader, known resource and package names.
RMJarFile(java.lang.Class aClass, java.lang.String aRootPath) Creates a new RMJarFile from given class and class loader (optional).
RMJarFile(java.io.File aFile) Creates a new RMJarFile with given file.
RMJarFile(java.lang.String aPath) Creates a new RMJarFile with given String path.
RMJarFile(java.net.URL aURL) Creates a new RMJarFile.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object anObj) Standard equals implementation.
java.util.List<RMJarFileEntry>	getClasses() Returns a list of classes.
java.util.List<RMJarFileEntry>	getDirectories(java.lang.String aPrefix) Returns a list of directories with given prefix.
RMJarFileEntry	getDirectory(java.lang.String aPath) Returns a directory for given path.
java.util.List<RMJarFileEntry>	getEntries() Gets Entries for this RMJarFile.
java.util.List<RMJarFileEntry>	getEntries(java.lang.String aType) Returns a list of entries of a given type.
java.lang.String[]	getExcludePaths() Sets the paths to explicitly exclude (excluding all else).
java.io.File	getFile() Returns the file.
java.lang.String[]	getIncludePaths() Sets the paths to explicitly include (excluding all else).
RMJarFileEntry	getPackage(java.lang.String aName) Returns a directory entry for a given package name/path.
java.util.List<RMJarFileEntry>	getPackages(java.lang.String aPrefix) Returns a list of packages with given package name/path prefix.
static RMJarFile	getReportMillJar() Returns the shared reportmill jar file.
RMJarFileEntry	getRootEntry() Returns the root entry.
static RMJarFile	getSystemJavaJar() Returns the shared system Java jar file.
java.net.URL	getURL() Returns the URL.
void	setExcludePaths(java.lang.String... thePaths) Sets the paths to explicitly exclude (excluding all else).
void	setIncludePackageNames(java.lang.String[] thePackageNames) Sets packages of interest.
void	setIncludePaths(java.lang.String... thePaths) Sets the paths to explicitly include (excluding all else).
java.lang.String	toString() Standard toString implementation.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RMJarFile

public RMJarFile(java.lang.Class aClass,
         java.lang.String aRootPath)

Creates a new RMJarFile from given class and class loader (optional).

RMJarFile

public RMJarFile(java.lang.ClassLoader aClassLoader,
         java.lang.String aKnownResourcePath)

Creates a new RMJarFile from given class, class loader, known resource and package names.

RMJarFile

public RMJarFile(java.net.URL aURL)

Creates a new RMJarFile.

RMJarFile

public RMJarFile(java.io.File aFile)

Creates a new RMJarFile with given file.

RMJarFile

public RMJarFile(java.lang.String aPath)

Creates a new RMJarFile with given String path.

Method Detail

getFile

public java.io.File getFile()

Returns the file.

getURL

public java.net.URL getURL()

Returns the URL.

getIncludePaths

public java.lang.String[] getIncludePaths()

Sets the paths to explicitly include (excluding all else).

setIncludePaths

public void setIncludePaths(java.lang.String... thePaths)

Sets the paths to explicitly include (excluding all else).

getExcludePaths

public java.lang.String[] getExcludePaths()

Sets the paths to explicitly exclude (excluding all else).

setExcludePaths

public void setExcludePaths(java.lang.String... thePaths)

Sets the paths to explicitly exclude (excluding all else).

setIncludePackageNames

public void setIncludePackageNames(java.lang.String[] thePackageNames)

Sets packages of interest.

getRootEntry

public RMJarFileEntry getRootEntry()

Returns the root entry.

getEntries

public java.util.List<RMJarFileEntry> getEntries()

Gets Entries for this RMJarFile.

getEntries

public java.util.List<RMJarFileEntry> getEntries(java.lang.String aType)

Returns a list of entries of a given type.

getClasses

public java.util.List<RMJarFileEntry> getClasses()

Returns a list of classes.

getDirectory

public RMJarFileEntry getDirectory(java.lang.String aPath)

Returns a directory for given path.

getDirectories

public java.util.List<RMJarFileEntry> getDirectories(java.lang.String aPrefix)

Returns a list of directories with given prefix.

getPackage

public RMJarFileEntry getPackage(java.lang.String aName)

Returns a directory entry for a given package name/path.

getPackages

public java.util.List<RMJarFileEntry> getPackages(java.lang.String aPrefix)

Returns a list of packages with given package name/path prefix.

equals

public boolean equals(java.lang.Object anObj)

Standard equals implementation.

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Standard toString implementation.

Overrides:

toString in class java.lang.Object

getReportMillJar

public static RMJarFile getReportMillJar()

Returns the shared reportmill jar file.

getSystemJavaJar

public static RMJarFile getSystemJavaJar()

Returns the shared system Java jar file.