Update of /cvsroot/clirr/clirr/core/src/java/net/sf/clirr/core
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv12003
Modified Files:
ClassFilter.java
Log Message:
fixed file header and added javadoc
Index: ClassFilter.java
===================================================================
RCS file: /cvsroot/clirr/clirr/core/src/java/net/sf/clirr/core/ClassFilter.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ClassFilter.java 6 Mar 2005 17:01:35 -0000 1.1
+++ ClassFilter.java 6 Mar 2005 18:40:00 -0000 1.2
@@ -1,15 +1,46 @@
+//////////////////////////////////////////////////////////////////////////////
+// Clirr: compares two versions of a java library for binary compatibility
+// Copyright (C) 2003 - 2004 Lars Kühne
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//////////////////////////////////////////////////////////////////////////////
+
package net.sf.clirr.core;
import org.apache.bcel.classfile.JavaClass;
/**
- * Created by IntelliJ IDEA.
- * User: lk
- * Date: Mar 6, 2005
- * Time: 3:56:35 PM
- * To change this template use Options | File Templates.
+ * A filter for Java classes.
+ * <p>
+ * Instances of this interface are passed to the
+ * {@link Checker#reportDiffs} method of the {@link Checker} class.
+ * </p>
+ *
+ * @see Checker#reportDiffs
+ * @see java.io.FileFilter
+ * @author lkuehne
*/
public interface ClassFilter
{
+ /**
+ * Tests whether or not a given java class is considered when reporting the API
+ * differences between jar files.
+ *
+ * @param clazz a Java class
+ * @return true if clazz should be considered by the Checker
+ * in this object.
+ */
boolean isSelected(JavaClass clazz);
}
|
