lvcs-impl
[idea/community.git] / lang-api / src / com / intellij / codeInsight / lookup / LookupElement.java
1 /*
2  * Copyright 2000-2007 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.codeInsight.lookup;
17
18 import com.intellij.codeInsight.completion.InsertionContext;
19 import com.intellij.codeInsight.completion.PrefixMatcher;
20 import com.intellij.openapi.util.UserDataHolderBase;
21 import org.jetbrains.annotations.NotNull;
22 import org.jetbrains.annotations.Nullable;
23
24 import java.util.Collections;
25 import java.util.Set;
26
27 /**
28  * @author peter
29  */
30 public abstract class LookupElement extends UserDataHolderBase {
31   public static final LookupElement[] EMPTY_ARRAY = new LookupElement[0];
32   private PrefixMatcher myPrefixMatcher = PrefixMatcher.FALSE_MATCHER;
33
34   @NotNull
35   public abstract String getLookupString();
36
37   public Set<String> getAllLookupStrings() {
38     return Collections.singleton(getLookupString());
39   }
40
41   public boolean setPrefixMatcher(@NotNull final PrefixMatcher matcher) {
42     myPrefixMatcher = matcher;
43     return isPrefixMatched();
44   }
45
46   public final boolean isPrefixMatched() {
47     return myPrefixMatcher.prefixMatches(this);
48   }
49
50   @NotNull
51   public final PrefixMatcher getPrefixMatcher() {
52     return myPrefixMatcher;
53   }
54
55   @NotNull
56   public Object getObject() {
57     return this;
58   }
59
60   public void handleInsert(InsertionContext context) {
61   }
62
63   public AutoCompletionPolicy getAutoCompletionPolicy() {
64     return AutoCompletionPolicy.SETTINGS_DEPENDENT;
65   }
66
67   @Override
68   public String toString() {
69     return getLookupString();
70   }
71
72   public void renderElement(LookupElementPresentation presentation) {
73     presentation.setItemText(getLookupString());
74   }
75
76   public int getGrouping() {
77     return 0;
78   }
79
80   @Nullable
81   public <T> T as(Class<T> aClass) {
82     //noinspection unchecked
83     return aClass.isInstance(this) ? (T) this : null;
84   }
85 }