Class SourcePathMatcher

java.lang.Object
com.google.errorprone.util.SourcePathMatcher
public final class SourcePathMatcher extends Object

Matcher for canonical source file paths supporting exact source file paths and directory prefixes.

Matches are evaluated against canonical repository/workspace-relative paths as returned by ASTHelpers.getSourcePath(CompilationUnitTree).

Supported Pattern Syntax

  • Exact file paths: Matches the exact relative path for a .java, .kt, or .kts source file (e.g., java/com/google/foo/Bar.java, java/com/google/foo/Bar.kt).
  • Directory prefixes: Trailing / matches any file in the directory hierarchy (e.g., java/com/google/foo/).

Patterns must be repository-relative and must not start with a leading /. Wildcards (*, ?) and regex grouping ((, )) are not supported. Multiple paths can be separated by | (e.g., java/foo/|javatests/foo/), allowing multiple paths to be combined into a single string constant.

  • Method Details

    • empty

      public static SourcePathMatcher empty()
      Returns an empty SourcePathMatcher.

    • create

      public static SourcePathMatcher create(String... pathPatterns)
      Creates a SourcePathMatcher from the given path patterns (exact file paths or directory prefixes ending with /).

    • create

      public static SourcePathMatcher create(Iterable<String> pathPatterns)
      Creates a SourcePathMatcher from the given path patterns (exact file paths or directory prefixes ending with /).

    • validate

      public static Optional<String> validate(Iterable<String> pathPatterns)
      Validates the given path patterns, returning an error message if any pattern is invalid, or Optional.empty() if all patterns are valid.

    • matches

      public boolean matches(String path)
      Returns true if the given path matches any of the patterns in this matcher.

    • matches

      public boolean matches(VisitorState state)
      Returns true if the compilation unit in state matches any of the patterns in this matcher.