Refactoring support for class library migration

ABSTRACT

As object-oriented class libraries evolve, classes are occasionally deprecated in favor of others with roughly the same functionality. In Java's standard libraries, for example, class Hashtable has been superseded by HashMap, and Iterator is now preferred over Enumeration. Migrating client applications to use the new idioms is often desirable, but making the required changes to declarations and allocation sites can be quite labor-intensive. Moreover, migration becomes complicated---and sometimes impossible---if an application interacts with external components, if a legacy class is not completely equivalent to its replacement, or if multiple interdependent classes must be migrated simultaneously. We present an approach in which mappings between legacy classes and their replacements are specified by the programmer. Then, an analysis based on type constraints determines where declarations and allocation sites can be updated. The method was implemented in Eclipse, and evaluated on a number of Java applications. On average, our tool could migrate more than 90% of the references to legacy classes.

REFERENCES

• 1: Jonathan Aldrich , Craig Chambers , Emin Gün Sirer , Susan J. Eggers, Static Analyses for Eliminating Unnecessary Synchronization from Java Programs, Proceedings of the 6th International Symposium on Static Analysis, p.19-38, September 22-24, 1999
• 2: Bäumer, D., Gamma, E., and Kieżun, A. Integrating refactoring support into a Java development tool. In OOPSLA'01 Companion (October 2001).
• 3: Kent Beck , Cynthia Andres, Extreme Programming Explained: Embrace Change (2nd Edition), Addison-Wesley Professional, 2004
• 4: Bracha, G., Cohen, N., Kemper, C., Odersky, M., Stoutamire, D., Thorup, K., and Wadler, P. Adding generics to the Java programming language: Public draft specification, version 2.0. Tech. rep., Java Community Process JSR-000014, June 23 2003.
• 5: Patrick Chan , Rosanna Lee, The Java Class Libraries Poster, Addison-Wesley Professional, 2002
• 6: Jong-Deok Choi , Manish Gupta , Mauricio Serrano , Vugranam C. Sreedhar , Sam Midkiff, Escape analysis for Java, Proceedings of the 14th ACM SIGPLAN conference on Object-oriented programming, systems, languages, and applications, p.1-19, November 01-05, 1999, Denver, Colorado, United States
• 7: Jeffrey Dean , David Grove , Craig Chambers, Optimization of Object-Oriented Programs Using Static Class Hierarchy Analysis, Proceedings of the 9th European Conference on Object-Oriented Programming, p.77-101, August 07-11, 1995
• 8: Dig, D., and Johnson, R. The role of refactorings in API evolution. Tech. Rep. UIUCDCS-R-2005-2555, University of Illinois at Urbana-Champaign, 2005.
• 9: Misha Dmitriev, The First Experience of Class Evolution Support in PJama, Proceedings of the 8th International Workshop on Persistent Object Systems (POS8) and Proceedings of the 3rd International Workshop on Persistence and Java (PJW3): Advances in Persistent Object Systems, p.279-296, January 1999
• 10: Mikhail Dmitriev, Language-specific make technology for the Java programming language, Proceedings of the 17th ACM SIGPLAN conference on Object-oriented programming, systems, languages, and applications, November 04-08, 2002, Seattle, Washington, USA
• 11: Alan Donovan , Adam Kiežun , Matthew S. Tschantz , Michael D. Ernst, Converting java programs to use generic libraries, Proceedings of the 19th annual ACM SIGPLAN conference on Object-oriented programming, systems, languages, and applications, October 24-28, 2004, Vancouver, BC, Canada
• 12: Peter Harry Eidorff , Fritz Henglein , Christian Mossin , Henning Niss , Morten Heine Sørensen , Mads Tofte, AnnoDomini: from type theory to Year 2000 conversion tool, Proceedings of the 26th ACM SIGPLAN-SIGACT symposium on Principles of programming languages, p.1-14, January 20-22, 1999, San Antonio, Texas, United States [doi>10.1145/292540.292543]
• 13: Refactoring: improving the design of existing code, Addison-Wesley Longman Publishing Co., Inc., Boston, MA, 1999
• 14: Fuhrer, R., Tip, F., Kiezun, A., Dolby, J., and Keller, M. Efficiently refactoring Java applications to use generic libraries. In Proc. ECOOP'05 (Glasgow, Scotland, 2005). To appear.
• 15: Erich Gamma , Richard Helm , Ralph Johnson , John Vlissides, Design patterns: elements of reusable object-oriented software, Addison-Wesley Longman Publishing Co., Inc., Boston, MA, 1995
• 16: William G. Griswold, Program restructuring as an aid to software maintenance, University of Washington, Seattle, WA, 1992
• 17: William G. Griswold , David Notkin, Automated assistance for program restructuring, ACM Transactions on Software Engineering and Methodology (TOSEM), v.2 n.3, p.228-269, July 1993 [doi>10.1145/152388.152389]
• 18: Johannes Henkel , Amer Diwan, CatchUp!: capturing and replaying refactorings to support API evolution, Proceedings of the 27th international conference on Software engineering, May 15-21, 2005, St. Louis, MO, USA [doi>10.1145/1062455.1062512]
• 19: Michael Hind , Anthony Pioli, Evaluating the effectiveness of pointer alias analyses, Science of Computer Programming, v.39 n.1, p.31-55, Jan. 2001 [doi>10.1016/S0167-6423(00)00014-9]
• 20: Joshua Kerievsky, Refactoring to Patterns, Pearson Higher Education, 2004
• 21: K. Kontogiannis , J. Martin , K. Wong , R. Gregory , H. Müller , J. Mylopoulos, Code migration through transformations: an experience report, Proceedings of the 1998 conference of the Centre for Advanced Studies on Collaborative research, p.13, November 30-December 03, 1998, Toronto, Ontario, Canada
• 22: Tom Mens , Tom Tourwé, A Survey of Software Refactoring, IEEE Transactions on Software Engineering, v.30 n.2, p.126-139, February 2004 [doi>10.1109/TSE.2004.1265817]
• 23: William F. Opdyke, Refactoring object-oriented frameworks, University of Illinois at Urbana-Champaign, Champaign, IL, 1992
• 24: William F. Opdyke , Ralph E. Johnson, Creating abstract superclasses by refactoring, Proceedings of the 1993 ACM conference on Computer science, p.66-73, February 16-18, 1993, Indianapolis, Indiana, United States [doi>10.1145/170791.170804]
• 25: Jens Palsberg , Michael I. Schwartzbach, Object-oriented type systems, John Wiley and Sons Ltd., Chichester, UK, 1994
• 26: Don Roberts , John Brant , Ralph Johnson, A refactoring tool for Smalltalk, Theory and Practice of Object Systems, v.3 n.4, p.253-263, 1997 [doi>10.1002/(SICI)1096-9942(1997)3:4<253::AID-TAPO3>3.3.CO;2-I]
• 27: Erik Ruf, Effective synchronization removal for Java, Proceedings of the ACM SIGPLAN 2000 conference on Programming language design and implementation, p.208-218, June 18-21, 2000, Vancouver, British Columbia, Canada
• 28: Ryder, B. G. Dimensions of precision in reference analysis of object-oriented programming languages. In Proc. CC 2003 (Warsaw, Poland, April 2003), pp. 126--137.
• 29: Olin Grigsby Shivers, Control-flow analysis of higher-order languages of taming lambda, Carnegie Mellon University, Pittsburgh, PA, 1991
• 30: Sutter, B. D., Tip, F., and Dolby, J. Customization of Java library classes using type constraints and profile information. In Proc. ECOOP'04 (Oslo, Norway, June 2004), pp. 585--609.
• 31: Frank Tip , Adam Kiezun , Dirk Bäumer, Refactoring for generalization using type constraints, Proceedings of the 18th annual ACM SIGPLAN conference on Object-oriented programing, systems, languages, and applications, October 26-30, 2003, Anaheim, California, USA
• 32: Frank Tip , Peter F. Sweeney , Chris Laffra , Aldo Eisma , David Streeter, Practical extraction techniques for Java, ACM Transactions on Programming Languages and Systems (TOPLAS), v.24 n.6, p.625-666, November 2002 [doi>10.1145/586088.586090]
• 33: Daniel von Dincklage , Amer Diwan, Converting Java classes to use generics, Proceedings of the 19th annual ACM SIGPLAN conference on Object-oriented programming, systems, languages, and applications, October 24-28, 2004, Vancouver, BC, Canada

INDEX TERMS

Primary Classification:
  D. Software
  D.2 SOFTWARE ENGINEERING
      D.2.7 Distribution, Maintenance, and Enhancement
          Subjects: Restructuring, reverse engineering, and reengineering

General Terms:
Design, Languages, Theory