A B C D E F G H I J L M N P R S T W X

A

AbstractDiffReporter - Class in net.sf.clirr.core.internal

AbstractDiffReporter(ApiDiffDispatcher) - Constructor for class net.sf.clirr.core.internal.AbstractDiffReporter

addApiClasses(PatternSet) - Method in class net.sf.clirr.ant.AntTask

addClass(String) - Method in class net.sf.clirr.core.ClassSelector

Matches the class with exactly this name, plus any of its inner classes.

addDiffListener(DiffListener) - Method in class net.sf.clirr.core.Checker

addFormatter(AntTask.Formatter) - Method in class net.sf.clirr.ant.AntTask

addMessage(Message) - Method in class net.sf.clirr.core.MessageManager

Add a message to the list of known messages.

addNewFiles(FileSet) - Method in class net.sf.clirr.ant.AntTask

addOrigFiles(FileSet) - Method in class net.sf.clirr.ant.AntTask

addPackage(String) - Method in class net.sf.clirr.core.ClassSelector

Matches any class which is in the named package.

addPackageTree(String) - Method in class net.sf.clirr.core.ClassSelector

Matches any class which is in the named package or any subpackage of it.

AntTask - Class in net.sf.clirr.ant

Implements the Clirr ant task.

AntTask() - Constructor for class net.sf.clirr.ant.AntTask

AntTask.Formatter - Class in net.sf.clirr.ant

Output formater.

AntTask.Formatter() - Constructor for class net.sf.clirr.ant.AntTask.Formatter

ApiDiffDispatcher - Interface in net.sf.clirr.core.internal

Distributes API differences to listeners.

ApiDifference - Class in net.sf.clirr.core

Describes an API change.

ApiDifference(Message, Severity, String, String, String, String[]) - Constructor for class net.sf.clirr.core.ApiDifference

Invokes the two-severity-level version of this constructor.

ApiDifference(Message, Severity, Severity, String, String, String, String[]) - Constructor for class net.sf.clirr.core.ApiDifference

Create a new API difference representation.

B

BcelJavaType - Class in net.sf.clirr.core.internal.bcel

BcelJavaType(Type, Repository) - Constructor for class net.sf.clirr.core.internal.bcel.BcelJavaType

BcelJavaType(JavaClass) - Constructor for class net.sf.clirr.core.internal.bcel.BcelJavaType

BcelTypeArrayBuilder - Class in net.sf.clirr.core.internal.bcel

C

check(JavaType, JavaType) - Method in class net.sf.clirr.core.internal.checks.ClassHierarchyCheck

check(JavaType, JavaType) - Method in class net.sf.clirr.core.internal.checks.ClassModifierCheck

check(JavaType, JavaType) - Method in class net.sf.clirr.core.internal.checks.ClassScopeCheck

check(JavaType, JavaType) - Method in class net.sf.clirr.core.internal.checks.FieldSetCheck

check(JavaType, JavaType) - Method in class net.sf.clirr.core.internal.checks.GenderChangeCheck

check(JavaType, JavaType) - Method in class net.sf.clirr.core.internal.checks.InterfaceSetCheck

check(JavaType, JavaType) - Method in class net.sf.clirr.core.internal.checks.MethodSetCheck

check(JavaType, JavaType) - Method in interface net.sf.clirr.core.internal.ClassChangeCheck

checkComplete(Collection) - Method in class net.sf.clirr.core.MessageTranslator

Verify that the resource bundle for the currently set locale has a translation string available for every message object in the provided collection.

Checker - Class in net.sf.clirr.core

This is the main class to be used by Clirr frontends, it implements the checking functionality of Clirr.

Checker() - Constructor for class net.sf.clirr.core.Checker

Creates a new Checker.

CheckerException - Exception in net.sf.clirr.core

An exception class representing a failure during checking of the specified jar files.

CheckerException(String) - Constructor for exception net.sf.clirr.core.CheckerException

CheckerException(String, Throwable) - Constructor for exception net.sf.clirr.core.CheckerException

checkUnique() - Method in class net.sf.clirr.core.MessageManager

Verify that the list of known messages contains no two objects with the same numeric message id.

ClassChangeCheck - Interface in net.sf.clirr.core.internal

ClassFilter - Interface in net.sf.clirr.core

A filter for Java classes.

ClassHierarchyCheck - Class in net.sf.clirr.core.internal.checks

Detects changes in the set of superclasses.

ClassHierarchyCheck(ApiDiffDispatcher) - Constructor for class net.sf.clirr.core.internal.checks.ClassHierarchyCheck

Create a new instance of this check.

ClassLoaderUtil - Class in net.sf.clirr.core.internal

Helper class for dealing with ClassLoaders.

ClassModifierCheck - Class in net.sf.clirr.core.internal.checks

Detects changes in class modifiers (abstract, final).

ClassModifierCheck(ApiDiffDispatcher) - Constructor for class net.sf.clirr.core.internal.checks.ClassModifierCheck

Create a new instance of this check.

ClassScopeCheck - Class in net.sf.clirr.core.internal.checks

Detects changes in class access declaration, for both "top-level" classes, and nested classes.

ClassScopeCheck(ApiDiffDispatcher, ScopeSelector) - Constructor for class net.sf.clirr.core.internal.checks.ClassScopeCheck

Create a new instance of this check.

ClassSelector - Class in net.sf.clirr.core

Given a JavaClass object, determines whether or not it is "selected", based on its class or package.

ClassSelector(ClassSelector.Mode) - Constructor for class net.sf.clirr.core.ClassSelector

Create a selector.

ClassSelector.Mode - Class in net.sf.clirr.core

Class for implementing an enumeration.

Clirr - Class in net.sf.clirr.cli

Commandline interface for generating a difference report or checking for binary compatibility between two versions of the same application.

Clirr() - Constructor for class net.sf.clirr.cli.Clirr

CoIterator - Class in net.sf.clirr.core.internal

This is an iterator that walks a pair of collections, returning matching pairs from the set.

CoIterator(Comparator, Collection, Collection) - Constructor for class net.sf.clirr.core.internal.CoIterator

Iterate over the two collections, using the provided comparator.

CoIterator(Comparator, Object[], Object[]) - Constructor for class net.sf.clirr.core.internal.CoIterator

Iterate over the objects in the two arrays, using the provided comparator.

compare(Object, Object) - Method in class net.sf.clirr.core.internal.NameComparator

compareTo(Object) - Method in class net.sf.clirr.core.Severity

createClassLoader(String[]) - Static method in class net.sf.clirr.core.internal.ClassLoaderUtil

createClassSet(File[], ClassLoader, ClassFilter) - Static method in class net.sf.clirr.core.internal.bcel.BcelTypeArrayBuilder

Creates a set of classes to check.

createNewClassPath() - Method in class net.sf.clirr.ant.AntTask

createOrigClassPath() - Method in class net.sf.clirr.ant.AntTask

D

DFLT_RESOURCE_NAME - Static variable in class net.sf.clirr.core.MessageTranslator

The default base name of the resource bundle from which message descriptions are read.

DiffListener - Interface in net.sf.clirr.core

Listener for API differences.

DiffListenerAdapter - Class in net.sf.clirr.core

Provides empty implementations for all methods in the DiffListener interface.

DiffListenerAdapter() - Constructor for class net.sf.clirr.core.DiffListenerAdapter

E

ERROR - Static variable in class net.sf.clirr.core.Severity

marks an api difference that is binary incompatible.

EventMessages - Class in net.sf.clirr.core

ResourceBundle that implements the default locale by delegating to the english bundle.

EventMessages() - Constructor for class net.sf.clirr.core.EventMessages

Deprecated. Typical user code never calls this directly but uses ResourceBundle.getBundle(java.lang.String) or one of it's variants instead.

ExceptionUtil - Class in net.sf.clirr.core.internal

A helper class to initialize the cause of an exception.

execute() - Method in class net.sf.clirr.ant.AntTask

F

Field - Interface in net.sf.clirr.core.spi

Describes a field of a class.

FieldSetCheck - Class in net.sf.clirr.core.internal.checks

Checks the fields of a class.

FieldSetCheck(ApiDiffDispatcher, ScopeSelector) - Constructor for class net.sf.clirr.core.internal.checks.FieldSetCheck

fireDiff(ApiDifference) - Method in class net.sf.clirr.core.Checker

fireDiff(ApiDifference) - Method in interface net.sf.clirr.core.internal.ApiDiffDispatcher

Called by checks to inform listeners that an API difference has been detected.

G

GenderChangeCheck - Class in net.sf.clirr.core.internal.checks

Detects gender changes (a class became an interface or vice versa).

GenderChangeCheck(ApiDiffDispatcher) - Constructor for class net.sf.clirr.core.internal.checks.GenderChangeCheck

Create a new instance of this check.

getAffectedClass() - Method in class net.sf.clirr.core.ApiDifference

The fully qualified class name of the class that has changed.

getAffectedField() - Method in class net.sf.clirr.core.ApiDifference

Field name of the field that has changed, if any.

getAffectedMethod() - Method in class net.sf.clirr.core.ApiDifference

Method signature of the method that has changed, if any.

getAllInterfaces() - Method in class net.sf.clirr.core.internal.bcel.BcelJavaType

getAllInterfaces() - Method in interface net.sf.clirr.core.spi.JavaType

Return the list of all interfaces this class implements.

getApiDiffDispatcher() - Method in class net.sf.clirr.core.internal.AbstractDiffReporter

getArgumentTypes() - Method in interface net.sf.clirr.core.spi.Method

getBinaryCompatibilitySeverity() - Method in class net.sf.clirr.core.ApiDifference

The Severity of the API difference in terms of binary compatibility.

getConstantValue() - Method in interface net.sf.clirr.core.spi.Field

Returns the constant value of this field.

getContainingClass() - Method in class net.sf.clirr.core.internal.bcel.BcelJavaType

getContainingClass() - Method in interface net.sf.clirr.core.spi.JavaType

The containing class if this is an inner class.

getDecl() - Method in class net.sf.clirr.core.spi.Scope

the Java visibility modifier.

getDeclaredScope() - Method in class net.sf.clirr.core.internal.bcel.BcelJavaType

getDeclaredScope() - Method in interface net.sf.clirr.core.spi.Scoped

The declared scope of this entity.

getDesc(Message) - Method in class net.sf.clirr.core.MessageTranslator

Given a Message object (containing a unique message id), look up that id in the appropriate resource bundle (properties file) for the set locale and return the text string associated with that message id.

getDesc() - Method in class net.sf.clirr.core.spi.Scope

getEffectiveScope() - Method in class net.sf.clirr.core.internal.bcel.BcelJavaType

getEffectiveScope() - Method in interface net.sf.clirr.core.spi.Scoped

The effective Scope of this entity.

getFields() - Method in class net.sf.clirr.core.internal.bcel.BcelJavaType

getFields() - Method in interface net.sf.clirr.core.spi.JavaType

All fields that are declared by this class.

getId() - Method in class net.sf.clirr.core.Message

getInnerClasses() - Method in class net.sf.clirr.core.internal.bcel.BcelJavaType

getInnerClasses() - Method in interface net.sf.clirr.core.spi.JavaType

getInstance() - Static method in class net.sf.clirr.core.MessageManager

Return the singleton instance of this class.

getKeys() - Method in class net.sf.clirr.core.EventMessages

getLeft() - Method in class net.sf.clirr.core.internal.CoIterator

Return an object from the "left" collection specified to this object's constructor.

getLocale() - Method in class net.sf.clirr.core.EventMessages

getMaximumSeverity() - Method in class net.sf.clirr.core.ApiDifference

Return the maximum of the binary and source compatibility severities.

getMessage() - Method in class net.sf.clirr.core.ApiDifference

Return the message object (if any) associated with this difference.

getMessages() - Method in class net.sf.clirr.core.MessageManager

Return the complete set of registered messages.

getMethods() - Method in class net.sf.clirr.core.internal.bcel.BcelJavaType

getMethods() - Method in interface net.sf.clirr.core.spi.JavaType

All methods that are declared by this class.

getName() - Method in class net.sf.clirr.core.internal.bcel.BcelJavaType

getName() - Method in interface net.sf.clirr.core.spi.JavaType

Type fully qualified class name.

getName() - Method in interface net.sf.clirr.core.spi.Named

Returns the name of this object.

getOutFile() - Method in class net.sf.clirr.ant.AntTask.Formatter

getReport(MessageTranslator) - Method in class net.sf.clirr.core.ApiDifference

Human readable api change description.

getReturnType() - Method in interface net.sf.clirr.core.spi.Method

getRight() - Method in class net.sf.clirr.core.internal.CoIterator

See getLeft.

getScope() - Method in class net.sf.clirr.core.ScopeSelector

Get the scope that this object is configured with.

getScopeSelector() - Method in class net.sf.clirr.core.Checker

getSeverity(JavaType, Severity) - Method in class net.sf.clirr.core.internal.AbstractDiffReporter

Determine whether the severity of the problem should be reduced to INFO because the specified class is package or private accessibility.

getSeverity(JavaType, Method, Severity) - Method in class net.sf.clirr.core.internal.AbstractDiffReporter

Determine whether the severity of the problem should be reduced to INFO because: the specified method is package or private accessibility, or the specified method is in a package or private class.

getSeverity(JavaType, Field, Severity) - Method in class net.sf.clirr.core.internal.AbstractDiffReporter

Determine whether the severity of the problem should be reduced to INFO because: the specified field is package or private accessibility, or the specified field is in a package or private class.

getSourceCompatibilitySeverity() - Method in class net.sf.clirr.core.ApiDifference

The Severity of the API difference in terms of source compatibility.

getSuperClasses() - Method in class net.sf.clirr.core.internal.bcel.BcelJavaType

getSuperClasses() - Method in interface net.sf.clirr.core.spi.JavaType

Return the superclasses of this class.

getType() - Method in class net.sf.clirr.ant.AntTask.Formatter

getType() - Method in interface net.sf.clirr.core.spi.Field

The type of this field.

H

handleGetObject(String) - Method in class net.sf.clirr.core.EventMessages

hasNext() - Method in class net.sf.clirr.core.internal.CoIterator

Indicates whether there are any more elements to be returned.

I

INFO - Static variable in class net.sf.clirr.core.Severity

marks an api difference that is binary compatible.

initCause(Throwable, Throwable) - Static method in class net.sf.clirr.core.internal.ExceptionUtil

Initializes the chained exception if possible.

InterfaceSetCheck - Class in net.sf.clirr.core.internal.checks

Detects changes in the set of interfaces implemented by a class.

InterfaceSetCheck(ApiDiffDispatcher) - Constructor for class net.sf.clirr.core.internal.checks.InterfaceSetCheck

Create a new instance of this check.

isAbstract() - Method in class net.sf.clirr.core.internal.bcel.BcelJavaType

isAbstract() - Method in interface net.sf.clirr.core.spi.JavaType

isAbstract() - Method in interface net.sf.clirr.core.spi.Method

isArray() - Method in class net.sf.clirr.core.internal.bcel.BcelJavaType

isArray() - Method in interface net.sf.clirr.core.spi.JavaType

isDeprecated() - Method in interface net.sf.clirr.core.spi.Field

Whether the field is deprecated.

isDeprecated() - Method in interface net.sf.clirr.core.spi.Method

isFinal() - Method in class net.sf.clirr.core.internal.bcel.BcelJavaType

isFinal() - Method in interface net.sf.clirr.core.spi.Field

Whether the field is declared as final.

isFinal() - Method in interface net.sf.clirr.core.spi.JavaType

isFinal() - Method in interface net.sf.clirr.core.spi.Method

isInterface() - Method in class net.sf.clirr.core.internal.bcel.BcelJavaType

isInterface() - Method in interface net.sf.clirr.core.spi.JavaType

isLessVisibleThan(Scope) - Method in class net.sf.clirr.core.spi.Scope

isMoreVisibleThan(Scope) - Method in class net.sf.clirr.core.spi.Scope

isPrimitive() - Method in class net.sf.clirr.core.internal.bcel.BcelJavaType

isPrimitive() - Method in interface net.sf.clirr.core.spi.JavaType

isSelected(JavaClass) - Method in interface net.sf.clirr.core.ClassFilter

Tests whether or not a given java class is considered when reporting the API differences between jar files.

isSelected(JavaClass) - Method in class net.sf.clirr.core.ClassSelector

Return true if this class is one selected by the criteria stored in this object.

isSelected(Scoped) - Method in class net.sf.clirr.core.ScopeSelector

Given a scoped object, return true if this object's scope is one of the values this object is configured to match.

isSelected(Scope) - Method in class net.sf.clirr.core.ScopeSelector

Return true if objects of the specified scope, or more visible, are selected by this selector.

isStatic() - Method in interface net.sf.clirr.core.spi.Field

Whether the field is declared as static.

isStatic() - Method in interface net.sf.clirr.core.spi.Method

J

JavaType - Interface in net.sf.clirr.core.spi

A Java Type (Object, Interface, primitive type or void).

L

log(Message, Severity, String, Method, Field, String[]) - Method in class net.sf.clirr.core.internal.AbstractDiffReporter

M

main(String[]) - Static method in class net.sf.clirr.cli.Clirr

Message - Class in net.sf.clirr.core

Class which manages API Difference messages, including expanding message codes into strings and descriptions.

Message(int) - Constructor for class net.sf.clirr.core.Message

This constructor is equivalent to new Message(id, true).

Message(int, boolean) - Constructor for class net.sf.clirr.core.Message

Create an instance of this object with the specified message id

MessageManager - Class in net.sf.clirr.core

Class which manages API Difference messages, including expanding message codes into strings and descriptions.

MessageTranslator - Class in net.sf.clirr.core

Class which is capable of translating a Message object into a localised string.

MessageTranslator() - Constructor for class net.sf.clirr.core.MessageTranslator

This is a singleton class; to get an instance of this class, use the getInstance method.

Method - Interface in net.sf.clirr.core.spi

Describes a Java method.

MethodSetCheck - Class in net.sf.clirr.core.internal.checks

Checks the methods of a class.

MethodSetCheck(ApiDiffDispatcher, ScopeSelector) - Constructor for class net.sf.clirr.core.internal.checks.MethodSetCheck

Instantiates the check.

MODE_IF - Static variable in class net.sf.clirr.core.ClassSelector

positive selection.

MODE_UNLESS - Static variable in class net.sf.clirr.core.ClassSelector

negative selection.

N

NameComparator - Class in net.sf.clirr.core.internal

Compares named entities by their name.

NameComparator() - Constructor for class net.sf.clirr.core.internal.NameComparator

Named - Interface in net.sf.clirr.core.spi

A named entity in the Java programming language.

net.sf.clirr.ant - package net.sf.clirr.ant

The Ant task implementation.

net.sf.clirr.cli - package net.sf.clirr.cli

Command line frontend for Clirr.

net.sf.clirr.core - package net.sf.clirr.core

Clirr throws events when it finds api changes.

net.sf.clirr.core.internal - package net.sf.clirr.core.internal

The framework that is used by the individual checks in the checks package.

net.sf.clirr.core.internal.bcel - package net.sf.clirr.core.internal.bcel

Apache's BCEL is currently used to read the compiled Java classes.

net.sf.clirr.core.internal.checks - package net.sf.clirr.core.internal.checks

The check modules that implement the funtionality of clirr.

net.sf.clirr.core.spi - package net.sf.clirr.core.spi

Service Provider Interface for letting Clirr know about Java types, methods, etc.

next() - Method in class net.sf.clirr.core.internal.CoIterator

Moves this iterator object to refer to the next "pair" of objects.

P

PACKAGE - Static variable in class net.sf.clirr.core.spi.Scope

Object representing package scoped objects.

PlainDiffListener - Class in net.sf.clirr.core

PlainDiffListener(String) - Constructor for class net.sf.clirr.core.PlainDiffListener

PRIVATE - Static variable in class net.sf.clirr.core.spi.Scope

Object representing private scoped objects.

PROTECTED - Static variable in class net.sf.clirr.core.spi.Scope

Object representing protected scoped objects.

PUBLIC - Static variable in class net.sf.clirr.core.spi.Scope

Object representing public scoped objects.

R

reportDiff(ApiDifference) - Method in interface net.sf.clirr.core.DiffListener

Called when an API difference has been detected.

reportDiff(ApiDifference) - Method in class net.sf.clirr.core.DiffListenerAdapter

Does nothing

reportDiff(ApiDifference) - Method in class net.sf.clirr.core.PlainDiffListener

reportDiff(ApiDifference) - Method in class net.sf.clirr.core.XmlDiffListener

reportDiffs(JavaType[], JavaType[]) - Method in class net.sf.clirr.core.Checker

Checks two sets of classes for api changes and reports them to the DiffListeners.

RESOURCE_NAME - Static variable in class net.sf.clirr.core.EventMessages

The base name of the resource bundle from which message descriptions are read.

S

Scope - Class in net.sf.clirr.core.spi

Enumeration type that represents an "accessibility" level for a java class, field or method.

Scoped - Interface in net.sf.clirr.core.spi

A Java source code entity like a type or a method that has the concept of a visibility scope.

ScopeSelector - Class in net.sf.clirr.core

Selects zero or more java scope values (public, protected, package, private).

ScopeSelector() - Constructor for class net.sf.clirr.core.ScopeSelector

Construct an instance which selects public and protected objects and ignores package and private objects.

ScopeSelector(Scope) - Constructor for class net.sf.clirr.core.ScopeSelector

Construct an instance which selects public and protected objects and ignores package and private objects.

setFailOnBinError(boolean) - Method in class net.sf.clirr.ant.AntTask

setFailOnBinWarning(boolean) - Method in class net.sf.clirr.ant.AntTask

setFailOnSrcError(boolean) - Method in class net.sf.clirr.ant.AntTask

setFailOnSrcWarning(boolean) - Method in class net.sf.clirr.ant.AntTask

setLocale(Locale) - Method in class net.sf.clirr.core.MessageTranslator

Define the local language etc.

setNewClassPath(Path) - Method in class net.sf.clirr.ant.AntTask

setOrigClassPath(Path) - Method in class net.sf.clirr.ant.AntTask

setOutFile(String) - Method in class net.sf.clirr.ant.AntTask.Formatter

setResourceName(String) - Method in class net.sf.clirr.core.MessageTranslator

Define the base name of the properties file that message translations are to be read from.

setScope(Scope) - Method in class net.sf.clirr.core.ScopeSelector

Specify which scope objects are of interest.

setType(String) - Method in class net.sf.clirr.ant.AntTask.Formatter

Severity - Class in net.sf.clirr.core

Enumeration type for severity of an Api difference.

start() - Method in interface net.sf.clirr.core.DiffListener

Called when the listener should start listening.

start() - Method in class net.sf.clirr.core.DiffListenerAdapter

Does nothing

start() - Method in class net.sf.clirr.core.XmlDiffListener

Writes an XML header and toplevel tag to the xml stream.

stop() - Method in interface net.sf.clirr.core.DiffListener

Called when the listener should stop listening.

stop() - Method in class net.sf.clirr.core.DiffListenerAdapter

Does nothing

T

toString() - Method in class net.sf.clirr.core.ApiDifference

toString(MessageTranslator) - Method in class net.sf.clirr.core.ApiDifference

Get a human-readable description of this object.

toString() - Method in class net.sf.clirr.core.internal.bcel.BcelJavaType

toString() - Method in class net.sf.clirr.core.Message

toString() - Method in class net.sf.clirr.core.ScopeSelector

Return a string which indicates what scopes this object will consider to be selected (ie relevant).

toString() - Method in class net.sf.clirr.core.Severity

W

WARNING - Static variable in class net.sf.clirr.core.Severity

marks an api difference that might be binary incompatible.

writeFooter() - Method in class net.sf.clirr.core.XmlDiffListener

Closes the toplevel tag that was opened in start.

X

XmlDiffListener - Class in net.sf.clirr.core

A DiffListener that reports any detected difference to an XML file.

XmlDiffListener(String) - Constructor for class net.sf.clirr.core.XmlDiffListener

A B C D E F G H I J L M N P R S T W X