InformationSaver


1   /**
2    * $Id: InformationSaver.java 180 2007-03-15 12:56:38Z ssmc $
3    * Copyright 2004 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.parameters;
30  
31  /**
32   * A component that can write some kind of captured information to the file system. The
33   * item must support (at least) the standard
34   * '<span class="src">tofile=path</span>' and
35   * '<span class="src">append=[yes|no]</span>' short-hand parameters. Whether the
36   * parameter should specify a file, directory, or both is implementation specific.
37   *
38   * @since    JWare/AntX 0.4
39   * @author   ssmc, &copy;2004 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
40   * @version  0.5
41   * @.safety  n/a
42   * @.group   api,helper
43   **/
44  
45  public interface InformationSaver
46  {
47      /**
48       * Sets the file path for this item's captured output.
49       * Whether the path represents a full path or a project-relative
50       * path is up to this interface's implementation.
51       * @param outputFile the output file's path (non-null)
52       **/
53      void setToFile(String   outputFile);
54  
55  
56      /**
57       * Returns this item's target file path for output. Can return
58       * <i>null</i> if never set. Whether this is an absolute or
59       * relative path is implementation defined.
60       **/
61      String   getToFilePath();
62  
63  
64  
65      /**
66       * Marks whether this item should try to append its new
67       * information to its output stream.
68       * @param append <i>true</i> if should try to append
69       **/
70      void setAppend(boolean append);
71  
72  
73      /**
74       * Returns <i>true</i> if this item will try to append
75       * any new information to an existing output sink.
76       **/
77      boolean willTryAppend();
78  }
79  
80  /* end-of-InformationSaver.java */
81
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags