replaced <code></code> with more concise {@code}
[idea/community.git] / platform / xdebugger-api / src / com / intellij / xdebugger / breakpoints / XBreakpointHandler.java
1 /*
2  * Copyright 2000-2009 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
17 package com.intellij.xdebugger.breakpoints;
18
19 import org.jetbrains.annotations.NotNull;
20
21 /**
22  * @author nik
23  */
24 public abstract class XBreakpointHandler<B extends XBreakpoint<?>> {
25   public static final XBreakpointHandler<?>[] EMPTY_ARRAY = new XBreakpointHandler<?>[0];
26   private final Class<? extends XBreakpointType<B, ?>> myBreakpointTypeClass;
27
28   protected XBreakpointHandler(@NotNull Class<? extends XBreakpointType<B, ?>> breakpointTypeClass) {
29     myBreakpointTypeClass = breakpointTypeClass;
30   }
31
32   public final Class<? extends XBreakpointType<B, ?>> getBreakpointTypeClass() {
33     return myBreakpointTypeClass;
34   }
35
36   /**
37    * Called when a breakpoint need to be registered in the debugging engine
38    * @param breakpoint breakpoint to register
39    */
40   public abstract void registerBreakpoint(@NotNull B breakpoint);
41
42   /**
43    * Called when a breakpoint need to be unregistered from the debugging engine
44    * @param breakpoint breakpoint to unregister
45    * @param temporary determines whether {@code breakpoint} is unregistered forever or it may be registered again. This parameter may
46    * be used for performance purposes. For example the breakpoint may be disabled rather than removed in the debugging engine if
47    * {@code temporary} is {@code true}
48    */
49   public abstract void unregisterBreakpoint(@NotNull B breakpoint, final boolean temporary);
50
51 }