update copyrights
[idea/community.git] / platform / lang-api / src / com / intellij / codeInsight / hint / DeclarationRangeHandler.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.codeInsight.hint;
18
19 import com.intellij.openapi.extensions.ExtensionPointName;
20 import com.intellij.openapi.util.TextRange;
21 import com.intellij.psi.PsiElement;
22 import com.intellij.util.MixinEP;
23 import org.jetbrains.annotations.NotNull;
24
25 /**
26  * Returns the subset of the text range of the specified element which is considered its declaration.
27  * For example, the declaration range of a method includes its modifiers, return type, name and
28  * parameter list.
29  */
30 public interface DeclarationRangeHandler<T extends PsiElement>{
31   ExtensionPointName<MixinEP<DeclarationRangeHandler>> EP_NAME = ExtensionPointName.create("com.intellij.declarationRangeHandler");
32
33   /**
34    * Returns the declaration range for the specified container.
35    * @param container the container
36    * @return the declaration range for it.
37    */
38   @NotNull
39   TextRange getDeclarationRange(@NotNull T container);
40 }