View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.plugins.jar;
20  
21  import java.io.File;
22  
23  import org.apache.maven.plugins.annotations.LifecyclePhase;
24  import org.apache.maven.plugins.annotations.Mojo;
25  import org.apache.maven.plugins.annotations.Parameter;
26  import org.apache.maven.plugins.annotations.ResolutionScope;
27  
28  /**
29   * Build a JAR from the current project.
30   *
31   * @author <a href="evenisse@apache.org">Emmanuel Venisse</a>
32   * @version $Id$
33   */
34  @Mojo(
35          name = "jar",
36          defaultPhase = LifecyclePhase.PACKAGE,
37          requiresProject = true,
38          threadSafe = true,
39          requiresDependencyResolution = ResolutionScope.RUNTIME)
40  public class JarMojo extends AbstractJarMojo {
41      /**
42       * Directory containing the classes and resource files that should be packaged into the JAR.
43       */
44      @Parameter(defaultValue = "${project.build.outputDirectory}", required = true)
45      private File classesDirectory;
46  
47      /**
48       * Classifier to add to the artifact generated. If given, the artifact will be attached
49       * as a supplemental artifact.
50       * If not given this will create the main artifact which is the default behavior.
51       * If you try to do that a second time without using a classifier the build will fail.
52       */
53      @Parameter
54      private String classifier;
55  
56      /**
57       * {@inheritDoc}
58       */
59      @Override
60      protected String getClassifier() {
61          return classifier;
62      }
63  
64      /**
65       * {@inheritDoc}
66       */
67      @Override
68      protected String getType() {
69          return "jar";
70      }
71  
72      /**
73       * {@inheritDoc}
74       */
75      @Override
76      protected File getClassesDirectory() {
77          return classesDirectory;
78      }
79  }