Java tutorial
package org.codehaus.mojo.xmlbeans; /* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. */ import java.io.File; import java.util.ArrayList; import java.util.Iterator; import java.util.List; import org.apache.maven.artifact.DependencyResolutionRequiredException; import org.apache.maven.model.Resource; import org.apache.maven.project.MavenProject; import org.apache.xmlbeans.impl.tool.SchemaCompiler; /** * <p>A Maven 2 plugin which parses xsd files and produces a corresponding object * model based on the Apache XML Beans parser.</p> * <p/> * <p>The plugin produces two sets of output files referred to as generated sources * and generated classes. The former is then compiled to the build * <code>outputDirectory</code>. The latter is generated in this directory.</p> * <p/> * <p>Note that the descriptions for the goal's parameters have been blatently * copied from http://xmlbeans.apache.org/docs/2.0.0/guide/antXmlbean.html for * convenience.</p> * * @author <a href="mailto:brett@apache.org">Brett Porter</a> * @author <a href="mailto:kris.bravo@corridor-software.us">Kris Bravo</a> * @version $Id$ * @goal xmlbeans * @phase generate-sources * @requiresDependencyResolution compile * @description Creates java beans which map to XML schemas. */ public class CompileXmlBeansMojo extends AbstractXmlBeansPlugin { /** * The directory where .xsd files are to be found. * * @parameter default-value="${basedir}/src/main/xsd" * @required */ protected File schemaDirectory; /** * List of artifacts whose xsds need to be compiled. * * @parameter */ private List xsdJars; /** * The directory where .xsd's pulled from xsdJars will be stored. * * @parameter default-value="${project.build.directory}/xmlbeans-xsds" * @parameter */ private File generatedSchemaDirectory; /** * Set a location to generate CLASS files into. * * @parameter expression="${xmlbeans.classGenerationDirectory}" * default-value="${project.build.directory}/generated-classes/xmlbeans" * @required */ protected File classGenerationDirectory; /** * Set a location to generate JAVA files into. * * @parameter expression="${xmlbeans.sourceGenerationDirectory}" * default-value="${project.build.directory}/generated-sources/xmlbeans" * @required */ protected File sourceGenerationDirectory; /** * The location of the flag file used to determine if the output is stale. * * @parameter expression="${xmlbeans.staleFile}" * default-value="${project.build.directory}/generated-sources/xmlbeans/.staleFlag" * @required */ protected File staleFile; /** * Default xmlConfigs directory. If no xmlConfigs list is specified, this * one is checked automatically. * * @parameter expression="${xmlbeans.defaultXmlConfigDir}" default-value="${basedir}/src/main/xsdconfig" */ protected File defaultXmlConfigDir; /** * Empty constructor for the XML Beans plugin. */ public CompileXmlBeansMojo() { } /** * {@inheritDoc} * * @return Array of compile scoped classpath entries. * @throws DependencyResolutionRequiredException Plugin wasn't annotated with requiresDependencyResolution * and compile scope */ public final File[] getClasspath() throws DependencyResolutionRequiredException { List results = new ArrayList(); for (Iterator i = project.getCompileClasspathElements().iterator(); i.hasNext();) { results.add(new File((String) i.next())); } return (File[]) results.toArray(EMPTY_FILE_ARRAY); } protected void updateProject(MavenProject project, SchemaCompiler.Parameters compilerParams, boolean stale) throws DependencyResolutionRequiredException, XmlBeansException { if (getLog().isDebugEnabled()) { getLog().debug("Adding " + compilerParams.getSrcDir().getAbsolutePath() + " to the project's compile sources."); } project.addCompileSourceRoot(compilerParams.getSrcDir().getAbsolutePath()); Resource resource = new Resource(); resource.setDirectory(compilerParams.getClassesDir().getAbsolutePath()); resource.setFiltering(false); project.addResource(resource); } /** * Returns the directory where the schemas are located. Note that this is * the base directory of the schema compiler, not the maven project. * * @return The schema directory. */ public File getBaseDir() { return getSchemaDirectory(); } /** * Returns the class directory of the project. * * @return The project build classes directory. */ public final File getGeneratedClassesDirectory() { return classGenerationDirectory; } /** * Returns the directory for saving generated source files. * * @return The generated=sources directory. */ public final File getGeneratedSourceDirectory() { return sourceGenerationDirectory; } public File getStaleFile() { return staleFile; } public File getDefaultXmlConfigDir() { return defaultXmlConfigDir; } /** * Returns the directory where the schemas are located. Note that this is * the base directory of the schema compiler, not the maven project. * * @return The schema directory. */ public File getSchemaDirectory() { return schemaDirectory; } /** * Returns the list of xsd jars. * * @return The xsd jars */ protected List getXsdJars() { if (xsdJars == null) { xsdJars = new ArrayList(); } return xsdJars; } protected File getGeneratedSchemaDirectory() { return generatedSchemaDirectory; } }