KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > idaremedia > antx > valueuri > info > DefaultsPropertyNameURIHandler


1 /**
2  * $Id: DefaultsPropertyNameURIHandler.java 180 2007-03-15 12:56:38Z ssmc $
3  * Copyright 2005 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.valueuri.info;
30
31 import com.idaremedia.antx.Iteration;
32 import com.idaremedia.antx.apis.Requester;
33 import com.idaremedia.antx.helpers.Tk;
34 import com.idaremedia.antx.starters.ValueURIHandlerSkeleton;
35
36 /**
37  * Simple value URI handler that returns name of the project property that caller
38  * must set to control named default. To obtain the result, the current Iteration's
39  * @linkplain Defaults Defaults} object is queried. If the Defaults object does not
40  * recognize the default, <i>null</i> is returned. The general format of the URI:
41  * <span class="src">$defaultsproperty:default-name</span>.
42  * <p/>
43  * <b>Example Usage:</b><pre>
44  * &lt;property name="${$defaultsproperty:shortlocations}" value="yes"/&gt;
45  * &lt;do if="${$defaultsproperty:passwordfile}"&gt;...
46  *
47  * -- To Install --
48  * &lt;manageuris action="install"&gt;
49  * &lt;parameter name="defaultsproperty"
50  * value="com.idaremedia.antx.valueuri.info.DefaultsPropertyNameURIHandler"/&gt;
51  * &lt;/manageuris&gt;
52  * </pre>
53  *
54  * @since JWare/AntX 0.5
55  * @author ssmc, &copy;2005 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
56  * @version 0.5
57  * @.safety multiple
58  * @.group api,helper
59  * @see DefaultsValueURIHandler
60  **/
61
62 public final class DefaultsPropertyNameURIHandler extends ValueURIHandlerSkeleton
63 {
64     /**
65      * Initializes a new defaults property name uri handler.
66      **/
67     public DefaultsPropertyNameURIHandler()
68     {
69     }
70
71
72     /**
73      * Returns the associated default setting if possible. Will
74      * return <i>null</i> if default name unrecognized.
75      **/
76     public String JavaDoc valueFrom(String JavaDoc uriFragment, String JavaDoc fullUri, Requester clnt)
77     {
78         if (uriFragment.length()>0) {
79             String JavaDoc fragment = Tk.lowercaseFrom(uriFragment);
80             return Iteration.defaultdefaults().propertyFrom(fragment,clnt);
81         }
82         return null;
83     }
84 }
85
86 /* end-of-DefaultsPropertyNameURIHandler.java */
Popular Tags