KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > idaremedia > antx > condition > ExternalPropertyDef


1 /**
2  * $Id: ExternalPropertyDef.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.condition;
30
31 import java.util.Map JavaDoc;
32
33 import org.apache.tools.ant.Project;
34
35 import com.idaremedia.antx.FlexString;
36
37 /**
38  * Special flex value that has a predetermined <em>target</em> value. All of this
39  * items modifiers (like trimming) are still applied to target string.
40  *
41  * @since JWare/AntX 0.4
42  * @author ssmc, &copy;2004 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
43  * @version 0.5
44  * @.safety single
45  * @.group impl,helper
46  **/
47
48 public final class ExternalPropertyDef extends FlexString
49 {
50     /**
51      * Initializes a new undefined predef value. This item's
52      * target string must be specified before it is used.
53      **/
54     public ExternalPropertyDef()
55     {
56         super();
57         setIsProperty(true);
58     }
59
60
61     /**
62      * Initializes a new attached but undefined predef value.
63      * This item's target string must be specified before it
64      * is used.
65      * @param P enclosing project (non-null)
66      **/
67     public ExternalPropertyDef(Project P)
68     {
69         this();
70         require_(P!=null,"ctor- nonzro proj");
71         setProject(P);
72     }
73
74
75     /**
76      * Defines both this item's source and target strings.
77      * @param definition the source (key) and target (value)
78      **/
79     public void set(Map.Entry JavaDoc definition)
80     {
81         require_(definition!=null,"set- nonzro defn");
82         set(definition.getKey().toString());
83         setTargetString(definition.getValue().toString());
84     }
85
86
87     /**
88      * Defines this item's target string.
89      * @param value the target value
90      **/
91     public void setTargetString(String JavaDoc value)
92     {
93         m_predefValue = value;
94     }
95
96
97     /**
98      * Returns the predefined source string. The source is
99      * not resolved in anyway.
100      **/
101     public String JavaDoc sourceString(Project P)
102     {
103         return get();
104     }
105
106
107     /**
108      * Returns the predefined value string. The source is not
109      * used to retrieve any information from the fixture.
110      **/
111     public String JavaDoc targetString(Project P, String JavaDoc source)
112     {
113         return m_predefValue;
114     }
115
116
117     private String JavaDoc m_predefValue;
118 }
119
120 /* end-of-ExternalPropertyDef.java */
121
Popular Tags