KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sourceforge > cruisecontrol > util > NamedXPathAwareChild


1 /********************************************************************************
2  * CruiseControl, a Continuous Integration Toolkit
3  * Copyright (c) 2005, ThoughtWorks, Inc.
4  * 651 W Washington Ave. Suite 600
5  * Chicago, IL 60661 USA
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * + Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * + Redistributions in binary form must reproduce the above
16  * copyright notice, this list of conditions and the following
17  * disclaimer in the documentation and/or other materials provided
18  * with the distribution.
19  *
20  * + Neither the name of ThoughtWorks, Inc., CruiseControl, nor the
21  * names of its contributors may be used to endorse or promote
22  * products derived from this software without specific prior
23  * written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
29  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  ********************************************************************************/
37 package net.sourceforge.cruisecontrol.util;
38
39 import net.sourceforge.cruisecontrol.CruiseControlException;
40
41 /**
42  * <p>Just like XPathAwareChild, but has an additional "name" attribute associated with it. This is useful when you
43  * want repeating children, e.g.</p>
44  * <pre>
45  * &lt;myfavoriteplugin&gt;
46  * &lt;field name="name" value="Tony"/&gt;
47  * &lt;field name="address" value="Your Street, USA"/&gt;
48  * &lt;field name="unittestcount" xpathExpression="sum(cruisecontrol/testsuite/@tests)"/&gt;
49  * &lt;/myfavoriteplugin&gt;
50  * </pre>
51  * For example usage, see
52  * {@link net.sourceforge.cruisecontrol.publishers.sfee.SfeeTrackerPublisher#createField()}.
53  *
54  * @author <a HREF="mailto:pj@thoughtworks.com">Paul Julius</a>
55  * @author <a HREF="mailto:krs@thoughtworks.com">Kent Spillner</a>
56  */
57 public class NamedXPathAwareChild extends XPathAwareChild {
58     private String JavaDoc name;
59
60     public String JavaDoc getName() {
61         return name;
62     }
63
64     public void setName(String JavaDoc name) {
65         markDirty();
66         this.name = name;
67     }
68
69     public void validate() throws CruiseControlException {
70         if (name == null) {
71             throw new CruiseControlException("name must be set.");
72         }
73
74         super.validate();
75     }
76
77 }
78
Popular Tags