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, WITHOUT first forcing Maven to build all POMs to the <code>package</code> phase (as is required by the
27   * <code>assembly:assembly</code> goal). This goal differs from <code>assembly:attached</code> in that it ignores the
28   * &lt;formats/&gt; section of the assembly descriptor, and forces the assembly to be created as a directory in the
29   * project's build-output directory (usually <code>./target</code>). <br/>
30   * 
31   * This goal is also functionally equivalent to using the <code>assembly:attached</code> goal in conjunction with the
32   * <code>dir</code> assembly format. <br/>
33   * 
34   * <b>NOTE:</b> This goal should ONLY be run from the command line, and if building a multimodule project it should be
35   * used from the root POM. Use the <code>assembly:directory-single</code> goal for binding your assembly to the
36   * lifecycle.
37   * 
38   * @author <a href="mailto:jdcasey@apache.org">John Casey</a>
39   * @author <a href="mailto:gscokart@users.sourceforge.net">Gilles Scokart</a>
40   * @version $Id: DirectoryInlineMojo.java 999625 2010-09-21 20:40:39Z jdcasey $
41   * 
42   * @goal directory-inline
43   * @aggregator
44   * @inheritByDefault false
45   * @deprecated Use assembly:single and an assembly with format == dir instead! This mojo is redundant, and leads to
46   *             non-standard builds.
47   */
48  @Deprecated
49  public class DirectoryInlineMojo
50      extends AbstractDirectoryMojo
51  {
52      /**
53       * @parameter default-value="${project}"
54       * @required
55       * @readonly
56       */
57      private MavenProject project;
58  
59      @Override
60      public MavenProject getProject()
61      {
62          return project;
63      }
64  
65  }