0.12-release/apache-rat-tasks/src/main/java/org/apache/rat/anttasks/SubstringLicenseMatcher.java

 /*
 * Licensed to the Apache Software Foundation (ASF) under one   *
 * or more contributor license agreements.  See the NOTICE file *
 * distributed with this work for additional information        *
 * regarding copyright ownership.  The ASF licenses this file   *
 * to you 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 org.apache.rat.anttasks;

import java.util.ArrayList;
import java.util.List;
import org.apache.rat.analysis.license.SimplePatternBasedLicense;
import org.apache.tools.ant.BuildException;

/**
 * Adapts {@link SimplePatternBasedLicense SimplePatternBasedLicense}
 * to Ant's method naming conventions so it becomes easy to write
 * substring based license matchers inside an Ant build file.
 * @since Rat Antlib 0.8
 */
public class SubstringLicenseMatcher extends SimplePatternBasedLicense {
    private List<String> patterns = new ArrayList<String>();
    private boolean validated = false;

    public void addConfiguredPattern(Pattern p) {
        patterns.add(p.getSubstring());
    }

    @Override
    public String[] getPatterns() {
        validate();
        return patterns.toArray(new String[0]);
    }

    private void validate() {
        if (!validated) {
            validated  = true;
            if (patterns.size() == 0) {
                throw new BuildException("You must specify at least one nested"
                                         + " pattern.");
            }
            if (getLicenseFamilyCategory() == null) {
                throw new BuildException("The licenseFamilyCategory attribute"
                                         + " is required.");
            }
            if (getLicenseFamilyName() == null) {
                throw new BuildException("The licenseFamilyName attribute"
                                         + " is required.");
            }
        }
    }

    /**
     * A simple wrapper around a substring.
     */
    public static class Pattern {
        private String substring;
        public void setSubstring(String s) { substring = s; }
        public String getSubstring() { return substring; }
    }
}