io.github.lukehutch.fastclasspathscanner.scanner.ClasspathResource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fast-classpath-scanner Show documentation
Uber-fast, ultra-lightweight Java classpath scanner. Scans the classpath by parsing the classfile binary format directly rather than by using reflection. See https://github.com/lukehutch/fast-classpath-scanner
There is a newer version: 4.0.0-beta-7
Show newest version
/*
 * This file is part of FastClasspathScanner.
 *
 * Author: Luke Hutchison
 *
 * Hosted at: https://github.com/lukehutch/fast-classpath-scanner
 *
 * --
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2016 Luke Hutchison
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without
 * limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial
 * portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
 * LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
 * EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
 * OR OTHER DEALINGS IN THE SOFTWARE.
 */
package io.github.lukehutch.fastclasspathscanner.scanner;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;

import io.github.lukehutch.fastclasspathscanner.matchprocessor.FileMatchContentsProcessor;
import io.github.lukehutch.fastclasspathscanner.matchprocessor.FileMatchContentsProcessorWithContext;
import io.github.lukehutch.fastclasspathscanner.matchprocessor.FileMatchProcessor;
import io.github.lukehutch.fastclasspathscanner.matchprocessor.FileMatchProcessorWithContext;
import io.github.lukehutch.fastclasspathscanner.matchprocessor.FilenameMatchProcessor;
import io.github.lukehutch.fastclasspathscanner.scanner.matchers.FileMatchProcessorAny;
import io.github.lukehutch.fastclasspathscanner.utils.ClasspathUtils;
import io.github.lukehutch.fastclasspathscanner.utils.FileUtils;
import io.github.lukehutch.fastclasspathscanner.utils.LogNode;

/** The combination of a classpath element and a relative path within this classpath element. */
public abstract class ClasspathResource {
    // TODO: moduleRef and classpathEltFile are mutually exclusive -- should probably create subclasses
    public final File classpathEltFile;
    public final ModuleRef moduleRef;
    public final String pathRelativeToClasspathElt;
    public final String pathRelativeToClasspathPrefix;
    public long inputStreamLength;

    protected ClasspathResource(final File classpathEltFile, final ModuleRef moduleRef,
            final String pathRelativeToClasspathElt, final String pathRelativeToClasspathPrefix) {
        this.classpathEltFile = classpathEltFile;
        this.moduleRef = moduleRef;
        this.pathRelativeToClasspathElt = pathRelativeToClasspathElt;
        this.pathRelativeToClasspathPrefix = pathRelativeToClasspathPrefix;
    }

    @Override
    public String toString() {
        return moduleRef != null ? "[module " + moduleRef.getModuleName() + "]/" + pathRelativeToClasspathElt
                : ClasspathUtils.getClasspathResourceURL(classpathEltFile, pathRelativeToClasspathElt).toString();
    }

    public abstract InputStream open() throws IOException;

    public long getInputStreamLength() {
        return inputStreamLength;
    }

    // TODO: turn FileMatchProcessors into abstract classes, and factor this dispatch out into a method of
    // FileMatchProcessorAny
    public void processFileMatch(final FileMatchProcessorAny fileMatchProcessor, final LogNode log)
            throws IOException {
        if (fileMatchProcessor instanceof FilenameMatchProcessor) {
            ((FilenameMatchProcessor) fileMatchProcessor).processMatch(
                    // classpathResource.open() is not called for FilenameMatchProcessors
                    classpathEltFile, pathRelativeToClasspathPrefix);
        } else if (fileMatchProcessor instanceof FileMatchProcessor) {
            try {
                InputStream inputStream = null;
                try {
                    inputStream = open();
                } catch (final IOException e) {
                    if (log != null) {
                        log.log("Exception while opening file " + this + ": " + e);
                    }
                }
                if (inputStream != null) {
                    ((FileMatchProcessor) fileMatchProcessor).processMatch(pathRelativeToClasspathPrefix,
                            inputStream, inputStreamLength);
                }
            } finally {
                close();
            }
        } else if (fileMatchProcessor instanceof FileMatchProcessorWithContext) {
            try {
                InputStream inputStream = null;
                try {
                    inputStream = open();
                } catch (final IOException e) {
                    if (log != null) {
                        log.log("Exception while opening file " + this + ": " + e);
                    }
                }
                if (inputStream != null) {
                    ((FileMatchProcessorWithContext) fileMatchProcessor).processMatch(classpathEltFile,
                            pathRelativeToClasspathPrefix, //
                            inputStream, //
                            inputStreamLength);
                }
            } finally {
                close();
            }
        } else {
            if (fileMatchProcessor instanceof FileMatchContentsProcessor) {
                try {
                    byte[] fileContent = null;
                    try {
                        fileContent = FileUtils.readAllBytes(/* inputStream = */ open(), inputStreamLength, log);
                    } catch (final IOException e) {
                        if (log != null) {
                            log.log("Exception while opening file " + this + ": " + e);
                        }
                    }
                    if (fileContent != null) {
                        ((FileMatchContentsProcessor) fileMatchProcessor)
                                .processMatch(pathRelativeToClasspathPrefix, fileContent);
                    }
                } finally {
                    close();
                }
            } else if (fileMatchProcessor instanceof FileMatchContentsProcessorWithContext) {
                try {
                    byte[] fileContent = null;
                    try {
                        fileContent = FileUtils.readAllBytes(/* inputStream = */ open(), inputStreamLength, log);
                    } catch (final IOException e) {
                        if (log != null) {
                            log.log("Exception while opening file " + this + ": " + e);
                        }
                    }
                    if (fileContent != null) {
                        ((FileMatchContentsProcessorWithContext) fileMatchProcessor).processMatch(classpathEltFile,
                                pathRelativeToClasspathPrefix, fileContent);
                    }
                } finally {
                    close();
                }
            } else {
                throw new RuntimeException(
                        "Unknown FileMatchProcessor type " + fileMatchProcessor.getClass().getName());
            }
        }
    }

    public abstract void close();
}