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.plugins.annotations.Execute;
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.project.MavenProject;
27  
28  /**
29   * Like the <code>assembly:attached</code> goal, assemble an application bundle or distribution using an assembly
30   * descriptor from the command line. This goal will force Maven to build all included POMs up to the
31   * <code>package</code> phase BEFORE the assembly is processed. This goal differs from <code>assembly:assembly</code> in
32   * that it ignores the &lt;formats/&gt; section of the assembly descriptor, and forces the assembly to be created as a
33   * directory in the project's build-output directory (usually <code>./target</code>). <br/>
34   * <p/>
35   * This goal is also functionally equivalent to using the <code>assembly:assembly</code> goal in conjunction with the
36   * <code>dir</code> assembly format. <br/>
37   * <p/>
38   * <b>NOTE:</b> This goal should ONLY be run from the command line, and if building a multimodule project it should be
39   * used from the root POM. Use the <code>assembly:directory-single</code> goal for binding your assembly to the
40   * lifecycle.
41   *
42   * @author <a href="mailto:jdcasey@apache.org">John Casey</a>
43   * @version $Id: DirectoryMojo.java 1618908 2014-08-19 17:27:43Z khmarbaise $
44   * @deprecated Use assembly:single and an assembly with format == dir instead! This mojo is redundant.
45   */
46  @Mojo( name = "directory", aggregator = true, inheritByDefault = false )
47  @Execute( phase = LifecyclePhase.PACKAGE )
48  @Deprecated
49  public class DirectoryMojo
50      extends AbstractDirectoryMojo
51  {
52      /**
53       * Get the executed project from the forked lifecycle.
54       */
55      @Parameter( property = "executedProject" )
56      private MavenProject executedProject;
57  
58      @Override
59      public MavenProject getProject()
60      {
61          return executedProject;
62      }
63  }