org.opendaylight.yangtools.yang2sources.plugin.FileState Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yang-maven-plugin Show documentation

This plugin is a wrapper for "yang to source code" generation. It can be configured by a set of third-party code generators and resource providers. For further info see available goals. Sample usage: TODO: add sample usage when finished

The newest version!

/*
 * Copyright (c) 2023 PANTHEON.tech, s.r.o. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.yangtools.yang2sources.plugin;

import static java.util.Objects.requireNonNull;

import java.io.File;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.attribute.BasicFileAttributes;
import org.eclipse.jdt.annotation.NonNull;

/**
 * Hash of a single file state. {@link #size()} corresponds to {@link BasicFileAttributes#size()}.
 */
record FileState(@NonNull String path, long size, int crc32) {
    /**
     * A simple interface describing the intended content of a file.
     */
    @FunctionalInterface
    interface FileContent {
        /**
         * Write the content of this file to specified {@link OutputStream}.
         *
         * @param out OutputStream to write to, guaranteed to be non-null
         * @throws IOException if any error occurs
         */
        void writeTo(@NonNull OutputStream out) throws IOException;
    }

    private static final int READ_BUFFER_SIZE = 8192;

    FileState {
        requireNonNull(path);
    }

    static @NonNull FileState ofFile(final File file) throws IOException {
        return ofFile(file.toPath());
    }

    static @NonNull FileState ofFile(final Path file) throws IOException {
        try (var cis = new CapturingInputStream(Files.newInputStream(file))) {
            // Essentially cis.readAllBytes() except we do not need the actual bytes
            final var bytes = new byte[READ_BUFFER_SIZE];
            while (cis.readNBytes(bytes, 0, READ_BUFFER_SIZE) != 0) {
                // Nothing else
            }
            return new FileState(file.toString(), cis.size(), cis.crc32c());
        }
    }

    static @NonNull FileState ofWrittenFile(final File file, final FileContent content) throws IOException {
        try (var out = new CapturingOutputStream(Files.newOutputStream(file.toPath()))) {
            content.writeTo(out);
            return new FileState(file.getPath(), out.size(), out.crc32c());
        }
    }
}