| java.lang.Object
 net.sf.clirr.core.ApiDifference
| ApiDifference | | final public class ApiDifference (Code) | | Describes an API change.
author:
Lars |
| Constructor Summary | |
| public | ApiDifference(Message message, Severity severity, String clazz, String method, String field, String[] args)
Invokes the two-severity-level version of this constructor. | | public | ApiDifference(Message message, Severity binarySeverity, Severity sourceSeverity, String clazz, String method, String field, String[] args)
Create a new API difference representation. |
| ApiDifference | | public ApiDifference(Message message, Severity binarySeverity, Severity sourceSeverity, String clazz, String method, String field, String[] args)(Code) | | Create a new API difference representation.
Parameters:
message - is the key of a human readable string describing thechange that was made.
Parameters:
binarySeverity - the severity in terms of binary compatibility,must be non-null.
Parameters:
sourceSeverity - the severity in terms of source code compatibility,must be non-null.
Parameters:
clazz - is the fully-qualified name of the class in which thechange occurred, must be non-null.
Parameters:
method - the method signature of the method that changed,null if no method was affected.
Parameters:
field - the field name where the change occured, nullif no field was affected.
Parameters:
args - is a set of additional change-specific strings which aremade available for the message description string to reference viathe standard {n} syntax. |
| getAffectedClass | | public String getAffectedClass()(Code) | | The fully qualified class name of the class that has changed.
fully qualified class name of the class that has changed. |
| getAffectedField | | public String getAffectedField()(Code) | | Field name of the field that has changed, if any.
field name or null if no field is affected. |
| getAffectedMethod | | public String getAffectedMethod()(Code) | | Method signature of the method that has changed, if any.
method signature or null if no method is affected. |
| getBinaryCompatibilitySeverity | | public Severity getBinaryCompatibilitySeverity()(Code) | | The Severity of the API difference in terms of binary compatibility.
ERROR means that clients will definitely break, WARNING means that
clients may break, depending on how they use the library.
See the eclipse paper for further explanation.
the severity of the API difference in terms of binary compatibility. |
| getMaximumSeverity | | public Severity getMaximumSeverity()(Code) | | Return the maximum of the binary and source compatibility severities.
|
| getMessage | | public Message getMessage()(Code) | | Return the message object (if any) associated with this difference.
Checks which support the "new" message API will provide ApiDifference
objects with non-null message objects.
|
| getReport | | public String getReport(MessageTranslator translator)(Code) | | Human readable api change description.
a human readable description of this API difference. |
| getSourceCompatibilitySeverity | | public Severity getSourceCompatibilitySeverity()(Code) | | The Severity of the API difference in terms of source compatibility.
Sometimes this is different than
ApiDifference.getBinaryCompatibilitySeveritybinary compatibility severity , for example adding a checked exception
to a method signature is binary compatible but not source compatible.
ERROR means that clients will definitely break, WARNING means that
clients may break, depending on how they use the library.
See the eclipse paper for further explanation.
the severity of the API difference in terms of source codecompatibility. |
| toString | | public String toString(MessageTranslator translator)(Code) | | Get a human-readable description of this object. Intended for use by
the unit tests.
|
|
|