KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > idaremedia > antx > parameters > FlexSourceSupport


1 /**
2  * $Id: FlexSourceSupport.java 180 2007-03-15 12:56:38Z ssmc $
3  * Copyright 2002-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 as published by the
8  * Free Software Foundation; either version 2.1 of the License, or (at your option) any
9  * 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 (GNU Lesser General Public License) 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 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 supports setters/getters for the common kinds of data
33  * sources: files, resources, urls. Generalized from the specific original
34  * <span class="src">UISMSource</span> interface.
35  *
36  * @since JWare/AntX 0.2 (moved from UISMSource in AntX 0.4)
37  * @author ssmc, &copy;2002-2004 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
38  * @version 0.5
39  * @.safety n/a
40  * @.group api,infra
41  * @.impl All inputs are simple strings to support locations that are relative
42  * to something other than the project. Gives implementors a chance to
43  * implement differently.
44  **/
45
46 public interface FlexSourceSupport
47 {
48     /**
49      * Sets this item's data source location as a URL.
50      * @param urlstr URL string representation (non-null)
51      **/
52     void setURL(String JavaDoc urlstr);
53
54
55     /**
56      * Sets this item's data source location as a file.
57      * @param filepath the readable file's path (non-null)
58      **/
59     void setFile(String JavaDoc filepath);
60
61
62     /**
63      * Sets this item's data source location as a classpath-based
64      * resource name.
65      **/
66     void setResource(String JavaDoc rsrc);
67 }
68
69 /* end-of-FlexSourceSupport.java */
70
Popular Tags