api: annotate classes and interfaces from project model API as NonExtendable
[idea/community.git] / platform / projectModel-api / src / com / intellij / openapi / roots / SourceFolder.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 org.jetbrains.annotations.ApiStatus;
19 import org.jetbrains.annotations.NotNull;
20 import org.jetbrains.jps.model.module.JpsModuleSourceRoot;
21 import org.jetbrains.jps.model.module.JpsModuleSourceRootType;
22
23 /**
24  * Represents a source or test source root under the content root of a module.
25  *
26  * @author dsl
27  * @see ContentEntry#getSourceFolders()
28  */
29 @ApiStatus.NonExtendable
30 public interface SourceFolder extends ContentFolder {
31   /**
32    * Checks if this root is a production or test source root.
33    *
34    * @return true if this source root is a test source root, false otherwise.
35    */
36   boolean isTestSource();
37
38   /**
39    * Returns the package prefix for this source root.
40    *
41    * @return the package prefix, or an empty string if the root has no package prefix.
42    */
43   @NotNull
44   String getPackagePrefix();
45
46   /**
47    * Sets the package prefix for this source root.
48    *
49    * @param packagePrefix the package prefix, or an empty string if the root has no package prefix.
50    */
51   void setPackagePrefix(@NotNull String packagePrefix);
52
53   @NotNull
54   JpsModuleSourceRootType<?> getRootType();
55
56   @NotNull
57   JpsModuleSourceRoot getJpsElement();
58 }