View Javadoc
1   package org.apache.maven.plugin.announcement;
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.plugin.changes.AbstractChangesMojo;
23  import org.apache.maven.plugins.annotations.Parameter;
24  
25  /**
26   * Abstract superclass for announcement mojos.
27   *
28   * @version $Id: AbstractAnnouncementMojo.java 1685894 2015-06-16 19:29:09Z khmarbaise $
29   * @since 2.3
30   */
31  public abstract class AbstractAnnouncementMojo
32      extends AbstractChangesMojo
33  {
34      /**
35       * This will cause the execution to be run only at the top of a given module tree. That is, run in the project
36       * contained in the same folder where the mvn execution was launched.
37       *
38       * @since 2.3
39       */
40      @Parameter( property = "announcement.runOnlyAtExecutionRoot", defaultValue = "false" )
41      protected boolean runOnlyAtExecutionRoot;
42  }