UISMSource


1   /**
2    * $Id: UISMSource.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.init;
30  
31  import  java.io.File  ;
32  import  java.net.URL  ;
33  
34  import  com.idaremedia.antx.parameters.FlexSourceSupport;
35  
36  /**
37   * Source of a raw PropertyResourceBundle used to define UIStringManagers.
38   *
39   * @since    JWare/AntX 0.2
40   * @author   ssmc, &copy;2002-2004 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
41   * @version  0.5
42   * @.safety  n/a
43   * @.group   api,infra
44   **/
45  
46  public interface UISMSource extends FlexSourceSupport
47  {
48      /**
49       * Sets this source's resource bundle's location as a URL.
50       * @param urlstr URL string representation (non-null)
51       * @throws BuildException if this source is a reference or another
52       *         or another bundle source has already been specified
53       **/
54      void setURL(String   urlstr);
55  
56  
57      /**
58       * Returns this source's resource bundle's URL location. Returns
59       * <i>null</i> if never set or was set to an invalid URL string.
60       **/
61      URL   getURL();
62  
63  
64      /**
65       * Sets this source's resource bundle's location as a file.
66       * @param filepath the readable file's path (non-null)
67       * @throws BuildException if this source is a reference or another
68       *         or another bundle source has already been specified
69       **/
70      void setFile(String   filepath);
71  
72  
73      /**
74       * Returns this source's resource bundle's file location. Returns
75       * <i>null</i> if never set (or determined from other source types).
76       **/
77      File   getFile();
78  
79  
80      /**
81       * Sets this source's resource bundle's location as a classpath-based
82       * resource name.
83       **/
84      void setResource(String   rsrc);
85  
86  
87      /**
88       * Returns this source's resource bundle's classpath-based resource
89       * name. Returns <i>null</i> if never set.
90       **/
91      String   getResource();
92  }
93  
94  /* end-of-UISMSource.java */
95
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags