View Javadoc

1   package org.apache.maven.plugin;
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 java.util.Map;
23  
24  /**
25   * Interface to allow <code>Mojos</code> to communicate with each others <code>Mojos</code>, other than
26   * project's source root and project's attachment.
27   * <br/>
28   * The plugin manager would pull the context out of the plugin container context, and populate it into the Mojo.
29   *
30   * @author jdcasey
31   */
32  public interface ContextEnabled
33  {
34      /**
35       * Set a new shared context <code>Map</code> to a mojo before executing it.
36       *
37       * @param pluginContext a new <code>Map</code>
38       */
39      void setPluginContext( Map pluginContext );
40  
41      /**
42       * @return a <code>Map</code> stored in the plugin container's context.
43       */
44      Map getPluginContext();
45  }