replaced <code></code> with more concise {@code}
[idea/community.git] / platform / external-system-api / src / com / intellij / openapi / externalSystem / service / project / ExternalSystemProjectResolver.java
1 /*
2  * Copyright 2000-2013 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.intellij.openapi.externalSystem.service.project;
17
18 import com.intellij.openapi.externalSystem.model.DataNode;
19 import com.intellij.openapi.externalSystem.model.ExternalSystemException;
20 import com.intellij.openapi.externalSystem.model.project.ProjectData;
21 import com.intellij.openapi.externalSystem.model.settings.ExternalSystemExecutionSettings;
22 import com.intellij.openapi.externalSystem.model.task.ExternalSystemTaskId;
23 import com.intellij.openapi.externalSystem.model.task.ExternalSystemTaskNotificationListener;
24 import org.jetbrains.annotations.NotNull;
25 import org.jetbrains.annotations.Nullable;
26
27 /**
28  * Defines common interface for resolving external system project..
29  *
30  * @author Denis Zhdanov
31  * @since 4/9/13 3:53 PM
32  */
33 public interface ExternalSystemProjectResolver<S extends ExternalSystemExecutionSettings> {
34
35   /**
36    * Builds object-level representation of the external system config file contained at the given path.
37    *
38    * @param id            id of the current 'resolve project info' task
39    * @param projectPath   absolute path to the target external system config file
40    * @param isPreviewMode Indicates, that an implementation can not provide/resolve any external dependencies.
41    *                      Only project dependencies and local file dependencies may included on the modules' classpath.
42    *                      And should not include any 'heavy' tasks like not trivial code generations.
43    *                      It is supposed to be fast.
44    * @param settings      settings to use for the project resolving;
45    *                      {@code null} as indication that no specific settings are required
46    * @param listener      callback to be notified about the execution
47    * @return object-level representation of the target external system project;
48    * {@code null} if it's not possible to resolve the project due to the objective reasons
49    * @throws ExternalSystemException  in case when unexpected exception occurs during project info construction
50    * @throws IllegalArgumentException if given path is invalid
51    * @throws IllegalStateException    if it's not possible to resolve target project info
52    */
53   @Nullable
54   DataNode<ProjectData> resolveProjectInfo(@NotNull ExternalSystemTaskId id,
55                                            @NotNull String projectPath,
56                                            boolean isPreviewMode,
57                                            @Nullable S settings,
58                                            @NotNull ExternalSystemTaskNotificationListener listener)
59     throws ExternalSystemException, IllegalArgumentException, IllegalStateException;
60
61   /**
62    * @param taskId   id of the 'resolve project info' task
63    * @param listener callback to be notified about the cancellation
64    * @return true if the task execution was successfully stopped, false otherwise or if target external system does not support the task cancellation
65    */
66   boolean cancelTask(@NotNull ExternalSystemTaskId taskId, @NotNull ExternalSystemTaskNotificationListener listener);
67 }
68