WorkspaceComponent.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.resource.Workspace;
import org.apache.tools.ant.BuildException;

import java.io.File;

/**
 * <p>
 * Interface for ant4eclipse tasks, conditions and types that require a {@link Workspace}.
 * </p>
 * <p>
 * E.g. if an ant task implements this interface, you are able to set a workspace on this task:
 * 
 * <pre>
 * <code>
 * <myTask workspace="c:/dev/workspace" />
 * </code>
 * </pre>
 * 
 * </p>
 * 
 * @author Gerd Wütherich (gerd@gerd-wuetherich.de)
 */
public interface WorkspaceComponent {

  /**
   * <p>
   * Sets the workspace directory.
   * </p>
   * 
   * @param workspace
   *          the workspace directory
   * 
   * @deprecated use {@link WorkspaceComponent#setWorkspaceDirectory(String)} instead. This method is for backward
   *             compatibility only.
   */
  @Deprecated
  void setWorkspace(String workspace);

  /**
   * <p>
   * Sets the workspace directory.
   * </p>
   * 
   * @param workspace
   *          the workspace directory
   */
  void setWorkspaceDirectory(String workspaceDirectory);

  /**
   * <p>
   * Returns the workspace directory.
   * </p>
   * 
   * @return the workspace directory.
   */
  File getWorkspaceDirectory();

  /**
   * <p>
   * Returns <code>true</code> if the workspace directory is set, <code>false</code> otherwise.
   * </p>
   * 
   * @return <code>true</code> if the workspace directory is set, <code>false</code> otherwise.
   */
  boolean isWorkspaceDirectorySet();

  /**
   * <p>
   * Sets the workspace id.
   * </p>
   * 
   * @param identifier
   */
  void setWorkspaceId(String identifier);

  String getWorkspaceId();

  boolean isWorkspaceIdSet();

  /**
   * <p>
   * Throws an {@link BuildException} if the workspace directory has not been set.
   * </p>
   */
  void requireWorkspaceDirectoryOrWorkspaceIdSet();

  /**
   * <p>
   * Returns the {@link Workspace} instance.
   * </p>
   * 
   * @return the {@link Workspace} instance.
   */
  Workspace getWorkspace();
}