Intro to org.cadixdev.licenser

org.cadixdev.licenser is a Java library for managing open-source licenses in your software projects. It provides a simple, easy-to-use API for identifying and applying licenses to your code.

Features

• Supports a wide variety of open-source licenses, including Apache 2.0, MIT, GPL, and more
• Can automatically detect and apply licenses based on code patterns and file headers
• Provides a simple API for applying licenses to your code programmatically
• Can generate license files for your projects based on the identified licenses

Getting Started

To use org.cadixdev.licenser in your project, add the following dependency to your build.gradle file:

dependencies {
    implementation 'org.cadixdev:licenser:1.0.0'
}

Once you have added the dependency, you can start using the API to apply licenses to your code. Here is an example of how to apply the Apache 2.0 license to your code:

// Create a new license header for the Apache 2.0 license
LicenseHeader license = LicenseHeaders.APACHE2;

// Apply the license to the specified file
LicenseApplicator.applyTo(file, license);

Automatic License Detection

org.cadixdev.licenser can also automatically detect and apply licenses based on code patterns and file headers. Here is an example of how to do that:

// Identify the license based on the file headers and contents
Optional<LicenseHeader> license = LicenseHeaderParser.parse(file);

// If a license was identified, apply it to the file
license.ifPresent(l -> LicenseApplicator.applyTo(file, l));

Generating License Files

Finally, org.cadixdev.licenser can also generate license files for your projects based on the identified licenses. Here is an example of how to do that:

// Identify the licenses used in the project
Set<LicenseHeader> licenses = LicenseHeaderParser.parseAll(sourceDir);

// Generate license files for each identified license
for (LicenseHeader license : licenses) {
    Path licenseFile = outputDir.resolve(license.getName() + ".txt");
    Files.write(licenseFile, license.toString().getBytes());
}

Conclusion

org.cadixdev.licenser is a powerful and flexible library for managing open-source licenses in your projects. With its simple API and automatic detection features, it makes it easy to ensure that your code is properly licensed and compliant with open-source standards. Give it a try today!