Google Git
Sign in
apache / creadur-site / 884397342c3371df8a501072a271104b6416a3a1 / . / apache-rat-core / xref / org / apache / rat / analysis / license / BaseLicense.html
blob: b3fd6a42223dd1920aac70fabacb2db0e12fb987 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>BaseLicense xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/rat/analysis/license/BaseLicense.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one *</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file *</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information *</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file *</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the *</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance *</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at *</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * *</em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a> *</em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * *</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, *</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an *</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the *</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations *</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License. *</em>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.rat.analysis.license;
<a class="jxr_linenumber" name="L20" href="#L20">20</a>
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.rat.api.Document;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.rat.api.MetaData;
<a class="jxr_linenumber" name="L23" href="#L23">23</a>
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/rat/analysis/license/BaseLicense.html">BaseLicense</a> {
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">private</strong> String licenseFamilyCategory;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">private</strong> String licenseFamilyName;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">private</strong> String notes;
<a class="jxr_linenumber" name="L28" href="#L28">28</a>
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/rat/analysis/license/BaseLicense.html">BaseLicense</a>() {
<a class="jxr_linenumber" name="L30" href="#L30">30</a> }
<a class="jxr_linenumber" name="L31" href="#L31">31</a>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/rat/analysis/license/BaseLicense.html">BaseLicense</a>(<strong class="jxr_keyword">final</strong> MetaData.Datum licenseFamilyCategory, <strong class="jxr_keyword">final</strong> MetaData.Datum licenseFamilyName, <strong class="jxr_keyword">final</strong> String notes)
<a class="jxr_linenumber" name="L33" href="#L33">33</a> {
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">if</strong> (!MetaData.RAT_URL_LICENSE_FAMILY_CATEGORY.equals(licenseFamilyCategory.getName())) {
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"Expected "</span> + MetaData.RAT_URL_LICENSE_FAMILY_CATEGORY
<a class="jxr_linenumber" name="L36" href="#L36">36</a> + <span class="jxr_string">", got "</span> + licenseFamilyCategory.getName());
<a class="jxr_linenumber" name="L37" href="#L37">37</a> }
<a class="jxr_linenumber" name="L38" href="#L38">38</a> setLicenseFamilyCategory(licenseFamilyCategory.getValue());
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">if</strong> (!MetaData.RAT_URL_LICENSE_FAMILY_NAME.equals(licenseFamilyName.getName())) {
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"Expected "</span> + MetaData.RAT_URL_LICENSE_FAMILY_NAME
<a class="jxr_linenumber" name="L41" href="#L41">41</a> + <span class="jxr_string">", got "</span> + licenseFamilyName.getName());
<a class="jxr_linenumber" name="L42" href="#L42">42</a> }
<a class="jxr_linenumber" name="L43" href="#L43">43</a> setLicenseFamilyName(licenseFamilyName.getValue());
<a class="jxr_linenumber" name="L44" href="#L44">44</a> setNotes(notes);
<a class="jxr_linenumber" name="L45" href="#L45">45</a> }
<a class="jxr_linenumber" name="L46" href="#L46">46</a>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">public</strong> String getLicenseFamilyCategory() {
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">return</strong> licenseFamilyCategory;
<a class="jxr_linenumber" name="L49" href="#L49">49</a> }
<a class="jxr_linenumber" name="L50" href="#L50">50</a>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setLicenseFamilyCategory(String pDocumentCategory) {
<a class="jxr_linenumber" name="L52" href="#L52">52</a> licenseFamilyCategory = pDocumentCategory;
<a class="jxr_linenumber" name="L53" href="#L53">53</a> }
<a class="jxr_linenumber" name="L54" href="#L54">54</a>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">public</strong> String getLicenseFamilyName() {
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">return</strong> licenseFamilyName;
<a class="jxr_linenumber" name="L57" href="#L57">57</a> }
<a class="jxr_linenumber" name="L58" href="#L58">58</a>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setLicenseFamilyName(String pLicenseFamilyCategory) {
<a class="jxr_linenumber" name="L60" href="#L60">60</a> licenseFamilyName = pLicenseFamilyCategory;
<a class="jxr_linenumber" name="L61" href="#L61">61</a> }
<a class="jxr_linenumber" name="L62" href="#L62">62</a>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">public</strong> String getNotes() {
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">return</strong> notes;
<a class="jxr_linenumber" name="L65" href="#L65">65</a> }
<a class="jxr_linenumber" name="L66" href="#L66">66</a>
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setNotes(String pNotes) {
<a class="jxr_linenumber" name="L68" href="#L68">68</a> notes = pNotes;
<a class="jxr_linenumber" name="L69" href="#L69">69</a> }
<a class="jxr_linenumber" name="L70" href="#L70">70</a>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> reportOnLicense(<a href="../../../../../org/apache/rat/api/Document.html">Document</a> subject) {
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/rat/api/MetaData.html">MetaData</a> metaData = subject.getMetaData();
<a class="jxr_linenumber" name="L73" href="#L73">73</a> metaData.set(<strong class="jxr_keyword">new</strong> MetaData.Datum(MetaData.RAT_URL_HEADER_SAMPLE, notes));
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">final</strong> String licFamilyCategory = getLicenseFamilyCategory();
<a class="jxr_linenumber" name="L75" href="#L75">75</a> metaData.set(<strong class="jxr_keyword">new</strong> MetaData.Datum(MetaData.RAT_URL_HEADER_CATEGORY, licFamilyCategory));
<a class="jxr_linenumber" name="L76" href="#L76">76</a> metaData.set(<strong class="jxr_keyword">new</strong> MetaData.Datum(MetaData.RAT_URL_LICENSE_FAMILY_CATEGORY, licFamilyCategory));
<a class="jxr_linenumber" name="L77" href="#L77">77</a> metaData.set(<strong class="jxr_keyword">new</strong> MetaData.Datum(MetaData.RAT_URL_LICENSE_FAMILY_NAME, getLicenseFamilyName()));
<a class="jxr_linenumber" name="L78" href="#L78">78</a> }
<a class="jxr_linenumber" name="L79" href="#L79">79</a>
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String prune(String text) {
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> length = text.length();
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">final</strong> StringBuilder buffer = <strong class="jxr_keyword">new</strong> StringBuilder(length);
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; length; i++) {
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">char</strong> at = text.charAt(i);
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">if</strong> (Character.isLetterOrDigit(at)) {
<a class="jxr_linenumber" name="L86" href="#L86">86</a> buffer.append(at);
<a class="jxr_linenumber" name="L87" href="#L87">87</a> }
<a class="jxr_linenumber" name="L88" href="#L88">88</a> }
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">return</strong> buffer.toString();
<a class="jxr_linenumber" name="L90" href="#L90">90</a> }
<a class="jxr_linenumber" name="L91" href="#L91">91</a>
<a class="jxr_linenumber" name="L92" href="#L92">92</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2006&#x2013;2016 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>