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

Class ContainerFileResolver

java.lang.Object

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

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

All Implemented Interfaces:

FileResolver

public class ContainerFileResolver
extends AbstractFileResolver

A file resolver strategy for file containers.

Constructor Summary

Constructors

Constructor	Description
ContainerFileResolver(ScannerContext scannerContext, FileContainerDescriptor fileContainerDescriptor)

Method Summary

Modifier and Type	Method	Description
void	flush()	Flush the caches to the store.
<D extends FileDescriptor> D	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.
void	put(String path, FileDescriptor fileDescriptor)	Adds a file to the container.
<D extends FileDescriptor> D	require(String requiredPath, String containedPath, Class<D> type, ScannerContext context)	Resolve an existing file descriptor for the given paths.
int	size()	Returns the size of the container.

Methods inherited from class com.buschmais.jqassistant.plugin.common.api.scanner.AbstractFileResolver

getOrCreateAs, require, toFileDescriptor

Methods inherited from class java.lang.Object

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

Constructor Details

ContainerFileResolver

public ContainerFileResolver(ScannerContext scannerContext,
 FileContainerDescriptor fileContainerDescriptor)

Method Details

require

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

Description copied from interface: FileResolver

Resolve an existing file descriptor for the given paths.

This is usually done by evaluating the given path, e.g. if a path "com/buschmais/Test.class" is given a class file resolver might return an existing class descriptor with the fully qualified name "com.buschmais.Test" which has been created before as a referenced class.

Parameters:

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

containedPath - The internal path (e.g. within the the same artifact if applicable), e.g. /WEB-INF/classes/com/acme/Example.class

type - The file descriptor type.

context - The scanner context.

Returns:

The resolved file descriptor.

match

public <D extends FileDescriptor> D match(String containedPath,
 Class<D> type,
 ScannerContext context)

Description copied from interface: FileResolver

Match an existing descriptor in the store and return it with as the given type if it exists.

Example: A Java class might exist with a fully qualified name in the database. The implementation of this method should check if the given path can be transformed into a class name (i.e. replacing '/' with '.') that already exists as descriptor (i.e. node) and return it.

Type Parameters:

D - The expected type.

Parameters:

containedPath - The path.

type - The expected type.

context - The scanner context.

Returns:

The matching descriptor.

flush

public void flush()

Flush the caches to the store.

put

public void put(String path,
 FileDescriptor fileDescriptor)

Adds a file to the container.

Parameters:

path - The path of the file.

fileDescriptor - The file descriptor.

size

public int size()

Returns the size of the container.

Returns:

The size of the container.