IModifiableModularizedSystem.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.internal.api.resource;

import java.util.Collection;
import java.util.List;

import org.bundlemaker.core.internal.modules.ChangeAction;
import org.bundlemaker.core.internal.modules.Group;
import org.bundlemaker.core.internal.modules.event.ModularizedSystemChangedListenerList;
import org.bundlemaker.core.internal.resource.ModuleIdentifier;
import org.bundlemaker.core.project.IMovableUnit;
import org.bundlemaker.core.resource.IModularizedSystem;
import org.bundlemaker.core.resource.IModule;
import org.bundlemaker.core.resource.IModuleIdentifier;
import org.bundlemaker.core.resource.ITransformation;
import org.bundlemaker.core.spi.modext.ICacheAwareModularizedSystem;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;

/**
 * <p>
 * </p>
 * 
 * @author Gerd Wütherich (gerd@gerd-wuetherich.de)
 */
public interface IModifiableModularizedSystem extends ICacheAwareModularizedSystem {

  /**
   * <p>
   * Creates a new IModifiableResourceModule and adds it to this {@link IModularizedSystem}.
   * </p>
   * 
   * @param moduleIdentifier
   *          the module identifier
   * @return
   */
  IModifiableModule createResourceModule(IModuleIdentifier moduleIdentifier);

  /**
   * <p>
   * </p>
   * 
   * @param moduleIdentifier
   * @param path
   * @return
   */
  IModifiableModule createResourceModule(ModuleIdentifier moduleIdentifier, IPath path);

  /**
   * <p>
   * Adds the given {@link IModifiableResourceModule} to this {@link IModularizedSystem}.
   * </p>
   * 
   * @param identifier
   * @param resourceModule
   */
  void addModule(IModule resourceModule);

  /**
   * <p>
   * Removes the module with the given {@link IModuleIdentifier}.
   * </p>
   * 
   * @param identifier
   *          the {@link IModuleIdentifier}.
   */
  void removeModule(IModuleIdentifier identifier);

  /**
   * <p>
   * Removes the given {@link IModule} from this {@link IModularizedSystem}.
   * </p>
   * 
   * @param module
   */
  void removeModule(IModule module);

  /**
   * <p>
   * Returns the {@link IModifiableResourceModule} with the given {@link IModuleIdentifier}.
   * </p>
   * 
   * @param moduleIdentifier
   * @return
   */
  IModifiableModule getModifiableResourceModule(IModuleIdentifier moduleIdentifier);

  /**
   * <p>
   * Returns all {@link IModifiableResourceModule IModifiableResourceModules} for this {@link IModularizedSystem}.
   * </p>
   * 
   * @return
   */
  Collection<IModifiableModule> getModifiableResourceModules();

  /**
   * <p>
   * </p>
   * 
   * @param append
   * @return
   */
  Group getGroup(IPath append);

  /**
   * <p>
   * </p>
   * 
   * @param absolutePath
   * @return
   */
  Group getOrCreateGroup(IPath absolutePath);

  /**
   * <p>
   * </p>
   * 
   * @param group
   */
  void removeGroup(Group group);

  /**
   * <p>
   * </p>
   * 
   * @param path
   */
  void removeGroup(IPath path);

  /**
   * <p>
   * </p>
   * 
   * @param monitor
   * @param transformations
   */
  void applyTransformations(IProgressMonitor monitor, List<ITransformation> transformations);

  /**
   * <p>
   * </p>
   * 
   * @param monitor
   * @param transformation
   */
  void applyTransformations(IProgressMonitor monitor, ITransformation... transformation);

  void movableUnitChanged(IMovableUnit movableUnit, IModule resourceModule, ChangeAction action);

  ModularizedSystemChangedListenerList getListenerList();
}