api: annotate classes and interfaces from project model API as NonExtendable
[idea/community.git] / platform / projectModel-api / src / com / intellij / openapi / roots / ContentFolder.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 package com.intellij.openapi.roots;
17
18 import com.intellij.openapi.vfs.VirtualFile;
19 import org.jetbrains.annotations.ApiStatus;
20 import org.jetbrains.annotations.NotNull;
21 import org.jetbrains.annotations.Nullable;
22
23 /**
24  * Represents a source or exclude root under the content root of a module.
25  *
26  * @see ContentEntry#getSourceFolders()
27  * @see ContentEntry#getExcludeFolders()
28  * @author dsl
29  */
30 @ApiStatus.NonExtendable
31 public interface ContentFolder extends Synthetic {
32   /**
33    * Returns the root file or directory for this root.
34    *
35    * @return the file or directory, or null if the source path is invalid.
36    */
37   @Nullable
38   VirtualFile getFile();
39
40   /**
41    * Returns the content entry to which this root belongs.
42    *
43    * @return this {@code ContentFolder}s {@link com.intellij.openapi.roots.ContentEntry}.
44    */
45   @NotNull
46   ContentEntry getContentEntry();
47
48   /**
49    * Returns the URL of the root file or directory for this root.
50    *
51    * @return the root file or directory URL.
52    */
53   @NotNull
54   String getUrl();
55 }