Skip Headers
SigTest User's Guide
Version 2.2
E19036-01
Index
Next
Contents
List of Examples
List of Figures
List of Tables
Title and Copyright Information
Preface
Documentation Accessibility
Who Should Use This Guide
Before You Read This Guide
How This Guide Is Organized
Related Documentation
Typographic Conventions
1
Introduction
1.1
Global Functionality
1.1.1
Option File
1.1.1.1
Option File Format
1.1.2
The -version Option
Part I Signature Test Tool
2
Introduction to Signature Test Tool
2.1
Signature Test Basics
2.2
What is Tested
2.2.1
Mutual Binary Compatibility Check
2.2.2
Mutual Source Compatibility Check
2.2.3
Migration Binary and Source Code Check
2.2.4
Class and Class Member Attributes Checked
2.3
Source and Binary Compatibility Modes
2.4
Using Custom Signature Loaders
3
Using the Signature Test Tool
3.1
Signature Test Tool Basics
3.1.1
Reflection and Static Run Modes
3.1.2
Constant Checking in Differing Run Modes
3.1.3
Generics Checking in Binary Mode
3.1.4
CLASSPATH
and
-classpath
Settings
3.1.4.1
Bootstrap and Extension Classes
3.2
Signature File
Merge
Rules
3.2.1
JSR 68-Based Merge
3.3
Setup
Command
3.3.1
Command Description
3.3.2
Case Sensitivity of Option Arguments
3.3.3
Signature File Formats
3.3.4
Signature File Contents
3.3.4.1
Signature File Header
3.3.4.2
Signature File Body
3.4
SignatureTest
Command
3.4.1
Command Description
3.4.2
Using Update Files
3.4.3
Report Formats
3.4.3.1
Sorted Report
3.4.3.2
Unsorted Report
3.4.3.3
Human-Readable Report
3.5
SetupAndTest
Command
3.5.1
Command Description
3.6
Merge
Command
3.6.1
Command Description
Part II API Coverage Tool
4
Introduction to API Coverage Tool
4.1
Static API Coverage Analysis
4.1.1
Major Source of Error
4.1.2
Advantages of Static Coverage Analysis
4.2
How It Works
4.2.1
Level of Accuracy During Analysis
4.2.2
Coverage Analysis Modes
4.2.3
Filtering Coverage By Marking Up Signature Files
4.2.3.1
Filtering Markup Format
5
Using the API Coverage Tool
5.1
Running API Coverage Tool
5.1.1
Special Report File
5.1.2
Exclude List
Part III API Check Tool
6
Introduction API Check Tool
6.1
The API Check Tool
7
Using the API Check Tool
7.1
API Check Tool Verification Scope
7.2
Running API Check Tool
Part IV Appendix
A
Signature Test Tool Quick Start Examples
A.1
Example Programs
A.2
Example 1: Compare Two Different Implementations of the Same API
A.2.1
Using the
Setup
and
SignatureTest
Commands
A.2.2
Using the
SetupAndTest
Command
A.3
Example 2: Merge Two Signature Files
A.3.1
Running Merge Example
A.3.2
Example Result Files
B
API Coverage Tool Quick Start Examples
B.1
Example Procedures
B.1.1
Set Up the API Coverage Tool Ant Build Script
B.1.2
Build API Coverage Tool Examples
B.1.3
Run the Example Test Suite
B.1.4
Generate a Signature File for the Tested API
B.1.5
Use the API Coverage Tool to Calculate Test Coverage
B.1.6
Worst Case Mode
B.1.7
Real World Mode
B.1.8
Real World Mode Without Fields and Enum Constants
C
API Migration Compatibility Rules (Signature Test)
C.1
The Compatibility Rules
C.1.1
General Rules
C.1.2
Interfaces and Annotation Types
C.1.3
Interfaces and Class Methods
C.1.4
Interfaces and Class Fields
C.1.5
Classes
C.2
Comments and Clarifications
C.2.1
Rule 1.1
C.2.2
Rule 1.4
C.2.3
Rule 2.3
C.2.4
Rules 2.5, 2.6
C.2.5
Rule 3.6
C.2.6
Rule 4.2
C.2.7
Rule 5.1
C.2.8
Rule 5.3
C.2.9
Rule 5.7.2
D
Merge Command Operative Principles
D.1
Merge
Command Operative Principles
D.1.1
Element Handling by
Merge
E
Using the SigTest Tools With Ant
E.1
Using the Setup Command From an Ant Script
E.2
Using the SignatureTest Command From an Ant Script
E.3
Using the Merge Command From an Ant Script
E.4
Using APICheck From an Ant Script
F
Using the SigTest Tools With Apache Maven
F.1
Goal Overview
F.2
Goal Descriptions
F.2.1
sigtest-plugin:setup
F.2.2
sigtest-plugin:test
F.2.3
sigtest-plugin:merge
F.2.4
apicover-plugin:apicover
Index
