9dd197d64789a60d97e30cd16200f397e6fb7c87
[idea/community.git] / platform / core-api / src / com / intellij / openapi / roots / FileIndexFacade.java
1 /*
2  * Copyright 2000-2011 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.openapi.roots;
17
18 import com.intellij.openapi.project.Project;
19 import com.intellij.openapi.vfs.VirtualFile;
20
21 /**
22  * @author yole
23  */
24 public abstract class FileIndexFacade {
25   protected final Project myProject;
26
27   protected FileIndexFacade(final Project project) {
28     myProject = project;
29   }
30
31   public abstract boolean isInContent(VirtualFile file);
32   public abstract boolean isInSource(VirtualFile file);
33   public abstract boolean isInLibraryClasses(VirtualFile file);
34   public abstract boolean isExcludedFile(VirtualFile file);
35
36   /**
37    * Checks if <code>file</code> is an ancestor of <code>baseDir</code> and none of the files
38    * between them are excluded from the project.
39    *
40    * @param baseDir the parent directory to check for ancestry.
41    * @param child the child directory or file to check for ancestry.
42    * @return true if it's a valid ancestor, false otherwise.
43    */
44   public abstract boolean isValidAncestor(final VirtualFile baseDir, final VirtualFile child);
45 }