Class ProtoSourceResolver

java.lang.Object

io.github.ascopes.protobufmavenplugin.sources.ProtoSourceResolver

@Description("Discovers proto sources in various packaging formats on the file system")
@Named
final class ProtoSourceResolver
extends Object

Component that can index and resolve protobuf sources in a file tree.

In addition, it can discover sources within archives recursively. These results will be extracted to a location within the Maven build directory to enable protoc and other plugins to be able to view them without needing access to the Java NIO file system APIs.

Author:

Ashley Scopes

Field Summary

Fields

Modifier and Type	Field	Description
private final ConcurrentExecutor	concurrentExecutor
private static final org.slf4j.Logger	log
private static final Set<String>	POM_FILE_EXTENSIONS
private final TemporarySpace	temporarySpace
private static final Set<String>	ZIP_FILE_EXTENSIONS

Constructor Summary

Constructors

Constructor	Description
ProtoSourceResolver(ConcurrentExecutor concurrentExecutor, TemporarySpace temporarySpace)

Method Summary

Modifier and Type	Method	Description
private SourceListing	createSourceListing(Collection<Path> sourceFiles, Path rootPath)
private String	generateUniqueName(Path path)
private Path	getArchiveExtractionRoot()
private Optional<SourceListing>	resolveSources(Path rootPath, SourceGlobFilter filter)
(package private) Collection<SourceListing>	resolveSources(Collection<Path> rootPaths, SourceGlobFilter filter)
private Optional<SourceListing>	resolveSourcesWithinArchive(Path rootPath, SourceGlobFilter filter)
private Optional<SourceListing>	resolveSourcesWithinDirectory(Path rootPath, SourceGlobFilter filter)
private Optional<SourceListing>	resolveSourcesWithinFile(Path rootPath, SourceGlobFilter filter)

Methods inherited from class java.lang.Object

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

Field Details

POM_FILE_EXTENSIONS

private static final Set<String> POM_FILE_EXTENSIONS

ZIP_FILE_EXTENSIONS

private static final Set<String> ZIP_FILE_EXTENSIONS

log

private static final org.slf4j.Logger log

concurrentExecutor

private final ConcurrentExecutor concurrentExecutor

temporarySpace

private final TemporarySpace temporarySpace

Constructor Details

ProtoSourceResolver

@Inject
ProtoSourceResolver(ConcurrentExecutor concurrentExecutor,
 TemporarySpace temporarySpace)

Method Details

resolveSources

Collection<SourceListing> resolveSources(Collection<Path> rootPaths,
 SourceGlobFilter filter)

resolveSources

private Optional<SourceListing> resolveSources(Path rootPath,
 SourceGlobFilter filter)
                                        throws IOException

Throws:

IOException

resolveSourcesWithinFile

private Optional<SourceListing> resolveSourcesWithinFile(Path rootPath,
 SourceGlobFilter filter)
                                                  throws IOException

Throws:

IOException

resolveSourcesWithinArchive

private Optional<SourceListing> resolveSourcesWithinArchive(Path rootPath,
 SourceGlobFilter filter)
                                                     throws IOException

Throws:

IOException

resolveSourcesWithinDirectory

private Optional<SourceListing> resolveSourcesWithinDirectory(Path rootPath,
 SourceGlobFilter filter)
                                                       throws IOException

Throws:

IOException

createSourceListing

private SourceListing createSourceListing(Collection<Path> sourceFiles,
 Path rootPath)

getArchiveExtractionRoot

private Path getArchiveExtractionRoot()

generateUniqueName

private String generateUniqueName(Path path)