1 package org.codehaus.modello.maven; 2 3 /* 4 * Copyright (c) 2004, Codehaus.org 5 * 6 * Permission is hereby granted, free of charge, to any person obtaining a copy of 7 * this software and associated documentation files (the "Software"), to deal in 8 * the Software without restriction, including without limitation the rights to 9 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies 10 * of the Software, and to permit persons to whom the Software is furnished to do 11 * so, subject to the following conditions: 12 * 13 * The above copyright notice and this permission notice shall be included in all 14 * copies or substantial portions of the Software. 15 * 16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 22 * SOFTWARE. 23 */ 24 25 import java.io.File; 26 import java.util.Properties; 27 28 import org.apache.maven.plugins.annotations.LifecyclePhase; 29 import org.apache.maven.plugins.annotations.Mojo; 30 import org.apache.maven.plugins.annotations.Parameter; 31 import org.codehaus.modello.ModelloParameterConstants; 32 33 /** 34 * Creates an XML schema from the model. 35 * 36 * @author <a href="mailto:brett@codehaus.org">Brett Porter</a> 37 */ 38 @Mojo(name = "xsd", defaultPhase = LifecyclePhase.GENERATE_SOURCES, threadSafe = true) 39 public class ModelloXsdMojo extends AbstractModelloGeneratorMojo { 40 /** 41 * The output directory of the generated XML Schema. 42 */ 43 @Parameter(defaultValue = "${project.build.directory}/generated-site/resources/xsd", required = true) 44 private File outputDirectory; 45 46 /** 47 * Boolean flag to enforce mandatory elements in the XML schema. 48 * If set to {@code false} the XSD won't enforce mandatory elements in the XML which can be useful if the XML is post processed (e.g. POM merging with parents). 49 * The default value is {@code false} for backwards compatibility reasons, but should be set to {@code true} for most cases. 50 * @since 2.1.0 51 */ 52 @Parameter(defaultValue = "false") 53 private boolean enforceMandatoryElements; 54 55 /** 56 * 57 * @since 1.0-alpha-21 58 */ 59 @Parameter 60 private String xsdFileName; 61 62 protected String getGeneratorType() { 63 return "xsd"; 64 } 65 66 protected void customizeParameters(Properties parameters) { 67 super.customizeParameters(parameters); 68 69 if (xsdFileName != null) { 70 parameters.put(ModelloParameterConstants.OUTPUT_XSD_FILE_NAME, xsdFileName); 71 } 72 parameters.put(ModelloParameterConstants.XSD_ENFORCE_MANDATORY_ELEMENTS, enforceMandatoryElements); 73 } 74 75 protected boolean producesCompilableResult() { 76 return false; 77 } 78 79 public File getOutputDirectory() { 80 return outputDirectory; 81 } 82 83 public void setOutputDirectory(File outputDirectory) { 84 this.outputDirectory = outputDirectory; 85 } 86 }