KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > idaremedia > antx > ValueURIHandler


1 /**
2  * $Id: ValueURIHandler.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;
30
31 import com.idaremedia.antx.apis.Requester;
32
33 /**
34  * Handler for a custom AntX value-URI (or set of value-URIs). You must explicitly
35  * install most value URI handlers including those built into AntX; see
36  * {@linkplain com.idaremedia.antx.solo.ValueURIManagerTask} for more information.
37  *
38  * @since JWare/AntX 0.5
39  * @author ssmc, &copy;2004 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
40  * @version 0.5
41  * @.safety n/a
42  * @.group api,infra
43  **/
44
45 public interface ValueURIHandler
46 {
47     /**
48      * Returns this value handler's default value when incoming script
49      * identifier does not match any fixture data or identifier is
50      * malformed.
51      * @param fullUri [optional] the script-facing value uri
52      * @param clnt caller location and problem handler (non-null)
53      * @return default value for this type of value uri or <i>null</i>
54      **/
55     String JavaDoc getDefaultValue(String JavaDoc fullUri, Requester clnt);
56
57
58
59     /**
60      * Returns the current value represented by the given value uri.
61      * @param uriFragment resource information from uri (non-null)
62      * @param fullUri full script-facing value uri (non-null)
63      * @param clnt caller location and problem handler (non-null)
64      * @return stringified from of resource identified by value uri.
65      **/
66     String JavaDoc valueFrom(String JavaDoc uriFragment, String JavaDoc fullUri, Requester clnt);
67
68
69
70     /**
71      * Null proxy class used by value URI handler factories. Instances
72      * of this class never resolve any supplied uri (always returns <i>null</i>).
73      * @since JWare/AntX 0.5
74      * @author ssmc, &copy;2004 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
75      * @version 0.5
76      * @.safety multiple
77      * @.group impl,helper
78      **/
79     public static final class None implements ValueURIHandler
80     {
81         /** Initialize a new no-op proxy instance. **/
82         public None() {
83         }
84         /** Returns <i>null</i> always. **/
85         public String JavaDoc getDefaultValue(String JavaDoc fullURI, Requester clnt) {
86             return null;
87         }
88         /** Returns <i>null</i> always. **/
89         public String JavaDoc valueFrom(String JavaDoc fragment, String JavaDoc full, Requester clnt) {
90             return null;
91         }
92     }
93 }
94
95 /* end-of-ValueURIHandler.java */
Popular Tags