Project Report: fawkez

Packagesummary org.jcoderz.commons.taskdefs

org.jcoderz.commons.taskdefs.ConfigurationClassesGenerator

LineHitsNoteSource
1  /*
2   * $Id: ConfigurationClassesGenerator.java 1011 2008-06-16 17:57:36Z amandel $
3   *
4   * Copyright 2006, The jCoderZ.org Project. All rights reserved.
5   *
6   * Redistribution and use in source and binary forms, with or without
7   * modification, are permitted provided that the following conditions are
8   * met:
9   *
10   *    * Redistributions of source code must retain the above copyright
11   *      notice, this list of conditions and the following disclaimer.
12   *    * Redistributions in binary form must reproduce the above
13   *      copyright notice, this list of conditions and the following
14   *      disclaimer in the documentation and/or other materials
15   *      provided with the distribution.
16   *    * Neither the name of the jCoderZ.org Project nor the names of
17   *      its contributors may be used to endorse or promote products
18   *      derived from this software without specific prior written
19   *      permission.
20   *
21   * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND
22   * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24   * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS
25   * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
28   * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
29   * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
30   * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
31   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32   */
33  package org.jcoderz.commons.taskdefs;
34  
35  import javax.xml.transform.Transformer;
36  
37  import org.apache.tools.ant.BuildException;
38  
39  /**
40   * Ant task that generates the configuration classes out of an XML document.
41   * <p>
42   * Documentation of this Ant task can be found in
43   * {@link org.jcoderz.commons.taskdefs}.
44   *
45   * @author Michael Griffel
46   */
470 public final class ConfigurationClassesGenerator
48        extends XsltBasedTask
49  {
50     /** The default stylesheet name. */
51     private static final String DEFAULT_STYLESHEET
52           = "generate-config-classes.xsl";
53  
54     /** The application name. */
550    private String mApplication = null;
56     /** The group short names. */
570    private String mGroups = null;
58  
59     /**
60      * Sets the application (short) name. This parameter is required.
61      * @param s The application (short) name.
62      */
63     public void setApplication (String s)
64     {
650       mApplication = s;
660    }
67  
68     /**
69      * Sets the group short names. This parameter is required.
70      * @param s The group short names.
71      */
72     public void setGroups (String s)
73     {
740       mGroups = s;
750    }
76  
77     /** {@inheritDoc} */
78     String getDefaultStyleSheet ()
79     {
800       return DEFAULT_STYLESHEET;
81     }
82  
83     /** {@inheritDoc} */
84     void setAdditionalTransformerParameters (Transformer transformer)
85     {
860       transformer.setParameter("application-short-name", mApplication);
870       transformer.setParameter("application-name", mApplication);
880       transformer.setParameter("group-short-name", mGroups);
890    }
90  
91     /** {@inheritDoc} */
92     void checkAttributes ()
93           throws BuildException
94     {
950       super.checkAttributes();
96  
970       if (mApplication == null)
98        {
990          throw new BuildException(
100                 "Missing mandatory attribute 'application'.", getLocation());
101        }
1020       if (mGroups == null)
103        {
1040          throw new BuildException(
105                 "Missing mandatory attribute 'groups'.", getLocation());
106        }
107  
1080    }
109  
110  }

Findings in this File