Skip to content

Commit 4659bd9

Browse files
committed
Add documentation for FileFilter
1 parent 944e73e commit 4659bd9

File tree

1 file changed

+11
-14
lines changed

1 file changed

+11
-14
lines changed
Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,23 @@
11
package dotty.tools.vulpix
22

3-
sealed trait FileFilter {
3+
/** FileFilter to accept or reject a file based on its name */
4+
sealed trait FileFilter:
5+
/** Accepts or rejects a file based on the file name */
46
def accept(file: String): Boolean
5-
}
67

7-
object FileFilter {
8-
def exclude(file: String): FileFilter = exclude(file :: Nil)
8+
/** Collection of FileFilters to use */
9+
object FileFilter:
910

10-
def exclude(file: String, files: String*): FileFilter =
11-
exclude(file :: files.toList)
12-
13-
def exclude(files: List[String]): FileFilter = new FileFilter {
11+
/** FileFilter that rejects the files passed in parameters */
12+
def exclude(files: List[String]): FileFilter = new FileFilter:
1413
private val blackList = files.toSet
1514
def accept(file: String): Boolean = !blackList.contains(file)
16-
}
1715

18-
def include(files: List[String]): FileFilter = new FileFilter {
16+
/** FileFilter that accepts only the files passed in parameters */
17+
def include(files: List[String]): FileFilter = new FileFilter:
1918
private val whiteList = files.toSet
2019
def accept(file: String): Boolean = whiteList.contains(file)
21-
}
2220

23-
object NoFilter extends FileFilter {
21+
/** FileFilter that accepts anytype of files */
22+
object NoFilter extends FileFilter:
2423
def accept(file: String) = true
25-
}
26-
}

0 commit comments

Comments
 (0)