WorkspaceDelegate.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.delegate;

import java.io.File;

import org.ant4eclipse.ant.core.delegate.AbstractAntDelegate;
import org.ant4eclipse.ant.platform.core.WorkspaceComponent;
import org.ant4eclipse.lib.core.exception.Ant4EclipseException;
import org.ant4eclipse.lib.core.logging.A4ELogging;
import org.ant4eclipse.lib.core.service.ServiceRegistryAccess;
import org.ant4eclipse.lib.platform.PlatformExceptionCode;
import org.ant4eclipse.lib.platform.model.resource.Workspace;
import org.ant4eclipse.lib.platform.model.resource.workspaceregistry.DefaultEclipseWorkspaceDefinition;
import org.ant4eclipse.lib.platform.model.resource.workspaceregistry.WorkspaceRegistry;
import org.apache.tools.ant.ProjectComponent;

/**
 * <p>
 * Delegate class for ant4eclipse tasks, conditions and types that require a workspace.
 * </p>
 * 
 * @author Gerd Wütherich (gerd@gerd-wuetherich.de)
 */
public class WorkspaceDelegate extends AbstractAntDelegate implements WorkspaceComponent {

  /** the workspace directory (has to be defined in the ant build file) */
  private File      _workspaceDirectory;

  /** the workspace id **/
  private String    _workspaceId;

  /** the workspace instance */
  private Workspace _workspace;

  /**
   * <p>
   * Creates a new instance of type {@link WorkspaceDelegate}.
   * </p>
   * 
   * @param component
   *          the ant {@link ProjectComponent}
   */
  public WorkspaceDelegate(ProjectComponent component) {
    super(component);
  }

  /**
   * {@inheritDoc}
   */
  @Deprecated
  public final void setWorkspace(String workspace) {
    A4ELogging.warn("The attribute 'workspace' is deprecated. Please use 'workspaceDirectory' instead !");
    setWorkspaceDirectory(workspace);
  }

  /**
   * {@inheritDoc}
   */
  public final void setWorkspaceDirectory(String workspaceDirectory) {

    //
    if (workspaceDirectory != null && !workspaceDirectory.equals("")) {

      // create new file
      this._workspaceDirectory = new File(workspaceDirectory);

      // check if workspace directory exists
      if (!this._workspaceDirectory.exists()) {
        throw new Ant4EclipseException(PlatformExceptionCode.WORKSPACE_DIRECTORY_DOES_NOT_EXIST,
            this._workspaceDirectory);
      }
    }
  }

  /**
   * {@inheritDoc}
   */
  public final File getWorkspaceDirectory() {
    return this._workspaceDirectory;
  }

  /**
   * {@inheritDoc}
   */
  public final boolean isWorkspaceDirectorySet() {
    return this._workspaceDirectory != null && !this._workspaceDirectory.equals("");
  }

  /**
   * {@inheritDoc}
   */
  public void setWorkspaceId(String identifier) {

    this._workspaceId = identifier;

  }

  /**
   * {@inheritDoc}
   */
  public String getWorkspaceId() {
    return this._workspaceId;
  }

  /**
   * {@inheritDoc}
   */
  public boolean isWorkspaceIdSet() {
    return this._workspaceId != null && !this._workspaceId.equals("");
  }

  /**
   * {@inheritDoc}
   */
  public void requireWorkspaceDirectoryOrWorkspaceIdSet() {
    if (!(isWorkspaceDirectorySet() || isWorkspaceIdSet())) {
      throw new Ant4EclipseException(PlatformExceptionCode.MISSING_WORKSPACE_DIRECTORY_OR_WORKSPACE_ID);
    }
    if (isWorkspaceDirectorySet() && isWorkspaceIdSet()) {
      throw new Ant4EclipseException(PlatformExceptionCode.WORKSPACE_DIRECTORY_AND_WORKSPACE_ID_SET);
    }
  }

  /**
   * {@inheritDoc}
   */
  public final Workspace getWorkspace() {
    requireWorkspaceDirectoryOrWorkspaceIdSet();

    if (this._workspace == null) {

      if (!ServiceRegistryAccess.instance().getService(WorkspaceRegistry.class).containsWorkspace(getIdentifier())) {

        if (isWorkspaceDirectorySet()) {

          this._workspace = ServiceRegistryAccess.instance().getService(WorkspaceRegistry.class)
              .registerWorkspace(getIdentifier(), new DefaultEclipseWorkspaceDefinition(this._workspaceDirectory));

        } else {
          throw new Ant4EclipseException(PlatformExceptionCode.UNKNOWN_WORKSPACE_ID, getIdentifier());
        }

      } else {

        this._workspace = ServiceRegistryAccess.instance().getService(WorkspaceRegistry.class)
            .getWorkspace(getIdentifier());
      }
    }

    // return the Workspace instance
    return this._workspace;
  }

  /**
   * <p>
   * </p>
   */
  private final String getIdentifier() {

    //
    if (this._workspaceDirectory != null) {
      return this._workspaceDirectory.getAbsolutePath();
    } else {
      return this._workspaceId;
    }
  }
} /* ENDCLASS */