org.fabric3.spi.contribution.Import Maven / Gradle / Ivy

Go to download
/*
* Fabric3
* Copyright (c) 2009-2011 Metaform Systems
*
* Fabric3 is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as
* published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version, with the
* following exception:
*
* Linking this software statically or dynamically with other
* modules is making a combined work based on this software.
* Thus, the terms and conditions of the GNU General Public
* License cover the whole combination.
*
* As a special exception, the copyright holders of this software
* give you permission to link this software with independent
* modules to produce an executable, regardless of the license
* terms of these independent modules, and to copy and distribute
* the resulting executable under terms of your choice, provided
* that you also meet, for each linked independent module, the
* terms and conditions of the license of that module. An
* independent module is a module which is not derived from or
* based on this software. If you modify this software, you may
* extend this exception to your version of the software, but
* you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version.
*
* Fabric3 is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU General Public License for more details.
*
* You should have received a copy of the
* GNU General Public License along with Fabric3.
* If not, see .
*/
package org.fabric3.spi.contribution;

import java.io.Serializable;
import java.net.URI;
import java.util.Map;

/**
 * A contribution import.
 *
 * @version $Rev: 10261 $ $Date: 2011-05-01 09:05:50 +0000 (Sun, 01 May 2011) $
 */
public interface Import extends Serializable {

    /**
     * A URI representing the import artifact location.
     *
     * @return a URI representing the import artifact location or null if no location was specified
     */
    URI getLocation();

    /**
     * Returns true if this import supports wiring to multiple exports.
     *
     * @return true if this import supports wiring to multiple exports.
     */
    boolean isMultiplicity();

    /**
     * True if this import must be resolved.
     *
     * @return true if this import must be resolved.
     */
    boolean isRequired();

    /**
     * Returns the collection of resolved exports for this import. The key corresponds to the exporting contribution URI and the value is the export
     * that satisfies the import.
     *
     * @return the collection of resolved exports for this import
     */
    Map getResolved();

    /**
     * Adds an export that satisfies the current import.
     *
     * @param contributionUri the exporting contribution URI
     * @param export          the export
     */
    void addResolved(URI contributionUri, Export export);

}