com.vertispan.j2cl.build.DefaultDiskCache Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2021 j2cl-maven-plugin authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.vertispan.j2cl.build;

import java.io.File;
import java.io.IOException;
import java.nio.file.Path;
import java.util.concurrent.Executor;

/**
 * Default implementation of the disk cache, with one directory per project name, and
 * various builds of tasks within that. The build directory itself will be named for
 * the hash of the inputs the task needs - the task type and name, the files that are
 * read from other tasks, and the configuration options that the task is using.
 */
public class DefaultDiskCache extends DiskCache {
    /**
     * Constructs a new disk cache using the specified directory. It is assumed that
     * this path will be entirely owned by this library (even if shared across processes),
     * and that its entire contents will exist on the same file system.
     * @param cacheDir the directory in which to build the cache
     * @param executor executor to submit notification that another task can proceed
     */
    public DefaultDiskCache(File cacheDir, Executor executor) throws IOException {
        super(cacheDir, executor);
    }

    @Override
    protected Path taskDir(String projectName, String hashString, String outputType) {
        return cacheDir.toPath().resolve(projectName.replaceAll("[^\\-_a-zA-Z0-9.]", "-")).resolve(hashString + "-" + outputType);
    }

    @Override
    protected Path successMarker(Path taskDir) {
        return taskDir.resolve("success");
    }

    @Override
    protected Path failureMarker(Path taskDir) {
        return taskDir.resolve("failure");
    }

    @Override
    protected Path logFile(Path taskDir) {
        return taskDir.resolve("output.log");
    }

    @Override
    protected Path outputDir(Path taskDir) {
        return taskDir.resolve("results");
    }

    @Override
    protected Path cacheSummary(Path taskDir) {
        return taskDir.resolve("cacheSummary.json");
    }
}