1 /*
2 * org.osjava.jardiff.DiffCriteria
3 *
4 * $Id: IOThread.java 1952 2005-08-28 18:03:41Z cybertiger $
5 * $URL: https://svn.osjava.org/svn/osjava/trunk/osjava-nio/src/java/org/osjava/nio/IOThread.java $
6 * $Rev: 1952 $
7 * $Date: 2005-08-28 18:03:41 +0000 (Sun, 28 Aug 2005) $
8 * $Author: cybertiger $
9 *
10 * Copyright (c) 2005, Antony Riley
11 * All rights reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions are met:
15 *
16 * + Redistributions of source code must retain the above copyright notice,
17 * this list of conditions and the following disclaimer.
18 *
19 * + Redistributions in binary form must reproduce the above copyright notice,
20 * this list of conditions and the following disclaimer in the documentation
21 * and/or other materials provided with the distribution.
22 *
23 * + Neither the name JarDiff nor the names of its contributors may
24 * be used to endorse or promote products derived from this software without
25 * specific prior written permission.
26 *
27 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
28 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
31 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37 * POSSIBILITY OF SUCH DAMAGE.
38 */
39 package org.osjava.jardiff;
40
41 /***
42 * An interface for choosing which API differences are interesting.
43 *
44 * @author <a href="mailto:antony@cyberiantiger.org">Antony Riley</a>
45 */
46 public interface DiffCriteria
47 {
48 /***
49 * Check if the class described by classinfo is interesting.
50 *
51 * @return true if classinfo is interesting, false otherwise.
52 */
53 public boolean validClass(ClassInfo classinfo);
54
55 /***
56 * Check if the method described by methodinfo is interesting.
57 *
58 * @return true if methodinfo is interesting, false otherwise.
59 */
60 public boolean validMethod(MethodInfo methodinfo);
61
62 /***
63 * Check if the method described by fieldinfo is interesting.
64 *
65 * @return true if fieldinfo is interesting, false otherwise.
66 */
67 public boolean validField(FieldInfo fieldinfo);
68
69 /***
70 * Check if the differences between the class described by infoA and
71 * the class described by infoB are interesting.
72 *
73 * @return true if the changes are interesting, false otherwise.
74 */
75 public boolean differs(ClassInfo infoA, ClassInfo infoB);
76
77 /***
78 * Check if the differences between the method described by infoA and
79 * the method described by infoB are interesting.
80 *
81 * @return true if the changes are interesting, false otherwise.
82 */
83 public boolean differs(MethodInfo methodinfo, MethodInfo methodinfo_1_);
84
85 /***
86 * Check if the differences between the field described by infoA and the
87 * field described by infoB are interesting.
88 *
89 * @return true if the changes are interesting, false otherwise.
90 */
91 public boolean differs(FieldInfo fieldinfo, FieldInfo fieldinfo_2_);
92 }