replaced <code></code> with more concise {@code}
[idea/community.git] / platform / xdebugger-api / src / com / intellij / xdebugger / XDebugProcessStarter.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.xdebugger;
17
18 import com.intellij.execution.ExecutionException;
19 import org.jetbrains.annotations.NotNull;
20
21 /**
22  * Factory class for {@link XDebugProcess} implementation. Used by {@link XDebuggerManager} to start a new debugging session
23  *
24  * @author nik
25  */
26 public abstract class XDebugProcessStarter {
27   /**
28    * Create a new instance of {@link XDebugProcess} implementation. Note that {@code session} isn't initialized when this method is
29    * called so in order to perform code depending on {@code session} parameter override {@link XDebugProcess#sessionInitialized} method
30    * @param session session to be passed to {@link XDebugProcess#XDebugProcess} constructor
31    * @return new {@link XDebugProcess} instance
32    */
33   @NotNull
34   public abstract XDebugProcess start(@NotNull XDebugSession session) throws ExecutionException;
35 }