View Javadoc
1   /*
2    *   Copyright (C) Christian Schulte, 2005-206
3    *   All rights reserved.
4    *
5    *   Redistribution and use in source and binary forms, with or without
6    *   modification, are permitted provided that the following conditions
7    *   are met:
8    *
9    *     o Redistributions of source code must retain the above copyright
10   *       notice, this list of conditions and the following disclaimer.
11   *
12   *     o Redistributions in binary form must reproduce the above copyright
13   *       notice, this list of conditions and the following disclaimer in
14   *       the documentation and/or other materials provided with the
15   *       distribution.
16   *
17   *   THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
18   *   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
19   *   AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
20   *   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,
21   *   INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22   *   NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23   *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24   *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25   *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26   *   THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27   *
28   *   $JOMC: MainModuleAttachMojo.java 4613 2012-09-22 10:07:08Z schulte $
29   *
30   */
31  package org.jomc.mojo;
32  
33  import java.io.File;
34  
35  /**
36   * Attaches a project's main module artifact.
37   *
38   * @author <a href="mailto:cs@schulte.it">Christian Schulte</a>
39   * @version $JOMC: MainModuleAttachMojo.java 4613 2012-09-22 10:07:08Z schulte $
40   *
41   * @phase process-resources
42   * @goal attach-main-module
43   */
44  public final class MainModuleAttachMojo extends AbstractAttachMojo
45  {
46  
47      /**
48       * File of the attached module artifact.
49       *
50       * @parameter expression="${jomc.mainModuleArtifactFile}"
51       *            default-value="${project.build.outputDirectory}/META-INF/jomc.xml"
52       */
53      private File mainModuleArtifactFile;
54  
55      /**
56       * Classifier of the attached module artifact.
57       *
58       * @parameter expression="${jomc.mainModuleArtifactClassifier}" default-value="jomc-module"
59       */
60      private String mainModuleArtifactClassifier;
61  
62      /**
63       * Type of the attached module artifact.
64       *
65       * @parameter expression="${jomc.mainModuleArtifactType}" default-value="xml"
66       */
67      private String mainModuleArtifactType;
68  
69      /**
70       * Execution strategy of the goal ({@code always} or {@code once-per-session}).
71       *
72       * @parameter default-value="once-per-session" expression="${jomc.attachMainModuleExecutionStrategy}"
73       * @since 1.1
74       */
75      private String attachMainModuleExecutionStrategy;
76  
77      /** Creates a new {@code MainModuleAttachMojo} instance. */
78      public MainModuleAttachMojo()
79      {
80          super();
81      }
82  
83      @Override
84      protected File getArtifactFile()
85      {
86          return this.mainModuleArtifactFile;
87      }
88  
89      @Override
90      protected String getArtifactClassifier()
91      {
92          return this.mainModuleArtifactClassifier;
93      }
94  
95      @Override
96      protected String getArtifactType()
97      {
98          return this.mainModuleArtifactType;
99      }
100 
101     @Override
102     protected String getExecutionStrategy()
103     {
104         return this.attachMainModuleExecutionStrategy;
105     }
106 
107 }