IModuleExporter.java

/*******************************************************************************
 * Copyright (c) 2011 Gerd Wuetherich (gerd@gerd-wuetherich.de).
 * 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:
 *     Gerd Wuetherich (gerd@gerd-wuetherich.de) - initial API and implementation
 ******************************************************************************/
package org.bundlemaker.core.exporter;

import org.bundlemaker.core.resource.IModularizedSystem;
import org.bundlemaker.core.resource.IModule;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;

/**
 * <p>
 * Defines the interface for module exporter. A module exporter can export a single {@link IResourceModule} to an
 * external format.
 * </p>
 * <p>
 * Clients may implement this interface.
 * </p>
 * 
 * @author Gerd Wütherich (gerd@gerd-wuetherich.de)
 */
public interface IModuleExporter {

  /**
   * <p>
   * Returns <code>true</code> if this {@link IModuleExporter} can export the specified {@link IResourceModule}.
   * </p>
   * 
   * @param modularizedSystem
   *          the {@link IModularizedSystem}
   * @param module
   *          the {@link IResourceModule}
   * @param context
   *          the {@link IModuleExporterContext}
   * 
   * @return <code>true</code> if this {@link IModuleExporter} can export the specified {@link IResourceModule}.
   */
  boolean canExport(IModularizedSystem modularizedSystem, IModule module, IModuleExporterContext context);

  /**
   * <p>
   * Exports the specified {@link IResourceModule} to an external format.
   * </p>
   * 
   * @param modularizedSystem
   *          the {@link IModularizedSystem}
   * @param module
   *          the {@link IResourceModule}
   * @param context
   *          the {@link IModuleExporterContext}
   * @param progressMonitor
   *          the {@link IProgressMonitor} or null. This method does not invoke <tt>done</tt> on the progress monitor.
   *          It's up to the caller of this method to invoke <tt>done</tt>
   * 
   * @throws CoreException
   */
  void export(IModularizedSystem modularizedSystem, IModule module, IModuleExporterContext context,
      IProgressMonitor progressMonitor) throws CoreException;
}