net.sf.clirr.event
Class ApiDifference

java.lang.Object
  net.sf.clirr.event.ApiDifference

public final class ApiDifference

extends java.lang.Object

Describes an API change.

Author:

Lars

Constructor Summary

ApiDifference(java.lang.String report, Severity severity, java.lang.String clazz, java.lang.String method, java.lang.String field)
Create a new API differnce representation.

Method Summary

boolean	equals(java.lang.Object o)
java.lang.String	getAffectedClass()
java.lang.String	getAffectedField()
java.lang.String	getAffectedMethod()
java.lang.String	getReport() Human readable api change description.
Severity	getSeverity() The Severity of the API difference.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ApiDifference

public ApiDifference(java.lang.String report,
                     Severity severity,
                     java.lang.String clazz,
                     java.lang.String method,
                     java.lang.String field)

Create a new API differnce representation.

Parameters:

report - a human readable string describing the change that was made.

severity - the severity in terms of binary API compatibility.

Method Detail

getSeverity

public Severity getSeverity()

The Severity of the API difference. ERROR means that clients will definately break, WARNING means that clients may break, depending on how they use the library. See the eclipse paper for further explanation.

Returns:

the severity of the API difference.

getReport

public java.lang.String getReport()

Human readable api change description.

Returns:

a human readable description of this API difference.

getAffectedClass

public java.lang.String getAffectedClass()

getAffectedMethod

public java.lang.String getAffectedMethod()

getAffectedField

public java.lang.String getAffectedField()

toString

public java.lang.String toString()

equals

public boolean equals(java.lang.Object o)

hashCode

public int hashCode()