Project Report: fawkez

Packagesummary org.jcoderz.commons.taskdefs

org.jcoderz.commons.taskdefs.ConfigurationValidatorGenerator

LineHitsNoteSource
1  /*
2   * $Id: ConfigurationValidatorGenerator.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 test cases 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   */
460(1)public final class ConfigurationValidatorGenerator
47        extends XsltBasedTask
48  {
49     /** The default stylesheet name. */
50     private static final String DEFAULT_STYLESHEET
51           = "generate-config-validator.xsl";
52  
53     /** package */
540    private String mPackage = null;
55  
56     /** classname */
570    private String mClassname = null;
58  
59     /**
60      * Sets the package name for the validator. This parameter is optional.
61      * The default is 'org.jcoderz.commons.config'.
62      * @param s The package.
63      */
64     public void setPackage (String s)
65     {
660       mPackage = s;
670    }
68  
69     /**
70      * Sets the classname for the validator. This parameter is optional.
71      * Default is ConfigurationValidator.
72      * @param s The classname.
73      */
74     public void setClassname (String s)
75     {
760       mClassname = s;
770    }
78  
79     /** {@inheritDoc} */
80     String getDefaultStyleSheet ()
81     {
820       return DEFAULT_STYLESHEET;
83     }
84  
85     /** {@inheritDoc} */
86     void setAdditionalTransformerParameters (Transformer transformer)
87     {
880       if (mPackage != null)
89        {
900          transformer.setParameter("package", mPackage);
91        }
920       if (mClassname != null)
93        {
940          transformer.setParameter("classname", mClassname);
95        }
960    }
97  
98     /** {@inheritDoc} */
99 (2)   void checkAttributes ()
100           throws BuildException
101     {
1020       super.checkAttributes();
1030    }
104  
105  }

Findings in this File

c (1) 46 : 0 Type Javadoc comment is missing an @author tag.
d (2) 99 : 4 Overriding method merely calls super