honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add javadocs for adding additional license types to the license headers 

check
This commit is contained in:
Ryan Ernst 2016-07-25 17:22:08 -07:00
parent 0e6bdd025d
commit c2c9b51732
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
buildSrc/src/main/groovy/org/elasticsearch/gradle/precommit/LicenseHeadersTask.groovy
View File

@ -64,6 +64,15 @@ public class LicenseHeadersTask extends AntTask {
} }
} }
/**
* Add a new license type.
*
* The license may be added to the {@link #approvedLicenses} using the {@code familyName}.
*
* @param categoryName A 5-character string identifier for the license
* @param familyName An expanded string name for the license
* @param pattern A pattern to search for, which if found, indicates a file contains the license
*/
public void additionalLicense(String categoryName, String familyName, String pattern) { public void additionalLicense(String categoryName, String familyName, String pattern) {
if (categoryName.length() != 5) { if (categoryName.length() != 5) {
throw new IllegalArgumentException("License category name must be exactly 5 characters, got ${categoryName}"); throw new IllegalArgumentException("License category name must be exactly 5 characters, got ${categoryName}");