001: /*
002: * The Apache Software License, Version 1.1
003: *
004: * Copyright (c) 2000, 2001, 2002, 2003 Jesse Stockall. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution, if
019: * any, must include the following acknowlegement:
020: * "This product includes software developed by the
021: * Apache Software Foundation (http://www.apache.org/)."
022: * Alternately, this acknowlegement may appear in the software itself,
023: * if and wherever such third-party acknowlegements normally appear.
024: *
025: * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
026: * Foundation" must not be used to endorse or promote products derived
027: * from this software without prior written permission. For written
028: * permission, please contact apache@apache.org.
029: *
030: * 5. Products derived from this software may not be called "Apache"
031: * nor may "Apache" appear in their names without prior written
032: * permission of the Apache Group.
033: *
034: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
035: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
036: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
037: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
038: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
039: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
040: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
041: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
042: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
043: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
044: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
045: * SUCH DAMAGE.
046: * ====================================================================
047: *
048: */
049: package org.apache.tools.ant.taskdefs.optional.genjar;
050:
051: import java.io.IOException;
052: import java.util.ArrayList;
053: import java.util.Iterator;
054: import java.util.List;
055:
056: import org.apache.tools.ant.BuildException;
057: import org.apache.tools.ant.DirectoryScanner;
058: import org.apache.tools.ant.Project;
059: import org.apache.tools.ant.types.DataType;
060: import org.apache.tools.ant.types.FileSet;
061:
062: /**
063: * <p>
064: *
065: * Represents a <class> element.<p>
066: *
067: * Buildfile example:<pre>
068: * <class name="com.riggshill.ant.genjar.GenJar"/>
069: * <class name="com.riggshill.xml.Editor" bean="yes"/>
070: * </pre> <p>
071: *
072: * When the <class> element is encountered, a new ClassSpec is instantiated to represent that
073: * element. The class is used hold the class' name and manifest information. </p> <p>
074: *
075: * The <code>resolve()</code> method is implemented to determine which classes <i>this</i> class is
076: * dependant upon. A list of these classes is held for later inclusion into the jar. </p>
077: *
078: * @author Original Code: <a href="mailto:jake@riggshill.com">John W. Kohler </a>
079: * @author Jesse Stockall
080: * @version $Revision: 1.5 $ $Date: 2003/03/06 01:22:00 $
081: */
082: public class ClassSpec extends DataType implements JarSpec {
083: /** name of class */
084: private String name = null;
085: /** if set, this class is to be marked as a bean in the manifest */
086: private boolean bean = false;
087: /** list of all dependant classes */
088: private List jarEntries = new ArrayList();
089:
090: private List filesets = new ArrayList(3);
091:
092: private Project project;
093:
094: /**
095: * Constructor for the ClassSpec object
096: *
097: * @param project Description of the Parameter
098: */
099: public ClassSpec(Project project) {
100: this .project = project;
101: setDescription("Representation of a java class");
102: }
103:
104: /**
105: * Returns the list of classes upon which this class is dependant.
106: *
107: * @return the list of all dependant classes
108: */
109: public List getJarEntries() {
110: return jarEntries;
111: }
112:
113: /**
114: * Gets the name of the resource.
115: *
116: * @return Thr name
117: */
118: public String getName() {
119: return name;
120: }
121:
122: /**
123: * Invoked by Ant when the <code>name</code> attribute is encountered. If the value is <code>yes</code>
124: * or <code>true</code> then this class' manifest entry will be marked as a java bean: <code>Java-Bean: true</code>
125: *
126: * @param v The new bean value
127: */
128: public void setBean(String v) {
129: if ("yes".equalsIgnoreCase(v) || "true".equalsIgnoreCase(v)) {
130: bean = true;
131: } else {
132: bean = false;
133: }
134:
135: //
136: // if the 'bean' attribute is AFTER the name
137: // attribute then we've gotta dig the
138: // jarEntrySpec outta the collection
139: //
140: if (jarEntries.size() > 0) {
141: for (Iterator it = jarEntries.iterator(); it.hasNext();) {
142: ((JarEntrySpec) it.next()).setAttribute("Java-Bean",
143: bean ? "true" : "false");
144: }
145: }
146: }
147:
148: /**
149: * Invoked by Ant when the <code>name</code> attribute is encountered.
150: *
151: * @param n The new name value
152: */
153: public void setName(String n) {
154: name = n.replace('.', '/') + ".class";
155: JarEntrySpec jes = new JarEntrySpec(name, null);
156:
157: if (bean) {
158: jes.setAttribute("Java-Bean", "true");
159: }
160: jarEntries.add(jes);
161: }
162:
163: /**
164: * Generates a list of all classes upon which this/these class is dependant.
165: *
166: * @param gj Description of the Parameter
167: * @throws IOException Description of the Exception
168: */
169: public void resolve(GenJar gj) throws IOException {
170: //
171: // handle any filesets
172: //
173: for (Iterator it = filesets.iterator(); it.hasNext();) {
174: FileSet set = (FileSet) it.next();
175: DirectoryScanner ds = set.getDirectoryScanner(project);
176: String[] files = ds.getIncludedFiles();
177: for (int i = 0; i < files.length; i++) {
178: if (files[i].endsWith(".class")) {
179: jarEntries.add(new JarEntrySpec(files[i], null));
180: }
181: }
182: }
183: //
184: // get depends on all class files
185: //
186: gj.generateDependancies(jarEntries);
187: }
188:
189: /**
190: * add a fileset to be resolved later
191: *
192: * @return Description of the Return Value
193: */
194: public Object createFileset() {
195: if (name != null) {
196: throw new BuildException(
197: "Unable to add Fileset - class name already set");
198: }
199: FileSet set = new FileSet();
200: filesets.add(set);
201: return set;
202: }
203: }
204: // vi:set ts=4 sw=4:
|