ResolvedFeature.java

/**********************************************************************
 * Copyright (c) 2005-2009 ant4eclipse project team.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Nils Hartmann, Daniel Kasmeroglu, Gerd Wuetherich
 **********************************************************************/
package org.ant4eclipse.lib.pde.tools;

import org.ant4eclipse.lib.core.Assure;
import org.ant4eclipse.lib.core.util.Pair;
import org.ant4eclipse.lib.pde.internal.tools.FeatureDescription;
import org.ant4eclipse.lib.pde.model.featureproject.FeatureManifest;
import org.ant4eclipse.lib.pde.model.featureproject.FeatureManifest.Includes;
import org.ant4eclipse.lib.pde.model.featureproject.FeatureManifest.Plugin;
import org.ant4eclipse.lib.platform.model.resource.EclipseProject;
import org.eclipse.osgi.service.resolver.BundleDescription;

import java.io.File;
import java.util.List;

public class ResolvedFeature {

  private Object                                   _source;

  private FeatureManifest                          _featureManifest;

  private List<Pair<Plugin, BundleDescription>>    _pluginToBundleDescptionList;

  private List<Pair<Includes, FeatureDescription>> _includesToFeatureDescriptionList;

  /**
   * <p>
   * Creates a new instance of type {@link ResolvedFeature}.
   * </p>
   * 
   * @param source
   *          the source of the fragment (an eclipse project, a jar file or a directory)
   * @param featureManifest
   *          the FeatureManifest
   */
  public ResolvedFeature(Object source, FeatureManifest featureManifest) {
    Assure.notNull("source", source);
    Assure.assertTrue(source instanceof EclipseProject || source instanceof File, String.format(
        "Feature source must be instance of %s or %s.", EclipseProject.class.getName(), File.class.getName()));
    Assure.notNull("featureManifest", featureManifest);
    this._featureManifest = featureManifest;
    this._source = source;
  }

  /**
   * <p>
   * Returns the source of the feature.
   * </p>
   * 
   * @return the source of the feature.
   */
  public Object getSource() {
    return this._source;
  }

  /**
   * <p>
   * Returns <code>true</code> if the source of the feature is an {@link EclipseProject}.
   * </p>
   * 
   * @return <code>true</code> if the source of the feature is an {@link EclipseProject}.
   */
  public boolean isEclipseProject() {
    return this._source instanceof EclipseProject;
  }

  /**
   * <p>
   * Returns <code>true</code> if the source of the feature is a directory.
   * </p>
   * 
   * @return <code>true</code> if the source of the feature is a directory.
   */
  public boolean isDirectory() {
    return this._source instanceof File && ((File) this._source).isDirectory();
  }

  /**
   * <p>
   * Returns <code>true</code> if the source of the feature is a file.
   * </p>
   * 
   * @return <code>true</code> if the source of the feature is a file.
   */
  public boolean isFile() {
    return this._source instanceof File && ((File) this._source).isFile();
  }

  /**
   * <p>
   * Returns the {@link FeatureManifest}.
   * </p>
   * 
   * @return the featureManifest
   */
  public FeatureManifest getFeatureManifest() {
    return this._featureManifest;
  }

  /**
   * <p>
   * Returns the list with the plug-in / bundle description pairs.
   * </p>
   * 
   * @return the pluginToBundleDescptionList
   */
  public List<Pair<Plugin, BundleDescription>> getPluginToBundleDescptionList() {
    return this._pluginToBundleDescptionList;
  }

  /**
   * <p>
   * </p>
   * 
   * @param pluginToBundleDescptionList
   *          the pluginToBundleDescptionList to set
   */
  public void setPluginToBundleDescptionList(List<Pair<Plugin, BundleDescription>> pluginToBundleDescptionList) {
    this._pluginToBundleDescptionList = pluginToBundleDescptionList;
  }

  /**
   * <p>
   * Returns the list with
   * </p>
   * 
   * @return the includesToFeatureDescriptionList
   */
  public List<Pair<Includes, FeatureDescription>> getIncludesToFeatureDescriptionList() {
    return this._includesToFeatureDescriptionList;
  }

  /**
   * <p>
   * </p>
   * 
   * @param includesToFeatureDescriptionList
   *          the includesToFeatureDescriptionList to set
   */
  public void setIncludesToFeatureDescriptionList(
      List<Pair<Includes, FeatureDescription>> includesToFeatureDescriptionList) {
    this._includesToFeatureDescriptionList = includesToFeatureDescriptionList;
  }

}