Package com.buschmais.jqassistant.plugin.common.api.scanner

Class AbstractFileResolver

java.lang.Object

com.buschmais.jqassistant.plugin.common.api.scanner.AbstractFileResolver

All Implemented Interfaces:

FileResolver

Direct Known Subclasses:

ContainerFileResolver, LocalFileSystemFileResolver

public abstract class AbstractFileResolver
extends Object
implements FileResolver

Abstract base class for FileResolvers.

Provides utility functionality.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractFileResolver(String cacheKey)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected <D extends FileDescriptor> D	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	require(String requiredPath, Class<D> type, ScannerContext context)	Resolve an existing descriptor from the given information.
protected <D extends FileDescriptor> D	toFileDescriptor(Descriptor descriptor, Class<D> type, String path, ScannerContext context)	Deprecated. migrate to getOrCreateAs(String, Class, Function, ScannerContext).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.buschmais.jqassistant.plugin.common.api.scanner.FileResolver

match, require

Constructor Details

AbstractFileResolver

protected AbstractFileResolver(String cacheKey)

Constructor.

Parameters:

cacheKey - The cache key to use for the store.

Method Details

require

public <D extends FileDescriptor> D require(String requiredPath,
 Class<D> type,
 ScannerContext context)

Description copied from interface: FileResolver

Resolve an existing descriptor from the given information.

This is a convenience method delegating to FileResolver.require(String, Class, ScannerContext) using the value of path also as mappedPath.

Specified by:

require in interface FileResolver

Type Parameters:

D - The expected file descriptor type.

Parameters:

requiredPath - The path of the file to require, e.g. /com/acme/Example.class

type - The file descriptor type.

context - The scanner context.

Returns:

The resolved file descriptor.

toFileDescriptor

@Deprecated
protected <D extends FileDescriptor> D toFileDescriptor(Descriptor descriptor,
 Class<D> type,
 String path,
 ScannerContext context)

Deprecated.

migrate to getOrCreateAs(String, Class, Function, ScannerContext).

Takes an optional descriptor and transforms it to file descriptor.

Type Parameters:

D - The required type.

Parameters:

descriptor - The descriptor, if null a new descriptor is created.

type - The required type.

path - The path (to set as file name).

context - The scanner context.

Returns:

The file descriptor.

getOrCreateAs

protected <D extends FileDescriptor> D getOrCreateAs(String path,
 Class<D> type,
 Function<String,FileDescriptor> resolveExisting,
 ScannerContext context)

Get an existing FileDescriptor or create a new one. If an existing FileDescriptor exists it will be migrated on demand.

Type Parameters:

D - The requested type.

Parameters:

path - The path.

type - The requested type.

resolveExisting - A Function to resolve an existing FileDescriptor.

context - The ScannerContext.

Returns:

The FileDescriptor.