[core] Replace TextFile::pathId

[oowekyala]

Describe the PR

Replace the pathId and display name of TextFile with a FileId instance. This eliminates the confusion between both, because both were strings. It also allows renderers to pick more freely how to display the file name. For instance the Sarif renderer always requires URIs, however neither pathId or display name specify that they should be URIs. By default they use a FileNameRenderer (function FileId->String) which does the same relativization as we did before in the file collector. This also replaces RuleViolation::getFileName with RuleViolation::getFileId so that the id is given to renderers, and we don't hardcode a display method in the RuleViolation.

Related issues

• Relates to Fix relative windows paths in sarif report pmd-github-action#178, but now that's fixed not only in the github action

Ready?

• Added unit tests for fixed bug/feature
• Passing all unit tests
• Complete build ./mvnw clean verify passes (checked automatically by github actions)
• Added (in-code) documentation (if needed)

[oowekyala]

Note that this actually reverts #4464, or rather fixes the problem in another way. I think the better parameter order is file name then source contents, as it was already in PMD 7 until #4464. However the file name parameter doesn't have type string anymore but FileId, so that removes the possible confusion.

[pmd-test]

	1 Message
📖	Compared to master: This changeset changes 0 violations, introduces 0 new violations, 0 new errors and 0 new configuration errors, removes 0 violations, 0 errors and 0 configuration errors. Full report
✅	Compared to master: This changeset changes 6 violations, introduces 1 new violations, 1 new errors and 0 new configuration errors, removes 3 violations, 0 errors and 0 configuration errors. Full report
✅	Compared to master: This changeset changes 8 violations, introduces 1 new violations, 0 new errors and 0 new configuration errors, removes 1 violations, 0 errors and 0 configuration errors. Full report
✅	Compared to master: This changeset changes 10 violations, introduces 2 new violations, 0 new errors and 0 new configuration errors, removes 2 violations, 0 errors and 0 configuration errors. Full report

Generated by 🚫 Danger

[adangel]

Thanks!

I'll merge this now, as this affects many downstream libs/clients (maven-pmd-plugin, eclipse, potentially github-actions with sarif), so that we get out this breaking change early.