org.apache.maven.plugin.ContextEnabled Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of maven-plugin-api Show documentation

The API for plugins - Mojos - development.

There is a newer version: 4.0.0-rc-2

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.maven.plugin;

import java.util.Map;

/**
 * Interface to allow Mojos to communicate with each others Mojos, other than
 * project's source root and project's attachment.

 * The plugin manager would pull the context out of the plugin container context, and populate it into the Mojo.
 *
 * @author jdcasey
 */
public interface ContextEnabled {
    /**
     * Set a new shared context Map to a mojo before executing it.
     *
     * @param pluginContext a new Map
     */
    void setPluginContext(Map pluginContext);

    /**
     * @return a Map stored in the plugin container's context.
     */
    Map getPluginContext();
}