blob: d9b02a5be7f65483c57a35a706746757a825cf34 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
/*
* Copyright 2000-2014 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.intellij.util.indexing;
import com.intellij.openapi.extensions.ExtensionPointName;
import com.intellij.openapi.fileTypes.FileType;
import com.intellij.util.io.DataExternalizer;
import com.intellij.util.io.KeyDescriptor;
import org.jetbrains.annotations.NotNull;
import java.util.Collection;
import java.util.Collections;
/**
* @author Eugene Zhuravlev
* Date: Dec 26, 2007
* V class MUST have equals / hashcode properly defined!!!
*/
public abstract class FileBasedIndexExtension<K, V> {
public static final ExtensionPointName<FileBasedIndexExtension> EXTENSION_POINT_NAME = ExtensionPointName.create("com.intellij.fileBasedIndex");
public static final int DEFAULT_CACHE_SIZE = 1024;
@NotNull
public abstract ID<K, V> getName();
@NotNull
public abstract DataIndexer<K, V, FileContent> getIndexer();
@NotNull
public abstract KeyDescriptor<K> getKeyDescriptor();
@NotNull
public abstract DataExternalizer<V> getValueExternalizer();
@NotNull
public abstract FileBasedIndex.InputFilter getInputFilter();
public abstract boolean dependsOnFileContent();
public boolean indexDirectories() {
return false;
}
public abstract int getVersion();
/**
* @see FileBasedIndexExtension#DEFAULT_CACHE_SIZE
*/
public int getCacheSize() {
return DEFAULT_CACHE_SIZE;
}
/**
* For most indices the method should return an empty collection.
* @return collection of file types to which file size limit will not be applied when indexing.
* This is the way to allow indexing of files whose limit exceeds FileManagerImpl.MAX_INTELLISENSE_FILESIZE.
*
* Use carefully, because indexing large files may influence index update speed dramatically.
*
* @see com.intellij.openapi.vfs.PersistentFSConstants#getMaxIntellisenseFileSize()
*/
@NotNull
public Collection<FileType> getFileTypesWithSizeLimitNotApplicable() {
return Collections.emptyList();
}
public boolean isKeyHighlySelective() {
return false;
}
public boolean traceKeyHashToVirtualFileMapping() {
return false;
}
public boolean hasSnapshotMapping() {
return false;
}
}
|
