| <!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>RatLicenseFamily xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/rat/api/domain/RatLicenseFamily.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." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</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.api.domain; |
| <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> <strong class="jxr_keyword">static</strong> org.apache.rat.api.domain.LicenseFamilyBuilder.aLicenseFamily; |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> <em class="jxr_javadoccomment"> * Enumerates standard license families known to Rat.</em> |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">public</strong> enum <a href="../../../../../org/apache/rat/api/domain/RatLicenseFamily.html">RatLicenseFamily</a> { |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> APACHE( |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> <span class="jxr_string">"Apache License Version 2.0"</span>, |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <span class="jxr_string">"AL "</span>, |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> <span class="jxr_string">"Note that APACHE requires a NOTICE. All modifications require notes. See http://www.apache.org/licenses/LICENSE-2.0."</span>), |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> GPL1( |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <span class="jxr_string">"GNU General Public License, version 1"</span>, |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <span class="jxr_string">"GPL1 "</span>, |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> <span class="jxr_string">"Note that GPL1 requires a NOTICE. All modifications require notes. See http://www.gnu.org/licenses/gpl-1.0.html."</span>), |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> GPL2( |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <span class="jxr_string">"GNU General Public License, version 2"</span>, |
| <a class="jxr_linenumber" name="L38" href="#L38">38</a> <span class="jxr_string">"GPL2 "</span>, |
| <a class="jxr_linenumber" name="L39" href="#L39">39</a> <span class="jxr_string">"Note that GPL2 requires a NOTICE. All modifications require notes. See http://www.gnu.org/licenses/gpl-2.0.html."</span>), |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> GPL3( |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <span class="jxr_string">"GNU General Public License, version 3"</span>, |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> <span class="jxr_string">"GPL3 "</span>, |
| <a class="jxr_linenumber" name="L43" href="#L43">43</a> <span class="jxr_string">"Note that GPL3 requires a NOTICE. All modifications require notes. See http://www.gnu.org/licenses/gpl-3.0.html."</span>), |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> MIT( |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <span class="jxr_string">"The MIT License"</span>, |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> <span class="jxr_string">"MIT "</span>, |
| <a class="jxr_linenumber" name="L47" href="#L47">47</a> <span class="jxr_string">"Note that MIT requires a NOTICE. All modifications require notes. See http://opensource.org/licenses/MIT."</span>), |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> CDDL1( |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> <span class="jxr_string">"COMMON DEVELOPMENT AND DISTRIBUTION LICENSE Version 1.0"</span>, |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> <span class="jxr_string">"CDDL1"</span>, |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> <span class="jxr_string">"Note that CDDL1 requires a NOTICE. All modifications require notes. See https://oss.oracle.com/licenses/CDDL."</span>), |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> OASIS( |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> <span class="jxr_string">"OASIS Open License"</span>, |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> <span class="jxr_string">"OASIS"</span>, |
| <a class="jxr_linenumber" name="L55" href="#L55">55</a> <span class="jxr_string">"Note that OASIS requires a NOTICE. All modifications require notes. See https://www.oasis-open.org/policies-guidelines/ipr."</span>), |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> TMF854( |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> <span class="jxr_string">"Modified BSD License"</span>, |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> <span class="jxr_string">"TMF "</span>, |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> <span class="jxr_string">"Note that TMF854 requires a NOTICE. All modifications require notes. See http://opensource.org/licenses/BSD-3-Clause."</span>), |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> DOJO( |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> <span class="jxr_string">"Modified BSD License"</span>, |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> <span class="jxr_string">"DOJO "</span>, |
| <a class="jxr_linenumber" name="L63" href="#L63">63</a> <span class="jxr_string">"Note that DOJO requires a NOTICE. All modifications require notes. See http://dojotoolkit.org/community/licensing.shtml."</span>), |
| <a class="jxr_linenumber" name="L64" href="#L64">64</a> W3C( |
| <a class="jxr_linenumber" name="L65" href="#L65">65</a> <span class="jxr_string">"W3C Software Copyright"</span>, |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> <span class="jxr_string">"W3C "</span>, |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> <span class="jxr_string">"Note that W3C requires a NOTICE. All modifications require notes. See http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231."</span>), |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> W3C_DOCUMENTATION( |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> <span class="jxr_string">"W3C Document Copyright"</span>, |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> <span class="jxr_string">"W3CD "</span>, |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> <span class="jxr_string">"Note that W3CD does not allow modifications. See http://www.w3.org/Consortium/Legal/2002/copyright-documents-20021231."</span>); |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment">/** @see LicenseFamily#getName() */</em> |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String name; |
| <a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment">/** @see LicenseFamily#getCategory() */</em> |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String category; |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment">/** @see LicenseFamily#getNotes() */</em> |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String notes; |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment">/** Constructed from other data */</em> |
| <a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/rat/api/domain/LicenseFamily.html">LicenseFamily</a> licenseFamily; |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * Constructs an instance.</em> |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * @param name</em> |
| <a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> * not null</em> |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * @param category</em> |
| <a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * not null</em> |
| <a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * @param notes</em> |
| <a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * not null</em> |
| <a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/rat/api/domain/RatLicenseFamily.html">RatLicenseFamily</a>(<strong class="jxr_keyword">final</strong> String name, <strong class="jxr_keyword">final</strong> String category, |
| <a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">final</strong> String notes) { |
| <a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">this</strong>.name = name; |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">this</strong>.category = category; |
| <a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">this</strong>.notes = notes; |
| <a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">this</strong>.licenseFamily = aLicenseFamily().withCategory(getCategory()) |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> .withName(getName()).withNotes(getNotes()).build(); |
| <a class="jxr_linenumber" name="L100" href="#L100">100</a> } |
| <a class="jxr_linenumber" name="L101" href="#L101">101</a> |
| <a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * @see LicenseFamily#getName()</em> |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * @return not null</em> |
| <a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">public</strong> String getName() { |
| <a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.name; |
| <a class="jxr_linenumber" name="L109" href="#L109">109</a> } |
| <a class="jxr_linenumber" name="L110" href="#L110">110</a> |
| <a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * @see LicenseFamily#getCategory()</em> |
| <a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * @return possibly null</em> |
| <a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L116" href="#L116">116</a> <strong class="jxr_keyword">public</strong> String getCategory() { |
| <a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.category; |
| <a class="jxr_linenumber" name="L118" href="#L118">118</a> } |
| <a class="jxr_linenumber" name="L119" href="#L119">119</a> |
| <a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * @see LicenseFamily#getNotes()</em> |
| <a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * @return possibly null</em> |
| <a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">public</strong> String getNotes() { |
| <a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.notes; |
| <a class="jxr_linenumber" name="L127" href="#L127">127</a> } |
| <a class="jxr_linenumber" name="L128" href="#L128">128</a> |
| <a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * Gets a {@link LicenseFamily} representing this data.</em> |
| <a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * @return not null</em> |
| <a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/rat/api/domain/LicenseFamily.html">LicenseFamily</a> licenseFamily() { |
| <a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.licenseFamily; |
| <a class="jxr_linenumber" name="L136" href="#L136">136</a> } |
| <a class="jxr_linenumber" name="L137" href="#L137">137</a> } |
| </pre> |
| <hr/> |
| <div id="footer">Copyright © 2006–2016 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</div> |
| </body> |
| </html> |
