KickJava   Java API By Example, From Geeks To Geeks.

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


1 /**
2  * $Id: IterationInfoValueURIHandler.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.starters.ValueURIHandlerSkeleton;
34
35 /**
36  * Value URI handler that display various bits of information about the current AntX
37  * iteration.
38  * <p/>
39  * <b>Example Usage:</b><pre>
40  * &lt;show if="build.debug"
41  * message="ITID: ${<b>$iteration:</b>classname},${<b>$iteration:</b>id}"/&gt;
42  *
43  * -- To Install --
44  * &lt;manageuris action="install"&gt;
45  * &lt;parameter name="iteration"
46  * value="com.idaremedia.antx.valueuri.info.IterationInfoValueURIHandler"/&gt;
47  * &lt;/manageuris&gt;
48  * </pre>
49  *
50  * @since JWare/AntX 0.5
51  * @author ssmc, &copy;2005 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
52  * @version 0.5
53  * @.safety multiple
54  * @.group api,helper
55  * @see com.idaremedia.antx.Iteration#toString(String) Iteration.toString(&#8230;)
56  **/
57
58 public final class IterationInfoValueURIHandler extends ValueURIHandlerSkeleton
59 {
60     /**
61      * Initializes a new value uri handler instance.
62      **/
63     public IterationInfoValueURIHandler()
64     {
65     }
66
67
68     /**
69      * Looks for one of known selectors and returns appropriate information.
70      * Base selectors include: classname, id, property; subclasses can extend
71      * as necessary.
72      **/
73     public String JavaDoc valueFrom(String JavaDoc uriFragment, String JavaDoc fullUri, Requester clnt)
74     {
75         Iteration iteration = Iteration.get();
76         String JavaDoc value = iteration.toString(uriFragment);
77         return value!=null ? value : getDefaultValue(fullUri,clnt);
78     }
79 }
80
81 /* end-of-IterationInfoValueURIHandler.java */
Popular Tags