Informing Eclipse API production and consumption

ABSTRACT

Application programming interfaces (APIs) inform application developers as to the functionality provided by a library and how to interact with it. APIs are a double-edged sword: if they do not permit the needed functionality to be accessed and adapted as needed, they are obstructing; if they permit all things to all people, they are complex, leading application developers to have difficulty understanding how to use them correctly. Thus, the developers of APIs have a delicate balance to strike between providing configurable functionality and simple interfaces. Inevitably, the wrong balance is sometimes chosen, as the actual usage is different from the expected usage; APIs need to evolve, or to be re-documented to account for this disparity. In this paper we propose a simple technique for quantitatively determining how existing APIs are used, and demonstrate its application to Eclipse. This technique would enable application developers to more easily understand how others have used the APIs and would allow API developers to more easily understand how their APIs are being used.

REFERENCES

• 1: Jan Bosch , Peter Molin , Michael Mattsson , PerOlof Bengtsson, Object-oriented framework-based software development: problems and experiences, ACM Computing Surveys (CSUR), v.32 n.1es, March 2000 [doi>10.1145/351936.351939]
• 2: Davide Brugali , Giuseppe Menga , Amund Aarsten, The framework life span, Communications of the ACM, v.40 n.10, p.65-68, Oct. 1997 [doi>10.1145/262793.262806]
• 3: Serge Demeyer , Theo Dirk Meijler , Oscar Nierstrasz , Patrick Steyaert, Design guidelines for “tailorable” frameworks, Communications of the ACM, v.40 n.10, p.60-64, Oct. 1997 [doi>10.1145/262793.262805]
• 4: J. des Rivières. Evolving Java-based APIs. http://wiki.eclipse.org/index.php/Evolving_Java-based_APIs, 14 February 2007. Revision 1.1.
• 5: Prem Devanbu , Ron Brachman , Peter G. Selfridge, LaSSIE: a knowledge-based software information system, Communications of the ACM, v.34 n.5, p.34-49, May 1991 [doi>10.1145/103167.103172]
• 6: Mohamed Fayad , Douglas C. Schmidt, Object-oriented application frameworks, Communications of the ACM, v.40 n.10, p.32-38, Oct. 1997 [doi>10.1145/262793.262798]
• 7: Gary Froehlich , H. James Hoover , Ling Liu , Paul Sorenson, Hooking into object-oriented application frameworks, Proceedings of the 19th international conference on Software engineering, p.491-501, May 17-23, 1997, Boston, Massachusetts, United States [doi>10.1145/253228.253432]
• 8: Reid Holmes , Robert J. Walker , Gail C. Murphy, Approximate Structural Context Matching: An Approach to Recommend Relevant Examples, IEEE Transactions on Software Engineering, v.32 n.12, p.952-970, December 2006 [doi>10.1109/TSE.2006.117]
• 9: Daqing Hou , H. James Hoover, Source-Level Linkage: Adding Semantic Information to C++ Fact-bases, Proceedings of the 22nd IEEE International Conference on Software Maintenance, p.448-457, September 24-27, 2006 [doi>10.1109/ICSM.2006.61]
• 10: Daqing Hou , H. James Hoover, Using SCL to Specify and Check Design Intent in Source Code, IEEE Transactions on Software Engineering, v.32 n.6, p.404-423, June 2006 [doi>10.1109/TSE.2006.60]
• 11: Ralph E. Johnson, Documenting frameworks using patterns, conference proceedings on Object-oriented programming systems, languages, and applications, p.63-76, October 18-22, 1992, Vancouver, British Columbia, Canada
• 12: R. E. Johnson and B. Foote. Designing reusable classes. Journal of Object-Oriented Programming, 1(5):22--35, 1988.
• 13: A. Mendelzon and J. Sametinger. Reverse engineering by visualizing and querying. Software: Concepts and Tools, 16:170--182, 1995.
• 14: Amir Michail, Code web: data mining library reuse patterns, Proceedings of the 23rd International Conference on Software Engineering, p.827-828, May 12-19, 2001, Toronto, Ontario, Canada
• 15: H. A. Müller , K. Klashinsky, Rigi-A system for programming-in-the-large, Proceedings of the 10th international conference on Software engineering, p.80-86, April 11-15, 1988, Singapore
• 16: Gail C. Murphy , David Notkin , Kevin J. Sullivan, Software Reflexion Models: Bridging the Gap between Design and Implementation, IEEE Transactions on Software Engineering, v.27 n.4, p.364-380, April 2001 [doi>10.1109/32.917525]
• 17: Martin P. Robillard , Wesley Coelho , Gail C. Murphy, How Effective Developers Investigate Source Code: An Exploratory Study, IEEE Transactions on Software Engineering, v.30 n.12, p.889-903, December 2004 [doi>10.1109/TSE.2004.101]
• 18: Chia-Hui Shih , Bill Anderson, A design/constraint model to capture design intent, Proceedings of the fourth ACM symposium on Solid modeling and applications, p.255-264, May 14-16, 1997, Atlanta, Georgia, United States [doi>10.1145/267734.267802]
• 19: M.-A. D. Storey , H. A. Muller, Manipulating and documenting software structures using SHriMP views, Proceedings of the International Conference on Software Maintenance, p.275, October 17-20, 1995
• 20: M.-A. D. Storey , K. Wong , H. A. Müller, How do program understanding tools affect how programmers understand programs?, Science of Computer Programming, v.36 n.2-3, p.183-207, March 2000 [doi>10.1016/S0167-6423(99)00036-2]
• 21: Kenny Wong , Scott R. Tilley , Hausi A. Müller , Margaret-Anne D. Storey, Structural Redocumentation: A Case Study, IEEE Software, v.12 n.1, p.46-54, January 1995 [doi>10.1109/52.363166]
• 22: Tao Xie , Jian Pei, MAPO: mining API usages from open source repositories, Proceedings of the 2006 international workshop on Mining software repositories, May 22-23, 2006, Shanghai, China [doi>10.1145/1137983.1137997]