KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > idaremedia > antx > apis > ScriptLocatable


1 /**
2  * $Id: ScriptLocatable.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.apis;
30
31 import org.apache.tools.ant.Location;
32
33 /**
34  * Any application object that supports the standard Ant (parse) location APIs. If
35  * a class implements this interface, it's saying it <em>knows</em> that its instances
36  * are most often created from script-supplied instructions. Objects like
37  * {@linkplain Requester requesters} are not necessarily script-bound and therefore do
38  * not automatically link in this marker interface.
39  * <p/>
40  * If the Ant infrastructure ever supplies components and other data types with a
41  * location accessor, we can easily link this interface to that information.
42  *
43  * @since JWare/AntX 0.5
44  * @author ssmc, &copy;2004 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
45  * @version 0.5
46  * @.safety n/a
47  * @.group api,infra
48  **/
49
50 public interface ScriptLocatable
51 {
52     /**
53      * Returns this object's script location information. While
54      * this method could return the <span class="src">UNKNOWN</span> marker,
55      * it usually wouldn't. Should never return <i>null</i>.
56      **/
57     Location getLocation();
58 }
59
60
61 /* end-of-Locatable.java */
Popular Tags