Source Code Cross Referenced for PackagePrefix.java in  » Code-Analyzer » JBlanket » csdl » jblanket » ant » Java Source Code / Java DocumentationJava Source Code and Java Documentation

01:        package csdl.jblanket.ant;
02:
03:        /**
04:         * Implements the packageprefix nested element used by JBlanketModifierTask.
05:         * <p>
06:         * <b>Required</b> attribute for the 'packageprefix' nested element:
07:         * <ul>
08:         * <p>
09:         * 'name' - describes the package prefix to be modified<br>
10:         * <i>For example</i>: name="csdl.stack"
11:         * </ul>
12:         * Use this nested element when modifying a JAR file that contains files that are not to be
13:         * included in the coverage measurement.
14:         * <p>
15:         * One example of the 'packageprefix' nested element is:
16:         * <pre>
17:         * &lt;taskdef name="jblanket" classname="csdl.jblanket.ant.JBlanketModifierTask"/&gt;
18:         * &lt;jblanket testgrammar="Test&#42;.class"&gt;
19:         *   &lt;fileset dir="${lib.dir}"&gt;
20:         *     &lt;include name="stack.jar"/&gt;
21:         *   &lt;/fileset&gt;
22:         *   &lt;packageprefix name="csdl.stack."/&gt;
23:         * &lt;/jblanket&gt;
24:         * </pre>
25:         * where only class files in the 'stack.jar' file that begin with 'csdl.stack.' will be modified.
26:         * <p>
27:         * NOTE: Do not add '*' at the end of the name of the packageprefix element.
28:         *
29:         * @author Joy M. Agustin
30:         * @version $Id: PackagePrefix.java,v 1.1 2004/11/07 00:32:33 timshadel Exp $id
31:         */
32:        public class PackagePrefix {
33:
34:            /** Name of a package prefix */
35:            private String name;
36:
37:            /** Constructs a new PackagePrefix object. */
38:            public PackagePrefix() {
39:                this .name = null;
40:            }
41:
42:            /**
43:             * Sets the name of the package prefix.
44:             *
45:             * @param name the name of the package prefix.
46:             */
47:            public void setName(String name) {
48:                this .name = name;
49:            }
50:
51:            /**
52:             * Gets the name of this package prefix.
53:             *
54:             * @return the name of this package prefix.
55:             */
56:            public String getName() {
57:                return this.name;
58:            }
59:        }