View Javadoc

1   //////////////////////////////////////////////////////////////////////////////
2   // Clirr: compares two versions of a java library for binary compatibility
3   // Copyright (C) 2003 - 2005  Lars Kühne
4   //
5   // This library is free software; you can redistribute it and/or
6   // modify it under the terms of the GNU Lesser General Public
7   // License as published by the Free Software Foundation; either
8   // version 2.1 of the License, or (at your option) any later version.
9   //
10  // This library is distributed in the hope that it will be useful,
11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  // Lesser General Public License for more details.
14  //
15  // You should have received a copy of the GNU Lesser General Public
16  // License along with this library; if not, write to the Free Software
17  // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  //////////////////////////////////////////////////////////////////////////////
19  
20  package net.sf.clirr.core;
21  
22  /***
23   * Listener for API differences.
24   *
25   * @author lkuehne
26   */
27  public interface DiffListener
28  {
29      /***
30       * Called when the listener should start listening.
31       * This gives implementations a chance to write some header info.
32       */
33      void start();
34  
35      /***
36       * Called when an API difference has been detected.
37       * @param difference the difference that has been detected.
38       */
39      void reportDiff(ApiDifference difference);
40  
41      /***
42       * Called when the listener should stop listening.
43       * This gives implementations a chance to write footer info,
44       * close files, etc.
45       */
46      void stop();
47  }