Uses of Interface
com.buschmais.jqassistant.plugin.common.api.model.FileDescriptor

Packages that use FileDescriptor

Package	Description
com.buschmais.jqassistant.plugin.common.api.model
com.buschmais.jqassistant.plugin.common.api.report
com.buschmais.jqassistant.plugin.common.api.scanner
com.buschmais.jqassistant.plugin.common.impl.scanner

Uses of FileDescriptor in com.buschmais.jqassistant.plugin.common.api.model

Subinterfaces of FileDescriptor in com.buschmais.jqassistant.plugin.common.api.model

Modifier and Type	Interface	Description
interface	ArchiveDescriptor
interface	ArtifactFileDescriptor	Describes an artifact as a file.
interface	DirectoryDescriptor
interface	GZipFileDescriptor
interface	TarArchiveDescriptor
interface	ZipArchiveDescriptor

Methods in com.buschmais.jqassistant.plugin.common.api.model that return types with arguments of type FileDescriptor

Modifier and Type	Method	Description
List<FileDescriptor>	FileContainerDescriptor.getContains()	Return the contained descriptors.
Set<FileDescriptor>	FileDescriptor.getParents()	Return the parents (directories, artifacts) containing this FileDescriptor.
List<FileDescriptor>	FileContainerDescriptor.getRequires()	Return the required descriptors.

Uses of FileDescriptor in com.buschmais.jqassistant.plugin.common.api.report

Methods in com.buschmais.jqassistant.plugin.common.api.report with parameters of type FileDescriptor

Modifier and Type	Method	Description
static Optional<ArtifactLocation>	FileSourceHelper.getParentLocation(FileDescriptor descriptor)
static Optional<FileLocation>	FileSourceHelper.getSourceLocation(FileDescriptor descriptor, Optional<Integer> startLine, Optional<Integer> endLine)

Uses of FileDescriptor in com.buschmais.jqassistant.plugin.common.api.scanner

Methods in com.buschmais.jqassistant.plugin.common.api.scanner with type parameters of type FileDescriptor

Modifier and Type	Method	Description
protected <D extends FileDescriptor> D	AbstractFileResolver.getOrCreateAs(String path, Class<D> type, Function<String,FileDescriptor> resolveExisting, ScannerContext context)	Get an existing FileDescriptor or create a new one.
<D extends FileDescriptor> D	ContainerFileResolver.match(String containedPath, Class<D> type, ScannerContext context)
<D extends FileDescriptor> D	FileResolver.match(String containedPath, Class<D> type, ScannerContext context)	Match an existing descriptor in the store and return it with as the given type if it exists.
<D extends FileDescriptor> D	LocalFileSystemFileResolver.match(String containedPath, Class<D> type, ScannerContext context)
<D extends FileDescriptor> D	AbstractFileResolver.require(String requiredPath, Class<D> type, ScannerContext context)
<D extends FileDescriptor> D	ContainerFileResolver.require(String requiredPath, String containedPath, Class<D> type, ScannerContext context)
<D extends FileDescriptor> D	FileResolver.require(String requiredPath, Class<D> type, ScannerContext context)	Resolve an existing descriptor from the given information.
<D extends FileDescriptor> D	FileResolver.require(String requiredPath, String containedPath, Class<D> type, ScannerContext context)	Resolve an existing file descriptor for the given paths.
<D extends FileDescriptor> D	LocalFileSystemFileResolver.require(String requiredPath, String containedPath, Class<D> type, ScannerContext context)
protected <D extends FileDescriptor> D	AbstractFileResolver.toFileDescriptor(Descriptor descriptor, Class<D> type, String path, ScannerContext context)	Deprecated. migrate to AbstractFileResolver.getOrCreateAs(String, Class, Function, ScannerContext).

Methods in com.buschmais.jqassistant.plugin.common.api.scanner with parameters of type FileDescriptor

Modifier and Type	Method	Description
void	ContainerFileResolver.put(String path, FileDescriptor fileDescriptor)	Adds a file to the container.

Method parameters in com.buschmais.jqassistant.plugin.common.api.scanner with type arguments of type FileDescriptor

Modifier and Type	Method	Description
protected <D extends FileDescriptor> D	AbstractFileResolver.getOrCreateAs(String path, Class<D> type, Function<String,FileDescriptor> resolveExisting, ScannerContext context)	Get an existing FileDescriptor or create a new one.

Uses of FileDescriptor in com.buschmais.jqassistant.plugin.common.impl.scanner

Methods in com.buschmais.jqassistant.plugin.common.impl.scanner that return FileDescriptor

Modifier and Type	Method	Description
FileDescriptor	FileResourceScannerPlugin.scan(FileResource item, String path, Scope scope, Scanner scanner)
FileDescriptor	FileScannerPlugin.scan(File file, String path, Scope scope, Scanner scanner)
FileDescriptor	URLScannerPlugin.scan(URL url, String path, Scope scope, Scanner scanner)