Path annotation usage problems
Reports incorrect usage of path annotations.
This inspection detects cases where a string annotated with one path annotation is used in a context that expects a string with a different path annotation. It helps ensure proper usage of @MultiRoutingFileSystemPath and @NativePath annotations.
The inspection highlights the following issues:
When a string annotated with
@NativePathis used in a Path constructor or factory methodWhen a string annotated with
@NativePathis passed to a method parameter annotated with@MultiRoutingFileSystemPathWhen a string annotated with
@MultiRoutingFileSystemPathis passed to a method parameter annotated with@NativePathWhen a string literal is used in a context that expects either annotation
Quick fixes are provided to add the appropriate annotation where needed.
Locating this inspection
- By ID
Can be used to locate inspection in e.g. Qodana configuration files, where you can quickly enable or disable it, or adjust its settings.
PathAnnotationInspection- Via Settings dialog
Path to the inspection settings via IntelliJ Platform IDE Settings dialog, when you need to adjust inspection settings directly from your IDE.
This inspection helps prevent runtime errors that can occur when paths with different formats are used incorrectly. The @MultiRoutingFileSystemPath annotation is used for paths that should work across different file systems, while the @NativePath annotation is used for paths that are specific to the native file system.
Inspection ID: PathAnnotationInspection
Suppressing Inspection
You can suppress this inspection by placing the following comment marker before the code fragment where you no longer want messages from this inspection to appear:
More detailed instructions as well as other ways and options that you have can be found in the product documentation:
Inspection Details | |
|---|---|
By default bundled with: |