Package io.github.sergeloie.languagecheck.scan

Enum Class ScanMode

java.lang.Object

java.lang.Enum<ScanMode>

io.github.sergeloie.languagecheck.scan.ScanMode

All Implemented Interfaces:

Serializable, Comparable<ScanMode>, Constable

public enum ScanMode
extends Enum<ScanMode>

Which file set the languageCheck task scans.

See Also:

• GitFileLister
• AllFilesWalker

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Every file under the project root, minus the exclusion lists (excludedFiles, excludedDirs, excludedExtensions).
GIT	Only files git knows about - tracked, staged, or untracked-but-not ignored (git ls-files --cached --others --exclude-standard).

Method Summary

Modifier and Type	Method	Description
static ScanMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ScanMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

GIT

public static final ScanMode GIT

Only files git knows about - tracked, staged, or untracked-but-not ignored (git ls-files --cached --others --exclude-standard). Requires the project to be a git repository; skips build outputs and other upstream artifacts automatically via .gitignore.

ALL

public static final ScanMode ALL

Every file under the project root, minus the exclusion lists (excludedFiles, excludedDirs, excludedExtensions). Does not require git.

Method Details

values

public static ScanMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ScanMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null