FlexInformationSaver


1   /**
2    * $Id: FlexInformationSaver.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 captured string-based information to various sinks. This
33   * interface is an extension of the base saver API that allows derived string-based
34   * information to be stored to project properties directly.  The item must support
35   * the standard '<span class="src">toproperty=propertyname</span>' short-hand parameter.
36   *
37   * @since    JWare/AntX 0.4
38   * @author   ssmc, &copy;2004 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
39   * @version  0.5
40   * @.safety  n/a
41   * @.group   api,helper
42   **/
43  
44  public interface FlexInformationSaver extends InformationSaver
45  {
46      /**
47       * Sets the property to which information should be copied.
48       * @param property the property to create (non-null)
49       **/
50      void setToProperty(String   property);
51  
52  
53      /**
54       * Returns the name of the property this item will set with
55       * the captured information. Can return <i>null</i> if never
56       * set explicitly.
57       * @see #setToProperty setToProperty
58       **/
59      String   getToProperty();
60  }
61  
62  /* end-of-FlexInformationSaver.java */
63
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags