Index (plugin 0.2.0 API)

A B C D E F G H I L N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values

A

addCustomLanguage(String, File) - Method in class io.github.sergeloie.languagecheck.LanguageCheckExtension: Register a single custom language file under languageCode.
ALL - Enum constant in enum class io.github.sergeloie.languagecheck.scan.ScanMode: Every file under the project root, minus the exclusion lists (excludedFiles, excludedDirs, excludedExtensions).
AllFilesWalker - Class in io.github.sergeloie.languagecheck.scan: Walks a directory tree collecting relative file paths, pruning excluded directories and skipping excluded files via an ExclusionMatcher.
AllFilesWalker() - Constructor for class io.github.sergeloie.languagecheck.scan.AllFilesWalker
allows(int) - Method in class io.github.sergeloie.languagecheck.check.CharPolicy: True if the code point passes this policy.
apply(Project) - Method in class io.github.sergeloie.languagecheck.LanguageCheckPlugin
ASCII - Static variable in class io.github.sergeloie.languagecheck.check.PolicyFactory: Canonical pseudo-language: listing ascii among an extension's language codes makes the extension strict ASCII-only (no language ranges, no formatting characters).
asciiOnly() - Static method in class io.github.sergeloie.languagecheck.check.CharPolicy: Strict ASCII-only policy: no formatting characters, no language ranges.

B

build(LanguageCatalog, Map<String, Set<String>>, Set<String>) - Static method in class io.github.sergeloie.languagecheck.check.PolicyFactory

C

CharacterChecker - Class in io.github.sergeloie.languagecheck.check: Scans the decoded text of one file against a CharPolicy.
CharacterChecker() - Constructor for class io.github.sergeloie.languagecheck.check.CharacterChecker
CharPolicy - Class in io.github.sergeloie.languagecheck.check: Decides whether a Unicode code point is allowed in a checked file.
chars() - Method in class io.github.sergeloie.languagecheck.model.Language: Non-ASCII code-point ranges that define this language's alphabet.
check(String, CharPolicy, int) - Method in class io.github.sergeloie.languagecheck.check.CharacterChecker: Check text against policy.
checkedFiles() - Method in class io.github.sergeloie.languagecheck.check.ReportAccumulator
checkFile(File, String, CharPolicy, boolean, long, int, CharacterChecker, ReportAccumulator) - Static method in class io.github.sergeloie.languagecheck.check.FileChecker: Read and check a single file, updating the report accumulator.
CheckResult - Class in io.github.sergeloie.languagecheck.check: The outcome of CharacterChecker.check(java.lang.String, io.github.sergeloie.languagecheck.check.CharPolicy, int) for one file: a bounded list of detailed Violation samples plus the total violation count.
CheckResult(List<Violation>, int) - Constructor for class io.github.sergeloie.languagecheck.check.CheckResult
clean() - Static method in class io.github.sergeloie.languagecheck.check.CheckResult: A result with no violations.
code() - Method in class io.github.sergeloie.languagecheck.model.Language: Language code (ISO 639-1 / BCP 47 subtag, e.g.
codePoint() - Method in class io.github.sergeloie.languagecheck.check.Violation: The offending Unicode code point.
codes() - Method in class io.github.sergeloie.languagecheck.model.LanguageCatalog: All registered language codes (built-ins plus custom), insertion order.
contains(int) - Method in class io.github.sergeloie.languagecheck.model.Language: True if codePoint is in any of this language's ranges.
contains(int) - Method in class io.github.sergeloie.languagecheck.model.UnicodeRange: True if codePoint falls within this range (inclusive).

D

decodeUtf8(byte[], boolean) - Static method in class io.github.sergeloie.languagecheck.check.FileChecker: Decode bytes as UTF-8.
DEFAULT_TIMEOUT_SECONDS - Static variable in class io.github.sergeloie.languagecheck.scan.GitFileLister: Default timeout for the git subprocess, in seconds.
deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class io.github.sergeloie.languagecheck.model.UnicodeRangeDeserializer
display() - Method in class io.github.sergeloie.languagecheck.check.Violation: Human-readable form, e.g.

E

end() - Method in class io.github.sergeloie.languagecheck.model.UnicodeRange: Upper bound (inclusive).
equals(Object) - Method in class io.github.sergeloie.languagecheck.check.Violation
equals(Object) - Method in class io.github.sergeloie.languagecheck.model.UnicodeRange
ExclusionMatcher - Class in io.github.sergeloie.languagecheck.scan: Decides whether a file or directory is excluded from a scan.
ExclusionMatcher(Set<String>, Set<String>, Set<String>) - Constructor for class io.github.sergeloie.languagecheck.scan.ExclusionMatcher
ExtensionNormalizer - Class in io.github.sergeloie.languagecheck.scan: Single source of truth for normalizing file extensions.
extensionOf(String) - Static method in class io.github.sergeloie.languagecheck.scan.ExclusionMatcher: Lower-cased file extension of a relative path, without the dot.

F

fileChecked(String) - Method in class io.github.sergeloie.languagecheck.check.ReportAccumulator
FileChecker - Class in io.github.sergeloie.languagecheck.check: Low-level file checks: size guard, binary detection, UTF-8 decoding and policy evaluation.
FileScanner - Class in io.github.sergeloie.languagecheck.scan: Lists files for a given ScanMode, delegating to GitFileLister or AllFilesWalker.
forLanguages(List<Language>, LanguageCatalog) - Static method in class io.github.sergeloie.languagecheck.check.CharPolicy: Policy for a set of mapped languages: the union of their character ranges plus the catalog's shared formatting characters.
forLanguages(List<Language>, LanguageCatalog, boolean) - Static method in class io.github.sergeloie.languagecheck.check.CharPolicy: Policy for a set of mapped languages with explicit control over the global formatting list.
formatting() - Method in class io.github.sergeloie.languagecheck.model.LanguageCatalog: Global formatting code points (sorted, unique, int[]).
FORMATTING - Static variable in class io.github.sergeloie.languagecheck.check.PolicyFactory: Canonical pseudo-language: listing formatting among an extension's language codes enables the global formatting list for that extension, exactly like formattingExtensions.

G

getAsciiOnlyExtensions() - Method in class io.github.sergeloie.languagecheck.LanguageCheckTask
getCustomLanguages() - Method in class io.github.sergeloie.languagecheck.LanguageCheckExtension: User-supplied language files, keyed by language code.
getCustomLanguages() - Method in class io.github.sergeloie.languagecheck.LanguageCheckTask: User-supplied language files, keyed by language code.
getExcludedDirs() - Method in class io.github.sergeloie.languagecheck.LanguageCheckExtension: Relative directories whose whole subtrees are never scanned.
getExcludedDirs() - Method in class io.github.sergeloie.languagecheck.LanguageCheckTask
getExcludedExtensions() - Method in class io.github.sergeloie.languagecheck.LanguageCheckExtension: File extensions that are never scanned (without the leading dot).
getExcludedExtensions() - Method in class io.github.sergeloie.languagecheck.LanguageCheckTask
getExcludedFiles() - Method in class io.github.sergeloie.languagecheck.LanguageCheckExtension: Exact relative file paths that are never scanned.
getExcludedFiles() - Method in class io.github.sergeloie.languagecheck.LanguageCheckTask
getExtensionLanguages() - Method in class io.github.sergeloie.languagecheck.LanguageCheckTask
getFailOnViolation() - Method in class io.github.sergeloie.languagecheck.LanguageCheckExtension: True (default): fail the build when violations are found.
getFailOnViolation() - Method in class io.github.sergeloie.languagecheck.LanguageCheckTask
getFormattingExtensions() - Method in class io.github.sergeloie.languagecheck.LanguageCheckTask
getGitTimeoutSeconds() - Method in class io.github.sergeloie.languagecheck.LanguageCheckExtension: Timeout for the git ls-files subprocess in GIT scan mode, in seconds.
getGitTimeoutSeconds() - Method in class io.github.sergeloie.languagecheck.LanguageCheckTask: Timeout for the git ls-files subprocess (GIT scan mode), in seconds.
getMaxFileSize() - Method in class io.github.sergeloie.languagecheck.LanguageCheckExtension: Largest file (bytes) that is still scanned; larger files are skipped.
getMaxFileSize() - Method in class io.github.sergeloie.languagecheck.LanguageCheckTask
getMaxViolationsPerFile() - Method in class io.github.sergeloie.languagecheck.LanguageCheckExtension: Most detailed violations to collect per file in the report; the total count is always exact.
getMaxViolationsPerFile() - Method in class io.github.sergeloie.languagecheck.LanguageCheckTask
getProjectDirectory() - Method in class io.github.sergeloie.languagecheck.LanguageCheckTask: The project root directory, wired by the plugin at configuration time.
getReportFile() - Method in class io.github.sergeloie.languagecheck.LanguageCheckExtension: Where the task writes its report file.
getReportFile() - Method in class io.github.sergeloie.languagecheck.LanguageCheckTask
getScanMode() - Method in class io.github.sergeloie.languagecheck.LanguageCheckExtension: Which file set the scan covers - ScanMode.GIT or ScanMode.ALL.
getScanMode() - Method in class io.github.sergeloie.languagecheck.LanguageCheckTask
getUtf8ExemptExtensions() - Method in class io.github.sergeloie.languagecheck.LanguageCheckExtension: Extensions exempt from strict UTF-8 validation (their files are decoded leniently, e.g.
getUtf8ExemptExtensions() - Method in class io.github.sergeloie.languagecheck.LanguageCheckTask
GIT - Enum constant in enum class io.github.sergeloie.languagecheck.scan.ScanMode: Only files git knows about - tracked, staged, or untracked-but-not ignored (git ls-files --cached --others --exclude-standard).
GitFileLister - Class in io.github.sergeloie.languagecheck.scan: Lists the project files git knows about using git ls-files --cached --others --exclude-standard: tracked files, staged files, and untracked files that are not git-ignored.
GitFileLister(File) - Constructor for class io.github.sergeloie.languagecheck.scan.GitFileLister
GitFileLister(File, long) - Constructor for class io.github.sergeloie.languagecheck.scan.GitFileLister

H

hashCode() - Method in class io.github.sergeloie.languagecheck.check.Violation
hashCode() - Method in class io.github.sergeloie.languagecheck.model.UnicodeRange

I

io.github.sergeloie.languagecheck - package io.github.sergeloie.languagecheck
io.github.sergeloie.languagecheck.check - package io.github.sergeloie.languagecheck.check
io.github.sergeloie.languagecheck.model - package io.github.sergeloie.languagecheck.model
io.github.sergeloie.languagecheck.scan - package io.github.sergeloie.languagecheck.scan
isBinary(byte[]) - Static method in class io.github.sergeloie.languagecheck.check.FileChecker
isClean() - Method in class io.github.sergeloie.languagecheck.check.CheckResult: True if the file had no violations at all.
isExcludedDir(String) - Method in class io.github.sergeloie.languagecheck.scan.ExclusionMatcher: True if the directory at the normalized relative path relPath is named like an excluded directory (any path segment matches).
isExcludedFile(String) - Method in class io.github.sergeloie.languagecheck.scan.ExclusionMatcher: True if the file at the normalized relative path relPath must be skipped: exact file match, a directory-name match at any depth, or an excluded extension.
isFormattingCodePoint(int) - Method in class io.github.sergeloie.languagecheck.model.LanguageCatalog: True if codePoint is in the global formatting set.
isGitRepository() - Method in class io.github.sergeloie.languagecheck.scan.GitFileLister: True if projectDir looks like the root of a git working tree (a .git entry exists - a directory for a normal clone, a file for worktrees and submodules).

L

language(String) - Method in class io.github.sergeloie.languagecheck.model.LanguageCatalog: Look up a language by its code; returns null if not present.
Language - Class in io.github.sergeloie.languagecheck.model: A human language with its Unicode code-point alphabet.
LanguageCatalog - Class in io.github.sergeloie.languagecheck.model: Lazy registry of Language definitions plus the global formatting code points.
LanguageCheckExtension - Class in io.github.sergeloie.languagecheck: The languageCheck { ... } project extension: everything a user can configure for the language check.
LanguageCheckExtension() - Constructor for class io.github.sergeloie.languagecheck.LanguageCheckExtension
LanguageCheckPlugin - Class in io.github.sergeloie.languagecheck: Applies io.github.sergeloie.language-check.
LanguageCheckPlugin() - Constructor for class io.github.sergeloie.languagecheck.LanguageCheckPlugin
LanguageCheckTask - Class in io.github.sergeloie.languagecheck: The languageCheck verification task.
LanguageCheckTask() - Constructor for class io.github.sergeloie.languagecheck.LanguageCheckTask
languages() - Method in class io.github.sergeloie.languagecheck.model.LanguageCatalog: All languages, keyed by code.
line() - Method in class io.github.sergeloie.languagecheck.check.Violation: 1-based line number the violation occurred on.
list(File, ScanMode, ExclusionMatcher, long) - Static method in class io.github.sergeloie.languagecheck.scan.FileScanner
listFiles(File, ExclusionMatcher) - Method in class io.github.sergeloie.languagecheck.scan.AllFilesWalker: List all included files under root.
listRelativeFiles() - Method in class io.github.sergeloie.languagecheck.scan.GitFileLister: List all git-known files, relative to the project root.
load(Map<String, File>) - Static method in class io.github.sergeloie.languagecheck.model.LanguageCatalog: Catalog with the built-in languages plus user-supplied per-code files.
loadDefaults() - Static method in class io.github.sergeloie.languagecheck.model.LanguageCatalog: Catalog with only the built-in languages and formatting.

N

name() - Method in class io.github.sergeloie.languagecheck.model.Language: Human-readable name (e.g.
none() - Static method in class io.github.sergeloie.languagecheck.scan.ExclusionMatcher: A matcher that excludes nothing.
normalize(String) - Static method in class io.github.sergeloie.languagecheck.scan.ExtensionNormalizer: Normalize a single extension value; returns "" for null/blank.
normalizeSet(Set<String>) - Static method in class io.github.sergeloie.languagecheck.scan.ExtensionNormalizer: Normalize a set of extensions - trims, lower-cases, strips dots, drops empties and nulls.

O

of(int, int) - Static method in class io.github.sergeloie.languagecheck.model.UnicodeRange: Create a range from start to end (inclusive).

P

PolicyFactory - Class in io.github.sergeloie.languagecheck.check: Builds CharPolicy instances for each extension mapping.

R

ReportAccumulator - Class in io.github.sergeloie.languagecheck.check: Accumulates per-file results for the final report.
ReportAccumulator() - Constructor for class io.github.sergeloie.languagecheck.check.ReportAccumulator
ReportWriter - Class in io.github.sergeloie.languagecheck.check: Writes the human-readable languageCheck report file.
run() - Method in class io.github.sergeloie.languagecheck.LanguageCheckTask

S

samples() - Method in class io.github.sergeloie.languagecheck.check.CheckResult: The detailed violations (bounded by the run's sample cap).
ScanMode - Enum Class in io.github.sergeloie.languagecheck.scan: Which file set the languageCheck task scans.
setExtensions(List<String>, List<String>) - Method in class io.github.sergeloie.languagecheck.LanguageCheckExtension: Declarative mapping: assigns language codes (plus the optional formatting and ascii pseudo-languages) to each listed extension, fully replacing those extensions' previous configuration.
single(int) - Static method in class io.github.sergeloie.languagecheck.model.UnicodeRange: Create a single-codepoint "range".
size() - Method in class io.github.sergeloie.languagecheck.model.UnicodeRange: Number of code points in this range (end - start + 1).
skipped(String, String) - Method in class io.github.sergeloie.languagecheck.check.ReportAccumulator
skippedNotes() - Method in class io.github.sergeloie.languagecheck.check.ReportAccumulator
start() - Method in class io.github.sergeloie.languagecheck.model.UnicodeRange: Lower bound (inclusive).

T

toString() - Method in class io.github.sergeloie.languagecheck.check.Violation
toString() - Method in class io.github.sergeloie.languagecheck.model.UnicodeRange
total() - Method in class io.github.sergeloie.languagecheck.check.CheckResult: The exact total number of violations in the file.
totalViolations() - Method in class io.github.sergeloie.languagecheck.check.ReportAccumulator

U

UnicodeRange - Class in io.github.sergeloie.languagecheck.model: A Unicode code-point range [start, end] (inclusive).
UnicodeRange(int, int) - Constructor for class io.github.sergeloie.languagecheck.model.UnicodeRange
UnicodeRangeDeserializer - Class in io.github.sergeloie.languagecheck.model: Gson adapter that deserializes UnicodeRange from the JSON shape used inside a language's "ranges" array:
UnicodeRangeDeserializer() - Constructor for class io.github.sergeloie.languagecheck.model.UnicodeRangeDeserializer

V

valueOf(String) - Static method in enum class io.github.sergeloie.languagecheck.scan.ScanMode: Returns the enum constant of this class with the specified name.
values() - Static method in enum class io.github.sergeloie.languagecheck.scan.ScanMode: Returns an array containing the constants of this enum class, in the order they are declared.
Violation - Class in io.github.sergeloie.languagecheck.check: One disallowed character occurrence in a checked file.
Violation(int, int) - Constructor for class io.github.sergeloie.languagecheck.check.Violation
violationBlocks() - Method in class io.github.sergeloie.languagecheck.check.ReportAccumulator
violations(String, CheckResult) - Method in class io.github.sergeloie.languagecheck.check.ReportAccumulator

W

write(File, ScanMode, File, ReportAccumulator) - Static method in class io.github.sergeloie.languagecheck.check.ReportWriter

A B C D E F G H I L N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values