AnnotationContext


1   /*
2    * Hammurapi
3    * Automated Java code review system. 
4    * Copyright (C) 2004  Hammurapi Group
5    *
6    * This program is free software; you can redistribute it and/or modify
7    * it under the terms of the GNU General Public License as published by
8    * the Free Software Foundation; either version 2 of the License, or
9    *  (at your option) any later version.
10   *
11   * This program is distributed in the hope that it will be useful,
12   * but WITHOUT ANY WARRANTY; without even the implied warranty of
13   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   * GNU General Public License for more details.
15   *
16   * You should have received a copy of the GNU General Public License
17   * along with this program; if not, write to the Free Software
18   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19   *
20   * URL: http://www.hammurapi.org
21   * e-Mail: support@hammurapi.biz
22   */
23  
24  package org.hammurapi.results;
25  
26  import java.io.File  ;
27  
28  import org.apache.tools.ant.BuildException;
29  import org.hammurapi.HammurapiException;
30  
31  /**
32   * @author Pavel Vlasov 
33   * @version $Revision: 1.2 $
34   */
35  public interface AnnotationContext {
36      public interface FileEntry {
37          /**
38           * @return File
39           */
40          File   getFile();
41          
42          /**
43           * @return Relative path to the file
44           */
45          String   getPath();
46      }
47      
48      /**
49       * Requests next file to which annotation 
50       * can output.
51       * @param annotation
52       * @return file entry
53       */
54      FileEntry getNextFile(String   extension) throws HammurapiException;
55      
56      String   getExtension();
57      
58      Object   getParameter(String   name) throws BuildException;
59      
60      boolean isEmbeddedStyle();
61  }
62
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags