Uses of Interface
net.sourceforge.pmd.lang.document.FileId

Packages that use FileId

Package	Description
net.sourceforge.pmd.cpd	Token-based copy-paste detection.
net.sourceforge.pmd.lang.ast
net.sourceforge.pmd.lang.document	Contains types to model text files and handle operations on text.
net.sourceforge.pmd.lang.rule	Contains Rule and RuleSet related classes.
net.sourceforge.pmd.renderers
net.sourceforge.pmd.reporting	Logic about reporting: violations, suppression etc.

Uses of FileId in net.sourceforge.pmd.cpd

Methods in net.sourceforge.pmd.cpd that return types with arguments of type FileId

Modifier and Type	Method	Description
Map<FileId,Integer>	CPDReport.getNumberOfTokensPerFile()	Return a map containing the number of tokens by processed file.

Methods in net.sourceforge.pmd.cpd with parameters of type FileId

Modifier and Type	Method	Description
String	CPDReport.getDisplayName(FileId fileId)	Return the display name of the given file.

Uses of FileId in net.sourceforge.pmd.lang.ast

Methods in net.sourceforge.pmd.lang.ast that return FileId

Modifier and Type	Method	Description
@NonNull FileId	FileAnalysisException.getFileId()	The name of the file in which the error occurred.
FileId	Parser.ParserTask.getFileId()

Methods in net.sourceforge.pmd.lang.ast with parameters of type FileId

Modifier and Type	Method	Description
FileAnalysisException	FileAnalysisException.setFileId(FileId fileId)
LexException	LexException.setFileId(FileId fileId)	Replace the file name of this error.
static FileAnalysisException	FileAnalysisException.wrap(@NonNull FileId fileId, @NonNull String message, @NonNull Throwable cause)	Wraps the cause into an analysis exception.

Constructors in net.sourceforge.pmd.lang.ast with parameters of type FileId

Modifier	Constructor	Description
	LexException(int line, int column, @Nullable FileId filename, String message, @Nullable Throwable cause)	Create a new exception.

Uses of FileId in net.sourceforge.pmd.lang.document

Fields in net.sourceforge.pmd.lang.document declared as FileId

Modifier and Type	Field	Description
protected FileId	TextFileBuilder.parentFsId
static final FileId	FileId.STDIN	The virtual file ID for standard input.
static final FileId	FileId.UNKNOWN	The name used for an unknown file.

Methods in net.sourceforge.pmd.lang.document that return FileId

Modifier and Type	Method	Description
static FileId	FileId.asChildOf(FileId self, FileId parentFsPath)	Return a file ID whose methods behave the same as the first parameter, and whose getParentFsPath() returns the second parameter.
static FileId	FileId.fromAbsolutePath(String absPath, @Nullable FileId outer)	Return a file ID which interprets the first parameter as an absolute path.
static FileId	FileId.fromPath(Path path)	Return a file ID for the given path.
static FileId	FileId.fromPath(Path path, @Nullable FileId fsPath)	Return a new path id for the given path.
static FileId	FileId.fromPathLikeString(String str)	Return a path ID for the given string.
static FileId	FileId.fromURI(String uriStr)	Return a file ID for a URI.
FileId	FileLocation.getFileId()	File name of this position.
FileId	TextDocument.getFileId()	Returns TextFile.getFileId() for the text file backing this document.
FileId	TextFile.getFileId()	Returns an identifier for this file.
@Nullable FileId	FileId.getParentFsPath()	If this file is in a nested filesystem (eg a zip file), return the file ID of the container in the outer file system.

Methods in net.sourceforge.pmd.lang.document with parameters of type FileId

Modifier and Type	Method	Description
boolean	FileCollector.addSourceFile(FileId fileId, String sourceContents)	Add a text file given its contents and a name.
static FileId	FileId.asChildOf(FileId self, FileId parentFsPath)	Return a file ID whose methods behave the same as the first parameter, and whose getParentFsPath() returns the second parameter.
static TextFileBuilder	TextFile.builderForCharSeq(CharSequence charseq, FileId fileId, LanguageVersion languageVersion)	Returns a read-only TextFile reading from a string.
static TextFileBuilder	TextFile.builderForReader(Reader reader, FileId fileId, LanguageVersion languageVersion)	Returns a read-only builder reading from a reader.
static FileLocation	FileLocation.caret(FileId fileName, int line, int column)	Returns a new location that starts and ends at the same position.
default int	FileId.compareTo(FileId o)
static TextFile	TextFile.forCharSeq(CharSequence charseq, FileId fileId, LanguageVersion languageVersion)	Returns a read-only TextFile reading from a string.
static TextFile	TextFile.forReader(Reader reader, FileId fileId, LanguageVersion languageVersion)	Returns a read-only instance of this interface reading from a reader.
static FileId	FileId.fromAbsolutePath(String absPath, @Nullable FileId outer)	Return a file ID which interprets the first parameter as an absolute path.
static FileId	FileId.fromPath(Path path, @Nullable FileId fsPath)	Return a new path id for the given path.
static FileLocation	FileLocation.range(FileId fileName, TextRange2d range2d)	Creates a new location for a range of text.
static TextDocument	TextDocument.readOnlyString(@NonNull CharSequence source, @NonNull FileId filename, @NonNull LanguageVersion lv)	Returns a read-only document for the given text.
TextFileBuilder	TextFileBuilder.setParentFsPath(@Nullable FileId fileId)

Method parameters in net.sourceforge.pmd.lang.document with type arguments of type FileId

Modifier and Type	Method	Description
void	FileCollector.setFileFilter(Predicate<FileId> fileFilter)	Sets an additional filter that is being called before adding the file to the list.

Uses of FileId in net.sourceforge.pmd.lang.rule

Methods in net.sourceforge.pmd.lang.rule with parameters of type FileId

Modifier and Type	Method	Description
static boolean	InternalApiBridge.ruleSetApplies(RuleSet ruleSet, FileId fileId)

Uses of FileId in net.sourceforge.pmd.renderers

Methods in net.sourceforge.pmd.renderers with parameters of type FileId

Modifier and Type	Method	Description
protected final String	AbstractRenderer.determineFileName(FileId fileId)	Determines the filename that should be used in the report for the given ID.

Uses of FileId in net.sourceforge.pmd.reporting

Methods in net.sourceforge.pmd.reporting that return FileId

Modifier and Type	Method	Description
FileId	Report.ProcessingError.getFileId()
default FileId	RuleViolation.getFileId()	Return the ID of the file where the violation was found.

Methods in net.sourceforge.pmd.reporting with parameters of type FileId

Modifier and Type	Method	Description
String	ConfigurableFileNameRenderer.getDisplayName(@NonNull FileId fileId)
String	FileNameRenderer.getDisplayName(@NonNull FileId fileId)	Return a display name for the given file id.

Method parameters in net.sourceforge.pmd.reporting with type arguments of type FileId

Modifier and Type	Method	Description
default void	ListenerInitializer.setFilesToAnalyze(List<FileId> files)	Set the list of files that will be analyzed during this analysis.

Constructors in net.sourceforge.pmd.reporting with parameters of type FileId

Modifier	Constructor	Description
	ProcessingError(Throwable error, FileId file)	Creates a new processing error.