View Javadoc

1   package org.codehaus.modello.maven;
2   
3   /*
4    * Copyright (c) 2013, 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 a JSON Schema from the model.
35   *
36   * @author <a href="mailto:simonetripodi@apache.org">Simone Tripodi</a>
37   * @since 1.8
38   */
39  @Mojo( name = "jsonschema", defaultPhase = LifecyclePhase.GENERATE_SOURCES, threadSafe = true )
40  public final class ModelloJsonSchemaGeneratorMojo
41      extends AbstractModelloGeneratorMojo
42  {
43  
44      /**
45       * The output directory of the generated JSON Schema. Hint: if you want to publish the schema automatically with
46       * the site, configure this parameter to <code>${basedir}/target/generated-site/resources/jsonschema</code>.
47       */
48      @Parameter( defaultValue = "${project.build.directory}/generated-site/jsonschema", required = true )
49      private File outputDirectory;
50  
51      @Parameter
52      private String jsonSchemaFileName;
53  
54      protected void customizeParameters( Properties parameters )
55      {
56          super.customizeParameters( parameters );
57  
58          if ( jsonSchemaFileName != null )
59          {
60              parameters.put( ModelloParameterConstants.OUTPUT_JSONSCHEMA_FILE_NAME, jsonSchemaFileName );
61          }
62      }
63  
64      @Override
65      protected String getGeneratorType()
66      {
67          return "jsonschema";
68      }
69  
70      @Override
71      public File getOutputDirectory()
72      {
73          return outputDirectory;
74      }
75  
76  }