BundleInfo.java

/*
 *  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.ivy.osgi.core;

import java.util.ArrayList;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;

import org.apache.ivy.osgi.util.Version;

/**
 * Bundle info extracted from the bundle manifest.
 * 
 */
public class BundleInfo {

    public static final Version DEFAULT_VERSION = new Version(1, 0, 0, null);

    public static final String PACKAGE_TYPE = "package";

    public static final String BUNDLE_TYPE = "bundle";

    public static final String EXECUTION_ENVIRONMENT_TYPE = "ee";

    public static final String SERVICE_TYPE = "service";

    private String symbolicName;

    private String presentationName;

    private String id;

    private Version version;

    private Set<BundleRequirement> requirements = new LinkedHashSet<BundleRequirement>();

    private Set<BundleCapability> capabilities = new LinkedHashSet<BundleCapability>();

    private List<String> executionEnvironments = new ArrayList<String>();

    private String description;

    private String documentation;

    private String license;

    private Integer size;

    private boolean isSource = false;

    /** the symbolic name of the bundle it is source of */
    private String symbolicNameTarget;

    /** the version of the bundle it is source of */
    private Version versionTarget;

    private boolean hasInnerClasspath;

    private List<String> classpath;

    private List<BundleArtifact> artifacts = new ArrayList<BundleArtifact>();

    public BundleInfo(String name, Version version) {
        this.symbolicName = name;
        this.version = version;
    }

    public String toString() {
        StringBuffer builder = new StringBuffer();
        builder.append("BundleInfo [executionEnvironments=");
        builder.append(executionEnvironments);
        builder.append(", capabilities=");
        builder.append(capabilities);
        builder.append(", requirements=");
        builder.append(requirements);
        builder.append(", symbolicName=");
        builder.append(symbolicName);
        builder.append(", version=");
        builder.append(version);
        builder.append("]");
        if (symbolicNameTarget != null) {
            builder.append(" source of ");
            builder.append(symbolicNameTarget);
            builder.append("@");
            builder.append(versionTarget);
        }
        return builder.toString();
    }

    public String getSymbolicName() {
        return symbolicName;
    }

    public Version getVersion() {
        return version == null ? DEFAULT_VERSION : version;
    }

    public Version getRawVersion() {
        return version;
    }

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

    public String getId() {
        return id;
    }

    public void setPresentationName(String presentationName) {
        this.presentationName = presentationName;
    }

    public String getPresentationName() {
        return presentationName;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public String getDescription() {
        return description;
    }

    public void setDocumentation(String documentation) {
        this.documentation = documentation;
    }

    public String getDocumentation() {
        return documentation;
    }

    public void setLicense(String license) {
        this.license = license;
    }

    public String getLicense() {
        return license;
    }

    public void setSize(Integer size) {
        this.size = size;
    }

    public Integer getSize() {
        return size;
    }

    public void addRequirement(BundleRequirement requirement) {
        requirements.add(requirement);
    }

    public Set<BundleRequirement> getRequirements() {
        return requirements;
    }

    public void addCapability(BundleCapability capability) {
        capabilities.add(capability);
    }

    public Set<BundleCapability> getCapabilities() {
        return capabilities;
    }

    public List<String> getExecutionEnvironments() {
        return executionEnvironments;
    }

    public void setExecutionEnvironments(List<String> executionEnvironments) {
        this.executionEnvironments = executionEnvironments;
        for (String executionEnvironment : executionEnvironments) {
            addRequirement(new BundleRequirement(EXECUTION_ENVIRONMENT_TYPE, executionEnvironment,
                    null, null));
        }
    }

    public void addExecutionEnvironment(String name) {
        executionEnvironments.add(name);
    }

    public void setSource(boolean isSource) {
        this.isSource = isSource;
    }

    public boolean isSource() {
        return isSource;
    }

    public void setSymbolicNameTarget(String symbolicNameTarget) {
        this.symbolicNameTarget = symbolicNameTarget;
    }

    public String getSymbolicNameTarget() {
        return symbolicNameTarget;
    }

    public void setVersionTarget(Version versionTarget) {
        this.versionTarget = versionTarget;
    }

    public Version getVersionTarget() {
        return versionTarget;
    }

    public void setHasInnerClasspath(boolean hasInnerClasspath) {
        this.hasInnerClasspath = hasInnerClasspath;
    }

    public boolean hasInnerClasspath() {
        return hasInnerClasspath;
    }

    public void setClasspath(List<String> classpath) {
        this.classpath = classpath;
    }

    public List<String> getClasspath() {
        return classpath;
    }

    public void addArtifact(BundleArtifact artifact) {
        artifacts.add(artifact);
    }

    public void removeArtifact(BundleArtifact same) {
        artifacts.remove(same);
    }

    public List<BundleArtifact> getArtifacts() {
        return artifacts;
    }

    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result + ((capabilities == null) ? 0 : capabilities.hashCode());
        result = prime * result + ((requirements == null) ? 0 : requirements.hashCode());
        result = prime * result + ((symbolicName == null) ? 0 : symbolicName.hashCode());
        result = prime * result + ((version == null) ? 0 : version.hashCode());
        result = prime * result
                + ((executionEnvironments == null) ? 0 : executionEnvironments.hashCode());
        result = prime * result
                + ((symbolicNameTarget == null) ? 0 : symbolicNameTarget.hashCode());
        result = prime * result + ((versionTarget == null) ? 0 : versionTarget.hashCode());
        return result;
    }

    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (!(obj instanceof BundleInfo)) {
            return false;
        }
        BundleInfo other = (BundleInfo) obj;
        if (capabilities == null) {
            if (other.capabilities != null) {
                return false;
            }
        } else if (!capabilities.equals(other.capabilities)) {
            return false;
        }
        if (requirements == null) {
            if (other.requirements != null) {
                return false;
            }
        } else if (!requirements.equals(other.requirements)) {
            return false;
        }
        if (symbolicName == null) {
            if (other.symbolicName != null) {
                return false;
            }
        } else if (!symbolicName.equals(other.symbolicName)) {
            return false;
        }
        if (version == null) {
            if (other.version != null) {
                return false;
            }
        } else if (!version.equals(other.version)) {
            return false;
        }
        if (executionEnvironments == null) {
            if (other.executionEnvironments != null) {
                return false;
            }
        } else if (!executionEnvironments.equals(other.executionEnvironments)) {
            return false;
        }
        if (isSource != other.isSource) {
            return false;
        }
        if (symbolicNameTarget == null) {
            if (other.symbolicNameTarget != null) {
                return false;
            }
        } else if (!symbolicNameTarget.equals(other.symbolicNameTarget)) {
            return false;
        }
        if (versionTarget == null) {
            if (other.versionTarget != null) {
                return false;
            }
        } else if (!versionTarget.equals(other.versionTarget)) {
            return false;
        }
        if (hasInnerClasspath != other.hasInnerClasspath) {
            return false;
        }
        if (classpath == null) {
            if (other.classpath != null) {
                return false;
            }
        } else if (!classpath.equals(other.classpath)) {
            return false;
        }
        return true;
    }

    public Set<BundleRequirement> getRequires() {
        Set<BundleRequirement> set = new LinkedHashSet<BundleRequirement>();
        for (BundleRequirement requirement : requirements) {
            if (requirement.getType().equals(BUNDLE_TYPE)) {
                set.add(requirement);
            }
        }
        return set;
    }

    public Set<BundleRequirement> getImports() {
        Set<BundleRequirement> set = new LinkedHashSet<BundleRequirement>();
        for (BundleRequirement requirement : requirements) {
            if (requirement.getType().equals(PACKAGE_TYPE)) {
                set.add(requirement);
            }
        }
        return set;
    }

    public Set<ExportPackage> getExports() {
        Set<ExportPackage> set = new LinkedHashSet<ExportPackage>();
        for (BundleCapability capability : capabilities) {
            if (PACKAGE_TYPE.equals(capability.getType())) {
                set.add((ExportPackage) capability);
            }
        }
        return set;
    }

    public Set<BundleCapability> getServices() {
        Set<BundleCapability> set = new LinkedHashSet<BundleCapability>();
        for (BundleCapability capability : capabilities) {
            if (SERVICE_TYPE.equals(capability.getType())) {
                set.add(capability);
            }
        }
        return set;
    }

}