KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > puppycrawl > tools > checkstyle > api > FileSetCheck


1 ////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code for adherence to a set of rules.
3 // Copyright (C) 2001-2005 Oliver Burn
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 package com.puppycrawl.tools.checkstyle.api;
20
21 import java.io.File JavaDoc;
22
23 /**
24  * Interface for Checking a set of files for some criteria.
25  *
26  * @author lkuehne
27  */
28 public interface FileSetCheck
29     extends Configurable, Contextualizable
30 {
31     /**
32      * Sets the MessageDispatcher that is used to dispatch error
33      * messages to AuditListeners during processing.
34      * @param aDispatcher the dispatcher
35      */
36     void setMessageDispatcher(MessageDispatcher aDispatcher);
37
38     /**
39      * Processes a set of files and fires errors to the MessageDispatcher.
40      *
41      * The file set to process might contain files that are not
42      * interesting to the FileSetCheck. Such files should be ignored,
43      * no error message should be fired for them. For example a FileSetCheck
44      * that checks java files should ignore html or properties files.
45      *
46      * Once processiong is done, it is highly recommended to call for
47      * the destroy method to close and remove the listeners.
48      *
49      * @param aFiles the files to be audited.
50      * @see #destroy()
51      */
52     void process(File JavaDoc[] aFiles);
53
54     /** Cleans up the object. **/
55     void destroy();
56 }
57
Popular Tags