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