LogInterpreter


1   /**
2    * $Id: LogInterpreter.java 180 2007-03-15 12:56:38Z ssmc $
3    * Copyright 2005 iDare Media, Inc. All rights reserved.
4    *
5    * Originally written by iDare Media, Inc. for release into the public domain. This
6    * library, source form and binary form, is free software; you can redistribute it and/or
7    * modify it under the terms of the GNU Lesser General Public License (LGPL) as published
8    * by the Free Software Foundation; either version 2.1 of the License, or (at your option)
9    * any later version.<p>
10   *
11   * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
12   * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13   * See the GNU LGPL for more details.<p>
14   *
15   * You should have received a copy of the GNU Lesser General Public License along with this
16   * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite
17   * 330, Boston, MA  02111-1307  USA. The GNU LGPL can be found online at
18   * http://www.fsf.org/copyleft/lesser.html<p>
19   *
20   * This product has been influenced by several projects within the open-source community.
21   * The JWare developers wish to acknowledge the open-source community's support. For more
22   * information regarding the open-source products used within JWare, please visit the
23   * JWare website.
24   *----------------------------------------------------------------------------------------*
25   * WEBSITE- http://www.jware.info                            EMAIL- inquiries@jware.info
26   *----------------------------------------------------------------------------------------*
27   **/
28  
29  package com.idaremedia.antx.capture;
30  
31  import  java.io.Reader  ;
32  
33  import  org.apache.tools.ant.BuildException;
34  
35  /**
36   * Strategy interface for a utility that interprets a particular Ant tool's logged
37   * feedback to determine whether the tools succeeded or not (and to what degree).
38   *
39   * @since     JWare/AntX 0.5
40   * @author    ssmc, &copy;2005 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
41   * @version   0.5
42   * @.safety   n/a
43   * @.group    impl,helper
44   * @.pattern  GoF.Strategy
45   * @see       InterpretLoggedTask
46   **/
47  
48  public interface LogInterpreter
49  {
50      /** Symbolic value returned if no problems are detected in log stream. **/
51      public static final String   CLEAN   = "CLEAN";
52  
53      /** Symbolic value returned if at least one problem is detected in log stream. **/
54      public static final String   PROBLEM = "PROBLEM";
55  
56      /** Symbolic value returned if too many problems are detected in log stream. **/
57      public static final String   FAILURE = "FAILURE";
58  
59  
60      /**
61       * Do whatever is necessary to interpret an Ant tool's logged output as either
62       * clean, problematic, or a total failure.
63       * @param inputr logged information (a log file, a log stream, etc&#46;)
64       * @param clnt calling context (non-null)
65       * @return the interpretation as a simple clean,problem,failure flag. See
66       *          {@linkplain #CLEAN}, {@linkplain #PROBLEM}, and {@linkplain #FAILURE}.
67       * @throws BuildException if unable to read logged information.
68       **/
69      String   interpret(Reader   inputr, InterpretParameters clnt)
70          throws BuildException;
71  }
72  
73  /* end-of-ToolLogInterpreter.java */
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags