TeamProjectSetComponent.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.ant.platform.core;


import org.ant4eclipse.lib.platform.model.team.projectset.TeamProjectSet;
import org.apache.tools.ant.BuildException;

import java.io.File;

/**
 * <p>
 * Interface for all ant4eclipse tasks, conditions and types working with project sets.
 * </p>
 * 
 * @author Gerd Wütherich (gerd@gerd-wuetherich.de)
 */
public interface TeamProjectSetComponent {

  /**
   * <p>
   * Returns the {@link TeamProjectSet}.
   * </p>
   * 
   * @return the team project set.
   */
  TeamProjectSet getTeamProjectSet();

  /**
   * <p>
   * Sets the team project set file.
   * </p>
   * 
   * @param projectSet
   *          the team project set file.
   */
  void setTeamProjectSet(File projectSetFile);

  /**
   * <p>
   * Returns true if the project set has been set.
   * </p>
   * 
   * @return <code>true</code>, if the project set has been set.
   */
  boolean isTeamProjectSetSet();

  /**
   * <p>
   * Throws an {@link BuildException} if the team project set is not set.
   * </p>
   */
  void requireTeamProjectSetSet();
}