View Javadoc

1   package org.apache.maven.plugin.assembly.mojos;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.maven.project.MavenProject;
23  
24  /**
25   * Like the <code>assembly:attached</code> goal, assemble an application bundle or distribution from an assembly
26   * descriptor. This goal is suitable either for binding to the lifecycle or calling directly from the command line
27   * (provided all required files are available before the build starts, or are produced by another goal specified before
28   * this one on the command line). <br/>
29   * 
30   * This goal differs from <code>assembly:single</code> in that it ignores the &lt;formats/&gt; section of the assembly
31   * descriptor, and forces the assembly to be created as a directory in the project's build-output directory (usually
32   * <code>./target</code>).
33   * 
34   * @author <a href="mailto:jdcasey@apache.org">John Casey</a>
35   * @author <a href="mailto:gscokart@users.sourceforge.net">Gilles Scokart</a>
36   * @version $Id: DirectorySingleMojo.java 999625 2010-09-21 20:40:39Z jdcasey $
37   * 
38   * @goal directory-single
39   * @inheritByDefault false
40   * @deprecated Use assembly:single and an assembly with format == dir instead! This mojo is redundant.
41   */
42  @Deprecated
43  public class DirectorySingleMojo
44      extends AbstractDirectoryMojo
45  {
46      /**
47       * @parameter default-value="${project}"
48       * @required
49       * @readonly
50       */
51      private MavenProject project;
52  
53      @Override
54      public MavenProject getProject()
55      {
56          return project;
57      }
58  
59  }