replaced <code></code> with more concise {@code}
[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.NotNull;
20 import org.jetbrains.annotations.Nullable;
21
22 /**
23  * Represents a source or exclude root under the content root of a module.
24  *
25  * @see ContentEntry#getSourceFolders()
26  * @see ContentEntry#getExcludeFolders()
27  * @author dsl
28  */
29 public interface ContentFolder extends Synthetic {
30   /**
31    * Returns the root file or directory for this root.
32    *
33    * @return the file or directory, or null if the source path is invalid.
34    */
35   @Nullable
36   VirtualFile getFile();
37
38   /**
39    * Returns the content entry to which this root belongs.
40    *
41    * @return this {@code ContentFolder}s {@link com.intellij.openapi.roots.ContentEntry}.
42    */
43   @NotNull
44   ContentEntry getContentEntry();
45
46   /**
47    * Returns the URL of the root file or directory for this root.
48    *
49    * @return the root file or directory URL.
50    */
51   @NotNull
52   String getUrl();
53 }