org.reficio.p2.P2Artifact Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of p2-maven-plugin Show documentation
Maven plugin for the automation of jars wrapping and p2 site generation
The newest version!
/*
 * Copyright (c) 2012 Reficio (TM) - Reestablish your software! All Rights Reserved.
 *
 * 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.reficio.p2;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;

import java.util.ArrayList;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;

/**
 * Represents one <artifact> section in the plugin configuration.
 * This class is mutable only because the values are set by Maven using the setters.
 *
 * @author Tom Bujok ([email protected])

 *         Reficio (TM) - Reestablish your software!

 *         http://www.reficio.org
 * @since 1.0.0
 */
@SuppressFBWarnings({"EI_EXPOSE_REP2", "EI_EXPOSE_REP"})
public class P2Artifact {

    /**
     * Artifact id in the following format "groupId:artifactId:version"
     */
    private String id;

    /**
     * Indicator to include transitive dependencies
     */
    private boolean transitive = true;

    /**
     * Indicator to override default manifest
     */
    private boolean override = false;

    /**
     * Indicator to include source dependencies
     */
    private boolean source = false;

    /**
     * Indicator to generate a singleton bundle
     */
    private boolean singleton = false;

    /**
     * Specifies transitive dependencies that should be excluded
     */
    private List excludes = new ArrayList();

    /**
     * The BND instructions for the bundle.
     */
    private Map instructions = new LinkedHashMap();

    /**
     * The BND instructions for the bundle.
     * These properties complement {@link P2Artifact#instructions} with higher priority on duplicate keys.
     */
    private Properties instructionsProperties = new Properties();

    /**
     * Combined BND instructions for the bundle.
     */
    private Map combinedInstructions = new LinkedHashMap();

    private boolean shouldResetCombinedInstructions = true;

    public P2Artifact() {
    }

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public Map getInstructions() {
        return instructions;
    }

    public void setInstructions(Map instructions) {
        this.instructions = instructions;

        markCombinedInstructionsObsolete();
    }

    public boolean shouldIncludeTransitive() {
        return transitive;
    }

    public void setTransitive(boolean transitive) {
        this.transitive = transitive;
    }

    public boolean shouldOverrideManifest() {
        return override;
    }

    public void setOverride(boolean override) {
        this.override = override;
    }

    public void setSingleton(boolean singleton) {
        this.singleton = singleton;
    }

    public boolean isSingleton() {
        return singleton;
    }

    public boolean shouldIncludeSources() {
        return source;
    }

    public List getExcludes() {
        return excludes;
    }

    public void setExcludes(List excludes) {
        this.excludes = excludes;
    }

    public Properties getInstructionsProperties() {
        return instructionsProperties;
    }

    public void setInstructionsProperties(Properties instructionsProperties) {
        this.instructionsProperties = instructionsProperties;

        markCombinedInstructionsObsolete();
    }

    public Map getCombinedInstructions() {
        if (shouldResetCombinedInstructions) {
            resetCombinedInstructions();

            shouldResetCombinedInstructions = false;
        }

        return combinedInstructions;
    }

    private void markCombinedInstructionsObsolete() {
        shouldResetCombinedInstructions = true;
    }

    private void resetCombinedInstructions() {
        combinedInstructions = new LinkedHashMap();

        if (instructions != null)
            combinedInstructions.putAll(instructions);

        if (instructionsProperties != null) {
            for (String key : instructionsProperties.stringPropertyNames()) {
                combinedInstructions.put(key, instructionsProperties.getProperty(key));
            }
        }
    }
}