com.intellij.openapi.project.Project Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core-api Show documentation
A packaging of the IntelliJ Community Edition core-api library. This is release number 1 of trunk branch 142.
The newest version!
/*
 * Copyright 2000-2013 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.intellij.openapi.project;

import com.intellij.openapi.components.ComponentManager;
import com.intellij.openapi.extensions.AreaInstance;
import com.intellij.openapi.vfs.VirtualFile;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

/**
 * An object representing IntelliJ project.

 *
 * To get all its modules, use {@link com.intellij.openapi.module.ModuleManager#getModules()}

 *
 * 
To iterate over all project source files and directories, use {@code com.intellij.openapi.roots.ProjectFileIndex.SERVICE.getInstance(project).iterateContent(iterator)}

 *
 * To get the list of all open projects, use {@link com.intellij.openapi.project.ProjectManager#getOpenProjects()}
 *
 */
public interface Project extends ComponentManager, AreaInstance {
  @NonNls String DIRECTORY_STORE_FOLDER = ProjectCoreUtil.DIRECTORY_BASED_PROJECT_DIR;

  /**
   * Returns a name ot the project. For a directory-based project it's an arbitrary string specified by user at project creation
   * or later in a project settings. For a file-based project it's a name of a project file without extension.
   *
   * @return project name
   */
  @NotNull
  @NonNls
  String getName();

  /**
   * Returns a project base directory - a parent directory of a .ipr file or .idea directory.

   * Returns null for default project.
   *
   * @return project base directory, or null for default project
   */
  VirtualFile getBaseDir();

  /**
   * Returns a system-dependent path to a project base directory (see {@linkplain #getBaseDir()}).

   * Returns null for default project.
   *
   * @return a path to a project base directory, or null for default project
   */
  @Nullable
  @NonNls
  String getBasePath();

  /**
   * Returns project descriptor file:
   * 
   *   path/to/project/project.ipr - for file-based projects
   *   path/to/project/.idea/misc.xml - for directory-based projects
   * 
   * Returns null for default project.
   *
   * @return project descriptor file, or null for default project
   */
  @Nullable
  VirtualFile getProjectFile();

  /**
   * Returns a system-dependent path to project descriptor file (see {@linkplain #getProjectFile()}).

   * Returns empty string ("") for default project.
   *
   * @return project descriptor file, or empty string for default project
   */
  @NotNull
  @NonNls
  String getProjectFilePath();

  /**
   * Returns presentable project path:
   * {@linkplain #getProjectFilePath()} for file-based projects, {@linkplain #getBasePath()} for directory-based ones.

   * * Returns null for default project.
   * Note: the word "presentable" here implies file system presentation, not a UI one.
   *
   * @return presentable project path
   */
  @Nullable
  @NonNls
  String getPresentableUrl();

  /**
   * Returns a workspace file:
   * 

   *   path/to/project/project.iws - for file-based projects
   *   path/to/project/.idea/workspace.xml - for directory-based ones
   * 
   * Returns null for default project.
   *
   * @return workspace file, or null for default project
   */
  @Nullable
  VirtualFile getWorkspaceFile();

  @NotNull
  @NonNls
  String getLocationHash();

  /**
   * Should be invoked under WriteAction.
   */
  void save();

  boolean isOpen();

  boolean isInitialized();

  boolean isDefault();
}