org.myire.quill.jol

Class JolResult

java.lang.Object

org.myire.quill.jol.JolResult

public class JolResult
extends java.lang.Object

The result of a Jol analysis of a collection of class files. The result classes do not depend on the jol-core classes and can thus be used from code executing with a class path that doesn't have access to the jol-core classes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JolResult.ClassLayout Layout information for a class.
static class	JolResult.FieldLayout Layout information for a field.
static class	JolResult.PackageLayout A PackageLayout contains a collection of ClassLayout for the classes in a package.

Constructor Summary

Constructors

Constructor and Description
JolResult(java.lang.String pVersion, java.lang.String pDescription) Create a new JolResult.

Method Summary

Modifier and Type	Method and Description
void	add(JolResult.ClassLayout pClassLayout) Add a ClassLayout to this result.
java.lang.String	getDescription() Get the description of the analysis parameters used to produce this result.
long	getExternalAlignmentGapSize() Get the sum of all detected external alignment gap sizes in the analyzed classes.
long	getInternalAlignmentGapSize() Get the sum of all detected internal alignment gap sizes in the analyzed classes.
int	getNumPackages() Get the number of packages in this result.
java.lang.Iterable<JolResult.PackageLayout>	getPackages() Get an Iterable with the packages for which classes were analyzed.
java.lang.String	getVersion() Get the version of Jol used for the analysis.

Methods inherited from class java.lang.Object

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

Constructor Detail

JolResult

public JolResult(java.lang.String pVersion,
                 java.lang.String pDescription)

Create a new JolResult.

Parameters:

pVersion - The Jol version used for the analysis.

pDescription - A string describing the analysis parameters used to produce this result.

Throws:

java.lang.NullPointerException - if any of the parameters is null.

Method Detail

getVersion

public java.lang.String getVersion()

Get the version of Jol used for the analysis.

Returns:

The Jol version string.

getDescription

public java.lang.String getDescription()

Get the description of the analysis parameters used to produce this result.

Returns:

The analysis parameter description.

getNumPackages

public int getNumPackages()

Get the number of packages in this result.

Returns:

The number of packages.

getPackages

public java.lang.Iterable<JolResult.PackageLayout> getPackages()

Get an Iterable with the packages for which classes were analyzed. The packages will be sorted on package name in ascending alphabetical order.

Returns:

An Iterable of PackageLayout instances, possibly empty, never null.

getInternalAlignmentGapSize

public long getInternalAlignmentGapSize()

Get the sum of all detected internal alignment gap sizes in the analyzed classes.

Returns:

The total internal alignment gap size.

getExternalAlignmentGapSize

public long getExternalAlignmentGapSize()

Get the sum of all detected external alignment gap sizes in the analyzed classes.

Returns:

The total external alignment gap size.

add

public void add(JolResult.ClassLayout pClassLayout)

Add a ClassLayout to this result.

Parameters:

pClassLayout - The ClassLayout to add.

Throws:

java.lang.NullPointerException - if pClassLayout is null.