Package aQute.bnd.differ

Class Baseline

java.lang.Object

aQute.bnd.differ.Baseline

public class Baseline
extends java.lang.Object

This class maintains

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Baseline.BundleInfo
static class	Baseline.Info

Field Summary

Fields

Modifier and Type	Field	Description
(package private) Baseline.BundleInfo	binfo
(package private) Reporter	bnd
(package private) java.lang.String	bsn
(package private) Diff	diff
(package private) Differ	differ
(package private) java.util.Set<Baseline.Info>	infos
private static org.slf4j.Logger	logger
(package private) Version	newerVersion
(package private) Version	olderVersion
(package private) java.lang.String	releaseRepository
(package private) Version	suggestedVersion

Constructor Summary

Constructors

Constructor	Description
Baseline(Reporter bnd, Differ differ)

Method Summary

Modifier and Type	Method	Description
java.util.Set<Baseline.Info>	baseline(Jar newer, Jar older, Instructions packageFilters)	This method compares a jar to a baseline jar and returns version suggestions if the baseline does not agree with the newer jar.
java.util.Set<Baseline.Info>	baseline(Tree n, Parameters nExports, Tree o, Parameters oExports, Instructions packageFilters)
private Version	bump(Delta delta, Version last, int offset, int base)
private Version	bumpBundle(Delta delta, Version last, int offset, int base)
java.lang.String	getBsn()
private java.lang.String	getBsn(Tree top)
Baseline.BundleInfo	getBundleInfo()
Diff	getDiff()	Gets the generated diff
private Parameters	getExports(Jar jar)
Version	getNewerVersion()
Version	getOlderVersion()
java.util.Set<Baseline.Info>	getPackageInfos()
java.lang.String	getReleaseRepository()
private java.lang.String	getRootCauses(Diff apiDiff)
private void	getRootCauses(java.util.Formatter f, Diff diff, java.lang.String path)
Version	getSuggestedVersion()
private Version	getVersion(Tree top)
private Version	getVersion(java.util.Map<java.lang.String,java.lang.String> map)
private boolean	mismatch(Version older, Version newer)	"Major version zero (0.y.z) is for initial development.
void	setReleaseRepository(java.lang.String releaseRepository)
void	setSuggestedVersion(Version suggestedVersion)

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final org.slf4j.Logger logger

differ

final Differ differ

bnd

final Reporter bnd

binfo

final Baseline.BundleInfo binfo

diff

Diff diff

infos

java.util.Set<Baseline.Info> infos

bsn

java.lang.String bsn

newerVersion

Version newerVersion

olderVersion

Version olderVersion

suggestedVersion

Version suggestedVersion

releaseRepository

java.lang.String releaseRepository

Constructor Detail

Baseline

public Baseline(Reporter bnd,
                Differ differ)
         throws java.io.IOException

Throws:

java.io.IOException

Method Detail

baseline

public java.util.Set<Baseline.Info> baseline(Jar newer,
                                             Jar older,
                                             Instructions packageFilters)
                                      throws java.lang.Exception

This method compares a jar to a baseline jar and returns version suggestions if the baseline does not agree with the newer jar. The returned set contains all the exported packages.

Parameters:

newer -

older -

Returns:

null if ok, otherwise a set of suggested versions for all packages (also the ones that were ok).

Throws:

java.lang.Exception

baseline

public java.util.Set<Baseline.Info> baseline(Tree n,
                                             Parameters nExports,
                                             Tree o,
                                             Parameters oExports,
                                             Instructions packageFilters)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

mismatch

private boolean mismatch(Version older,
                         Version newer)

"Major version zero (0.y.z) is for initial development. Anything may change at any time. The public API should not be considered stable."

See Also:

SemVer

getRootCauses

private java.lang.String getRootCauses(Diff apiDiff)

getRootCauses

private void getRootCauses(java.util.Formatter f,
                           Diff diff,
                           java.lang.String path)

getDiff

public Diff getDiff()

Gets the generated diff

Returns:

the diff

getPackageInfos

public java.util.Set<Baseline.Info> getPackageInfos()

getBsn

public java.lang.String getBsn()

getSuggestedVersion

public Version getSuggestedVersion()

setSuggestedVersion

public void setSuggestedVersion(Version suggestedVersion)

getNewerVersion

public Version getNewerVersion()

getOlderVersion

public Version getOlderVersion()

getReleaseRepository

public java.lang.String getReleaseRepository()

setReleaseRepository

public void setReleaseRepository(java.lang.String releaseRepository)

bump

private Version bump(Delta delta,
                     Version last,
                     int offset,
                     int base)

getVersion

private Version getVersion(java.util.Map<java.lang.String,java.lang.String> map)

getExports

private Parameters getExports(Jar jar)
                       throws java.lang.Exception

Throws:

java.lang.Exception

getVersion

private Version getVersion(Tree top)

getBsn

private java.lang.String getBsn(Tree top)

bumpBundle

private Version bumpBundle(Delta delta,
                           Version last,
                           int offset,
                           int base)

getBundleInfo

public Baseline.BundleInfo getBundleInfo()