View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one   *
3    * or more contributor license agreements.  See the NOTICE file *
4    * distributed with this work for additional information        *
5    * regarding copyright ownership.  The ASF licenses this file   *
6    * to you under the Apache License, Version 2.0 (the            *
7    * "License"); you may not use this file except in compliance   *
8    * with the License.  You may obtain a copy of the License at   *
9    *                                                              *
10   *   http://www.apache.org/licenses/LICENSE-2.0                 *
11   *                                                              *
12   * Unless required by applicable law or agreed to in writing,   *
13   * software distributed under the License is distributed on an  *
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
15   * KIND, either express or implied.  See the License for the    *
16   * specific language governing permissions and limitations      *
17   * under the License.                                           *
18   */ 
19  package org.apache.rat;
20  
21  import java.io.InputStream;
22  
23  import org.apache.rat.analysis.IHeaderMatcher;
24  import org.apache.rat.analysis.generation.GeneratedLicenseNotRequired;
25  import org.apache.rat.analysis.generation.JavaDocLicenseNotRequired;
26  import org.apache.rat.analysis.license.ApacheSoftwareLicense20;
27  import org.apache.rat.analysis.license.DojoLicenseHeader;
28  import org.apache.rat.analysis.license.OASISLicense;
29  import org.apache.rat.analysis.license.TMF854LicenseHeader;
30  import org.apache.rat.analysis.license.W3CDocLicense;
31  import org.apache.rat.analysis.license.W3CLicense;
32  import org.apache.rat.analysis.util.HeaderMatcherMultiplexer;
33  
34  
35  
36  /**
37   * Utility class that holds constants shared by the CLI tool and the Ant tasks.
38   */
39  public class Defaults {
40      /** no instances */
41      private Defaults() {}
42  
43      /**
44       * The standard liest of licenses to include in the reports.
45       */
46      public static final IHeaderMatcher[] DEFAULT_MATCHERS =
47          new IHeaderMatcher[] {
48              new ApacheSoftwareLicense20(),
49              new W3CLicense(), 
50              new W3CDocLicense(), 
51              new OASISLicense(),
52              new JavaDocLicenseNotRequired(), 
53              new GeneratedLicenseNotRequired(),
54              new DojoLicenseHeader(),
55              new TMF854LicenseHeader()
56      };
57      
58      public static final String PLAIN_STYLESHEET = "org/apache/rat/plain-rat.xsl";
59      
60      public static final InputStream getPlainStyleSheet() {
61          InputStream result = Defaults.class.getClassLoader().getResourceAsStream(Defaults.PLAIN_STYLESHEET);
62          return result;
63      }
64      
65      public static final InputStream getDefaultStyleSheet() {
66          InputStream result = getPlainStyleSheet();
67          return result;
68      }
69      
70      public static final IHeaderMatcher createDefaultMatcher() {
71          return new HeaderMatcherMultiplexer(Defaults.DEFAULT_MATCHERS);
72      }
73  }