com.exasol.projectkeeper.LicenseNameReader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of project-keeper-core Show documentation

Project keeper is a tool that verifies and fixes project setups.

There is a newer version: 4.4.0

package com.exasol.projectkeeper;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;

import com.exasol.errorreporting.ExaError;

/**
 * This class reads the name of the license from the LICENSE file of a project.
 */
public class LicenseNameReader {

    /**
     * Read the name of the license (first line of LICENSE file).
     *
     * @param projectDir project directory
     * @return name of the license
     */
    public String readLicenseName(final Path projectDir) {
        final String licenseFile = readLicenseFile(projectDir);
        return getFirstLine(licenseFile);
    }

    private String getFirstLine(final String licenseFile) {
        return licenseFile.split("\n")[0].trim();
    }

    private String readLicenseFile(final Path projectDir) {
        try {
            return Files.readString(projectDir.resolve("LICENSE"));
        } catch (final IOException exception) {
            throw new IllegalStateException(ExaError.messageBuilder("F-PK-CORE-124").message(
                    "Failed to read LICENSE file. That's strange because it should have been created by the LicenseValidator.")
                    .ticketMitigation().toString(), exception);
        }
    }
}