KickJava   Java API By Example, From Geeks To Geeks.

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


1 /**
2  * $Id: CustomLoaderEnabled.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 import org.apache.tools.ant.types.Path;
32 import org.apache.tools.ant.types.Reference;
33
34 /**
35  * A component that supports custom class and resource loading options.
36  * The component will use the custom classpath when searching for and/or
37  * loading resources.
38  *
39  * @since JWare/AntX 0.4
40  * @author ssmc, &copy;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 CustomLoaderEnabled
47 {
48     /**
49      * Creates and returns a new path element from this component's
50      * custom class path. The caller must configure the new
51      * element.
52      **/
53     Path createClassPath();
54
55
56     /**
57      * Adds a new classpath element to this component's custom
58      * classpath.
59      * @param classpath the path to be added (non-null)
60      **/
61     void setClassPath(Path classpath);
62
63
64     /**
65      * Returns this component's custom classpath. Can return
66      * <i>null</i> if custom path never created.
67      **/
68     Path getClassPath();
69
70
71     /**
72      * Adds an existing classpath element to this component's
73      * custom classpath.
74      * @param r reference to an existing path item (non-null)
75      **/
76     void setClassPathRef(Reference r);
77
78
79     /**
80      * Tells this component to use an existing classloader to
81      * search and/or load resources.
82      * @param r reference to an existing ClassLoader (non-null)
83      **/
84     void setLoaderRef(Reference r);
85
86
87     /**
88      * Returns this component's own loader identifier based on
89      * its <em>current</em> configuration; specifically the last
90      * assigned loader reference or the last classpath reference
91      * assigned.
92      **/
93     String JavaDoc getLoaderRefId();
94 }
95
96 /* end-of-CustomLoaderEnabled.java */
97
Popular Tags