📄 maptype.html
字号:
<!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>MapType xref</title><link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /></head><body><div id="overview"><a href="../../../../../apidocs/org/archive/crawler/settings/MapType.html">View Javadoc</a></div><pre><a name="1" href="#1">1</a> <em class="comment">/*<em class="comment"> MapType</em></em><a name="2" href="#2">2</a> <em class="comment"> *</em><a name="3" href="#3">3</a> <em class="comment"> * $Id: MapType.java,v 1.7 2006/08/11 20:36:42 gojomo Exp $</em><a name="4" href="#4">4</a> <em class="comment"> *</em><a name="5" href="#5">5</a> <em class="comment"> * Created on Jan 8, 2004</em><a name="6" href="#6">6</a> <em class="comment"> *</em><a name="7" href="#7">7</a> <em class="comment"> * Copyright (C) 2004 Internet Archive.</em><a name="8" href="#8">8</a> <em class="comment"> *</em><a name="9" href="#9">9</a> <em class="comment"> * This file is part of the Heritrix web crawler (crawler.archive.org).</em><a name="10" href="#10">10</a> <em class="comment"> *</em><a name="11" href="#11">11</a> <em class="comment"> * Heritrix is free software; you can redistribute it and/or modify</em><a name="12" href="#12">12</a> <em class="comment"> * it under the terms of the GNU Lesser Public License as published by</em><a name="13" href="#13">13</a> <em class="comment"> * the Free Software Foundation; either version 2.1 of the License, or</em><a name="14" href="#14">14</a> <em class="comment"> * any later version.</em><a name="15" href="#15">15</a> <em class="comment"> *</em><a name="16" href="#16">16</a> <em class="comment"> * Heritrix is distributed in the hope that it will be useful,</em><a name="17" href="#17">17</a> <em class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</em><a name="18" href="#18">18</a> <em class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</em><a name="19" href="#19">19</a> <em class="comment"> * GNU Lesser Public License for more details.</em><a name="20" href="#20">20</a> <em class="comment"> *</em><a name="21" href="#21">21</a> <em class="comment"> * You should have received a copy of the GNU Lesser Public License</em><a name="22" href="#22">22</a> <em class="comment"> * along with Heritrix; if not, write to the Free Software</em><a name="23" href="#23">23</a> <em class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</em><a name="24" href="#24">24</a> <em class="comment"> */</em><a name="25" href="#25">25</a> <strong>package</strong> <a href="../../../../org/archive/crawler/settings/package-summary.html">org.archive.crawler.settings</a>;<a name="26" href="#26">26</a> <a name="27" href="#27">27</a> <strong>import</strong> java.util.Iterator;<a name="28" href="#28">28</a> <strong>import</strong> java.util.List;<a name="29" href="#29">29</a> <a name="30" href="#30">30</a> <strong>import</strong> javax.management.AttributeNotFoundException;<a name="31" href="#31">31</a> <strong>import</strong> javax.management.InvalidAttributeValueException;<a name="32" href="#32">32</a> <a name="33" href="#33">33</a> <strong>import</strong> org.archive.crawler.settings.Constraint.FailedCheck;<a name="34" href="#34">34</a> <a name="35" href="#35">35</a> <em>/**<em>* This class represents a container of settings.</em></em><a name="36" href="#36">36</a> <em> *</em><a name="37" href="#37">37</a> <em> * This class is usually used to make it possible to have a dynamic number</em><a name="38" href="#38">38</a> <em> * of ModuleTypes like for instance a list of filters of different type.</em><a name="39" href="#39">39</a> <em> *</em><a name="40" href="#40">40</a> <em> * When this type is overridden on a per domain basis, the following</em><a name="41" href="#41">41</a> <em> * restrictions apply:</em><a name="42" href="#42">42</a> <em> * <ul></em><a name="43" href="#43">43</a> <em> * <li>Added elements is placed after the elements in the map it overrides.</em><a name="44" href="#44">44</a> <em> * <li>You can not remove elements from the map it overrides. If it is</em><a name="45" href="#45">45</a> <em> * necessary to be able to remove an element, this has to be done by</em><a name="46" href="#46">46</a> <em> * adding some disable feature to the modules referenced by the map. An</em><a name="47" href="#47">47</a> <em> * example of this is the enabled attribute on the</em><a name="48" href="#48">48</a> <em> * {@link org.archive.crawler.framework.Filter} class.</em><a name="49" href="#49">49</a> <em> * <li>All elements defined in maps that this map overrides might have their</em><a name="50" href="#50">50</a> <em> * settings changed, but the order can not be changed.</em><a name="51" href="#51">51</a> <em> * </ul></em><a name="52" href="#52">52</a> <em> *</em><a name="53" href="#53">53</a> <em> * @author John Erik Halse</em><a name="54" href="#54">54</a> <em> */</em><a name="55" href="#55">55</a> <strong>public</strong> <strong>class</strong> <a href="../../../../org/archive/crawler/settings/MapType.html">MapType</a> <strong>extends</strong> <a href="../../../../org/archive/crawler/settings/ComplexType.html">ComplexType</a> {<a name="56" href="#56">56</a> <em>/**<em>* The content type allowed for this map. */</em></em><a name="57" href="#57">57</a> <strong>private</strong> <strong>final</strong> <a href="../../../../org/archive/crawler/settings/Type.html">Type</a> definition;<a name="58" href="#58">58</a> <a name="59" href="#59">59</a> <em>/**<em>* Construct a new MapType object.</em></em><a name="60" href="#60">60</a> <em> *</em><a name="61" href="#61">61</a> <em> * @param name the name of this element.</em><a name="62" href="#62">62</a> <em> * @param description the description of the attribute.</em><a name="63" href="#63">63</a> <em> */</em><a name="64" href="#64">64</a> <strong>public</strong> <a href="../../../../org/archive/crawler/settings/MapType.html">MapType</a>(String name, String description) {<a name="65" href="#65">65</a> <strong>this</strong>(name, description, Object.<strong>class</strong>);<a name="66" href="#66">66</a> }<a name="67" href="#67">67</a> <a name="68" href="#68">68</a> <em>/**<em>* Construct a new MapType object.</em></em><a name="69" href="#69">69</a> <em> *</em><a name="70" href="#70">70</a> <em> * @param name the name of this element.</em><a name="71" href="#71">71</a> <em> * @param description the description of the attribute.</em><a name="72" href="#72">72</a> <em> * @param type the type allowed for this map</em><a name="73" href="#73">73</a> <em> */</em><a name="74" href="#74">74</a> <strong>public</strong> <a href="../../../../org/archive/crawler/settings/MapType.html">MapType</a>(String name, String description, Class type) {<a name="75" href="#75">75</a> <strong>super</strong>(name, description);<a name="76" href="#76">76</a> <strong>this</strong>.definition = <strong>new</strong> <a href="../../../../org/archive/crawler/settings/SimpleType.html">SimpleType</a>(<span class="string">"dummy"</span>, <span class="string">"dummy"</span>, <strong>null</strong>);<a name="77" href="#77">77</a> <strong>this</strong>.definition.setLegalValueType(type);<a name="78" href="#78">78</a> }<a name="79" href="#79">79</a> <a name="80" href="#80">80</a> <em>/**<em>* Add a new element to this map.</em></em><a name="81" href="#81">81</a> <em> *</em><a name="82" href="#82">82</a> <em> * @param settings the settings object for this method to have effect.</em><a name="83" href="#83">83</a> <em> * @param element the element to be added.</em><a name="84" href="#84">84</a> <em> * @return Element added.</em><a name="85" href="#85">85</a> <em> * @throws InvalidAttributeValueException</em><a name="86" href="#86">86</a> <em> */</em><a name="87" href="#87">87</a> <strong>public</strong> <a href="../../../../org/archive/crawler/settings/Type.html">Type</a> addElement(<a href="../../../../org/archive/crawler/settings/CrawlerSettings.html">CrawlerSettings</a> settings, <a href="../../../../org/archive/crawler/settings/Type.html">Type</a> element)<a name="88" href="#88">88</a> throws InvalidAttributeValueException {<a name="89" href="#89">89</a> settings = settings == <strong>null</strong> ? globalSettings() : settings;<a name="90" href="#90">90</a> <a name="91" href="#91">91</a> <strong>if</strong> (settings != globalSettings()) {<a name="92" href="#92">92</a> <strong>try</strong> {<a name="93" href="#93">93</a> getAttribute(settings, element.getName());<a name="94" href="#94">94</a> <em class="comment">// Element exist, throw an exception</em><a name="95" href="#95">95</a> <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<a name="96" href="#96">96</a> <span class="string">"Duplicate element: "</span> + element.getName());<a name="97" href="#97">97</a> <a name="98" href="#98">98</a> } <strong>catch</strong> (AttributeNotFoundException e) {<a name="99" href="#99">99</a> <em class="comment">// Element doesn't exist, ok to add</em><a name="100" href="#100">100</a> }<a name="101" href="#101">101</a> }<a name="102" href="#102">102</a> <a name="103" href="#103">103</a> <strong>if</strong> (!(element instanceof MapType)) {<a name="104" href="#104">104</a> <strong>return</strong> <strong>super</strong>.addElement(settings, element);<a name="105" href="#105">105</a> } <strong>else</strong> {<a name="106" href="#106">106</a> <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Nested maps are not allowed."</span>);<a name="107" href="#107">107</a> }<a name="108" href="#108">108</a> }<a name="109" href="#109">109</a> <a name="110" href="#110">110</a> <em>/**<em>* Remove an attribute from the map.</em></em><a name="111" href="#111">111</a> <em> *</em><a name="112" href="#112">112</a> <em> * @param settings the settings object for which this method has effect.</em><a name="113" href="#113">113</a> <em> * @param name name of the attribute to remove.</em><a name="114" href="#114">114</a> <em> * @return the element that was removed.</em><a name="115" href="#115">115</a> <em> * @throws AttributeNotFoundException is thrown if there is no attribute</em><a name="116" href="#116">116</a> <em> * with the submitted name.</em><a name="117" href="#117">117</a> <em> */</em><a name="118" href="#118">118</a> <strong>public</strong> Object removeElement(<a href="../../../../org/archive/crawler/settings/CrawlerSettings.html">CrawlerSettings</a> settings, String name)<a name="119" href="#119">119</a> throws AttributeNotFoundException {<a name="120" href="#120">120</a> settings = settings == <strong>null</strong> ? globalSettings() : settings;<a name="121" href="#121">121</a> <strong>return</strong> settings.getData(<strong>this</strong>).removeElement(name);<a name="122" href="#122">122</a> }<a name="123" href="#123">123</a> <a name="124" href="#124">124</a> <em>/**<em>* Move an attribute up one place in the list.</em></em><a name="125" href="#125">125</a> <em> *</em>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -