10
10
<a name="1" href="#1">1</a> <em class="comment">/*</em>
11
11
<a name="2" href="#2">2</a> <em class="comment"> * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//httpclient/src/java/org/apache/commons/httpclient/params/HttpParams.java,v 1.6 2004/05/13 04:01:22 mbecke Exp $</em>
12
<a name="3" href="#3">3</a> <em class="comment"> * $Revision: 155418 $</em>
13
<a name="4" href="#4">4</a> <em class="comment"> * $Date: 2005-02-26 08:01:52 -0500 (Sat, 26 Feb 2005) $</em>
12
<a name="3" href="#3">3</a> <em class="comment"> * $Revision: 480424 $</em>
13
<a name="4" href="#4">4</a> <em class="comment"> * $Date: 2006-11-29 06:56:49 +0100 (Wed, 29 Nov 2006) $</em>
14
14
<a name="5" href="#5">5</a> <em class="comment"> *</em>
15
15
<a name="6" href="#6">6</a> <em class="comment"> * ====================================================================</em>
16
16
<a name="7" href="#7">7</a> <em class="comment"> *</em>
17
<a name="8" href="#8">8</a> <em class="comment"> * Copyright 1999-2004 The Apache Software Foundation</em>
18
<a name="9" href="#9">9</a> <em class="comment"> *</em>
19
<a name="10" href="#10">10</a> <em class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em>
20
<a name="11" href="#11">11</a> <em class="comment"> * you may not use this file except in compliance with the License.</em>
21
<a name="12" href="#12">12</a> <em class="comment"> * You may obtain a copy of the License at</em>
22
<a name="13" href="#13">13</a> <em class="comment"> *</em>
23
<a name="14" href="#14">14</a> <em class="comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
24
<a name="15" href="#15">15</a> <em class="comment"> *</em>
25
<a name="16" href="#16">16</a> <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
26
<a name="17" href="#17">17</a> <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
27
<a name="18" href="#18">18</a> <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
28
<a name="19" href="#19">19</a> <em class="comment"> * See the License for the specific language governing permissions and</em>
29
<a name="20" href="#20">20</a> <em class="comment"> * limitations under the License.</em>
30
<a name="21" href="#21">21</a> <em class="comment"> * ====================================================================</em>
31
<a name="22" href="#22">22</a> <em class="comment"> *</em>
32
<a name="23" href="#23">23</a> <em class="comment"> * This software consists of voluntary contributions made by many</em>
33
<a name="24" href="#24">24</a> <em class="comment"> * individuals on behalf of the Apache Software Foundation. For more</em>
34
<a name="25" href="#25">25</a> <em class="comment"> * information on the Apache Software Foundation, please see</em>
35
<a name="26" href="#26">26</a> <em class="comment"> * <<a href="http://www.apache.org/" target="alexandria_uri">http://www.apache.org/</a>>.</em>
36
<a name="27" href="#27">27</a> <em class="comment"> *</em>
37
<a name="28" href="#28">28</a> <em class="comment"> */</em>
38
<a name="29" href="#29">29</a>
39
<a name="30" href="#30">30</a> <strong>package</strong> <a href="../../../../../org/apache/commons/httpclient/params/package-summary.html">org.apache.commons.httpclient.params</a>;
40
<a name="31" href="#31">31</a>
41
<a name="32" href="#32">32</a> <em>/**<em>*</em></em>
42
<a name="33" href="#33">33</a> <em> * This interface represents a collection of HTTP protocol parameters. Protocol parameters</em>
43
<a name="34" href="#34">34</a> <em> * may be linked together to form a hierarchy. If a particular parameter value has not been</em>
44
<a name="35" href="#35">35</a> <em> * explicitly defined in the collection itself, its value will be drawn from the parent </em>
45
<a name="36" href="#36">36</a> <em> * collection of parameters.</em>
46
<a name="37" href="#37">37</a> <em> * </em>
47
<a name="38" href="#38">38</a> <em> * @author <a href="<a href="mailto:oleg@ural.ru" target="alexandria_uri">mailto:oleg@ural.ru</a>">Oleg Kalnichevski</a></em>
48
<a name="39" href="#39">39</a> <em> * </em>
49
<a name="40" href="#40">40</a> <em> * @version $Revision: 155418 $</em>
50
<a name="41" href="#41">41</a> <em> *</em>
51
<a name="42" href="#42">42</a> <em> * @since 3.0</em>
52
<a name="43" href="#43">43</a> <em> */</em>
53
<a name="44" href="#44">44</a> <strong>public</strong> <strong>interface</strong> <a href="../../../../../org/apache/commons/httpclient/params/HttpParams.html">HttpParams</a> {
54
<a name="45" href="#45">45</a>
55
<a name="46" href="#46">46</a> <em>/**<em>* </em></em>
56
<a name="47" href="#47">47</a> <em> * Returns the parent collection that this collection will defer to</em>
57
<a name="48" href="#48">48</a> <em> * for a default value if a particular parameter is not explicitly </em>
58
<a name="49" href="#49">49</a> <em> * set in the collection itself</em>
59
<a name="50" href="#50">50</a> <em> * </em>
60
<a name="51" href="#51">51</a> <em> * @return the parent collection to defer to, if a particular parameter</em>
61
<a name="52" href="#52">52</a> <em> * is not explictly set in the collection itself.</em>
62
<a name="53" href="#53">53</a> <em> * </em>
63
<a name="54" href="#54">54</a> <em> * @see #setDefaults(HttpParams)</em>
64
<a name="55" href="#55">55</a> <em> */</em>
65
<a name="56" href="#56">56</a> <strong>public</strong> <a href="../../../../../org/apache/commons/httpclient/params/HttpParams.html">HttpParams</a> getDefaults();
66
<a name="57" href="#57">57</a>
67
<a name="58" href="#58">58</a> <em>/**<em>* </em></em>
68
<a name="59" href="#59">59</a> <em> * Assigns the parent collection that this collection will defer to</em>
69
<a name="60" href="#60">60</a> <em> * for a default value if a particular parameter is not explicitly </em>
70
<a name="61" href="#61">61</a> <em> * set in the collection itself</em>
71
<a name="62" href="#62">62</a> <em> * </em>
72
<a name="63" href="#63">63</a> <em> * @param params the parent collection to defer to, if a particular </em>
73
<a name="64" href="#64">64</a> <em> * parameter is not explictly set in the collection itself.</em>
74
<a name="65" href="#65">65</a> <em> * </em>
75
<a name="66" href="#66">66</a> <em> * @see #getDefaults()</em>
76
<a name="67" href="#67">67</a> <em> */</em>
77
<a name="68" href="#68">68</a> <strong>public</strong> <strong>void</strong> setDefaults(<strong>final</strong> <a href="../../../../../org/apache/commons/httpclient/params/HttpParams.html">HttpParams</a> params);
78
<a name="69" href="#69">69</a>
79
<a name="70" href="#70">70</a> <em>/**<em>* </em></em>
80
<a name="71" href="#71">71</a> <em> * Returns a parameter value with the given name. If the parameter is</em>
81
<a name="72" href="#72">72</a> <em> * not explicitly defined in this collection, its value will be drawn </em>
82
<a name="73" href="#73">73</a> <em> * from a higer level collection at which this parameter is defined.</em>
83
<a name="74" href="#74">74</a> <em> * If the parameter is not explicitly set anywhere up the hierarchy,</em>
84
<a name="75" href="#75">75</a> <em> * <tt>null</tt> value is returned. </em>
85
<a name="76" href="#76">76</a> <em> * </em>
86
<a name="77" href="#77">77</a> <em> * @param name the parent name.</em>
87
<a name="78" href="#78">78</a> <em> * </em>
88
<a name="79" href="#79">79</a> <em> * @return an object that represents the value of the parameter.</em>
89
<a name="80" href="#80">80</a> <em> * </em>
90
<a name="81" href="#81">81</a> <em> * @see #setParameter(String, Object)</em>
91
<a name="82" href="#82">82</a> <em> */</em>
92
<a name="83" href="#83">83</a> <strong>public</strong> Object getParameter(<strong>final</strong> String name);
93
<a name="84" href="#84">84</a>
94
<a name="85" href="#85">85</a> <em>/**<em>*</em></em>
95
<a name="86" href="#86">86</a> <em> * Assigns the value to the parameter with the given name</em>
96
<a name="87" href="#87">87</a> <em> * </em>
97
<a name="88" href="#88">88</a> <em> * @param name parameter name</em>
98
<a name="89" href="#89">89</a> <em> * @param value parameter value</em>
99
<a name="90" href="#90">90</a> <em> */</em>
100
<a name="91" href="#91">91</a> <strong>public</strong> <strong>void</strong> setParameter(<strong>final</strong> String name, <strong>final</strong> Object value);
101
<a name="92" href="#92">92</a>
102
<a name="93" href="#93">93</a> <em>/**<em>* </em></em>
103
<a name="94" href="#94">94</a> <em> * Returns a {@link Long} parameter value with the given name. </em>
104
<a name="95" href="#95">95</a> <em> * If the parameter is not explicitly defined in this collection, its </em>
105
<a name="96" href="#96">96</a> <em> * value will be drawn from a higer level collection at which this parameter </em>
106
<a name="97" href="#97">97</a> <em> * is defined. If the parameter is not explicitly set anywhere up the hierarchy,</em>
107
<a name="98" href="#98">98</a> <em> * the default value is returned. </em>
108
<a name="99" href="#99">99</a> <em> * </em>
109
<a name="100" href="#100">100</a> <em> * @param name the parent name.</em>
110
<a name="101" href="#101">101</a> <em> * @param defaultValue the default value.</em>
111
<a name="102" href="#102">102</a> <em> * </em>
112
<a name="103" href="#103">103</a> <em> * @return a {@link Long} that represents the value of the parameter.</em>
113
<a name="104" href="#104">104</a> <em> * </em>
114
<a name="105" href="#105">105</a> <em> * @see #setLongParameter(String, long)</em>
115
<a name="106" href="#106">106</a> <em> */</em>
116
<a name="107" href="#107">107</a> <strong>public</strong> <strong>long</strong> getLongParameter(<strong>final</strong> String name, <strong>long</strong> defaultValue);
117
<a name="108" href="#108">108</a>
118
<a name="109" href="#109">109</a> <em>/**<em>*</em></em>
119
<a name="110" href="#110">110</a> <em> * Assigns a {@link Long} to the parameter with the given name</em>
120
<a name="111" href="#111">111</a> <em> * </em>
121
<a name="112" href="#112">112</a> <em> * @param name parameter name</em>
122
<a name="113" href="#113">113</a> <em> * @param value parameter value</em>
123
<a name="114" href="#114">114</a> <em> */</em>
124
<a name="115" href="#115">115</a> <strong>public</strong> <strong>void</strong> setLongParameter(<strong>final</strong> String name, <strong>long</strong> value);
125
<a name="116" href="#116">116</a>
126
<a name="117" href="#117">117</a> <em>/**<em>* </em></em>
127
<a name="118" href="#118">118</a> <em> * Returns an {@link Integer} parameter value with the given name. </em>
128
<a name="119" href="#119">119</a> <em> * If the parameter is not explicitly defined in this collection, its </em>
129
<a name="120" href="#120">120</a> <em> * value will be drawn from a higer level collection at which this parameter </em>
130
<a name="121" href="#121">121</a> <em> * is defined. If the parameter is not explicitly set anywhere up the hierarchy,</em>
131
<a name="122" href="#122">122</a> <em> * the default value is returned. </em>
132
<a name="123" href="#123">123</a> <em> * </em>
133
<a name="124" href="#124">124</a> <em> * @param name the parent name.</em>
134
<a name="125" href="#125">125</a> <em> * @param defaultValue the default value.</em>
135
<a name="126" href="#126">126</a> <em> * </em>
136
<a name="127" href="#127">127</a> <em> * @return a {@link Integer} that represents the value of the parameter.</em>
137
<a name="128" href="#128">128</a> <em> * </em>
138
<a name="129" href="#129">129</a> <em> * @see #setIntParameter(String, int)</em>
139
<a name="130" href="#130">130</a> <em> */</em>
140
<a name="131" href="#131">131</a> <strong>public</strong> <strong>int</strong> getIntParameter(<strong>final</strong> String name, <strong>int</strong> defaultValue);
141
<a name="132" href="#132">132</a>
142
<a name="133" href="#133">133</a> <em>/**<em>*</em></em>
143
<a name="134" href="#134">134</a> <em> * Assigns an {@link Integer} to the parameter with the given name</em>
144
<a name="135" href="#135">135</a> <em> * </em>
145
<a name="136" href="#136">136</a> <em> * @param name parameter name</em>
146
<a name="137" href="#137">137</a> <em> * @param value parameter value</em>
147
<a name="138" href="#138">138</a> <em> */</em>
148
<a name="139" href="#139">139</a> <strong>public</strong> <strong>void</strong> setIntParameter(<strong>final</strong> String name, <strong>int</strong> value);
149
<a name="140" href="#140">140</a>
150
<a name="141" href="#141">141</a> <em>/**<em>* </em></em>
151
<a name="142" href="#142">142</a> <em> * Returns a {@link Double} parameter value with the given name. </em>
152
<a name="143" href="#143">143</a> <em> * If the parameter is not explicitly defined in this collection, its </em>
153
<a name="144" href="#144">144</a> <em> * value will be drawn from a higer level collection at which this parameter </em>
154
<a name="145" href="#145">145</a> <em> * is defined. If the parameter is not explicitly set anywhere up the hierarchy,</em>
155
<a name="146" href="#146">146</a> <em> * the default value is returned. </em>
156
<a name="147" href="#147">147</a> <em> * </em>
157
<a name="148" href="#148">148</a> <em> * @param name the parent name.</em>
158
<a name="149" href="#149">149</a> <em> * @param defaultValue the default value.</em>
159
<a name="150" href="#150">150</a> <em> * </em>
160
<a name="151" href="#151">151</a> <em> * @return a {@link Double} that represents the value of the parameter.</em>
161
<a name="152" href="#152">152</a> <em> * </em>
162
<a name="153" href="#153">153</a> <em> * @see #setDoubleParameter(String, double)</em>
163
<a name="154" href="#154">154</a> <em> */</em>
164
<a name="155" href="#155">155</a> <strong>public</strong> <strong>double</strong> getDoubleParameter(<strong>final</strong> String name, <strong>double</strong> defaultValue);
165
<a name="156" href="#156">156</a>
166
<a name="157" href="#157">157</a> <em>/**<em>*</em></em>
167
<a name="158" href="#158">158</a> <em> * Assigns a {@link Double} to the parameter with the given name</em>
168
<a name="159" href="#159">159</a> <em> * </em>
169
<a name="160" href="#160">160</a> <em> * @param name parameter name</em>
170
<a name="161" href="#161">161</a> <em> * @param value parameter value</em>
171
<a name="162" href="#162">162</a> <em> */</em>
172
<a name="163" href="#163">163</a> <strong>public</strong> <strong>void</strong> setDoubleParameter(<strong>final</strong> String name, <strong>double</strong> value);
173
<a name="164" href="#164">164</a>
174
<a name="165" href="#165">165</a> <em>/**<em>* </em></em>
175
<a name="166" href="#166">166</a> <em> * Returns a {@link Boolean} parameter value with the given name. </em>
176
<a name="167" href="#167">167</a> <em> * If the parameter is not explicitly defined in this collection, its </em>
177
<a name="168" href="#168">168</a> <em> * value will be drawn from a higer level collection at which this parameter </em>
178
<a name="169" href="#169">169</a> <em> * is defined. If the parameter is not explicitly set anywhere up the hierarchy,</em>
179
<a name="170" href="#170">170</a> <em> * the default value is returned. </em>
180
<a name="171" href="#171">171</a> <em> * </em>
181
<a name="172" href="#172">172</a> <em> * @param name the parent name.</em>
182
<a name="173" href="#173">173</a> <em> * @param defaultValue the default value.</em>
183
<a name="174" href="#174">174</a> <em> * </em>
184
<a name="175" href="#175">175</a> <em> * @return a {@link Boolean} that represents the value of the parameter.</em>
185
<a name="176" href="#176">176</a> <em> * </em>
186
<a name="177" href="#177">177</a> <em> * @see #setBooleanParameter(String, boolean)</em>
187
<a name="178" href="#178">178</a> <em> */</em>
188
<a name="179" href="#179">179</a> <strong>public</strong> <strong>boolean</strong> getBooleanParameter(<strong>final</strong> String name, <strong>boolean</strong> defaultValue);
189
<a name="180" href="#180">180</a>
190
<a name="181" href="#181">181</a> <em>/**<em>*</em></em>
191
<a name="182" href="#182">182</a> <em> * Assigns a {@link Boolean} to the parameter with the given name</em>
192
<a name="183" href="#183">183</a> <em> * </em>
193
<a name="184" href="#184">184</a> <em> * @param name parameter name</em>
194
<a name="185" href="#185">185</a> <em> * @param value parameter value</em>
195
<a name="186" href="#186">186</a> <em> */</em>
196
<a name="187" href="#187">187</a> <strong>public</strong> <strong>void</strong> setBooleanParameter(<strong>final</strong> String name, <strong>boolean</strong> value);
197
<a name="188" href="#188">188</a>
198
<a name="189" href="#189">189</a> <em>/**<em>*</em></em>
199
<a name="190" href="#190">190</a> <em> * Returns <tt>true</tt> if the parameter is set at any level, <tt>false</tt> otherwise.</em>
200
<a name="191" href="#191">191</a> <em> * </em>
201
<a name="192" href="#192">192</a> <em> * @param name parameter name</em>
202
<a name="193" href="#193">193</a> <em> * </em>
203
<a name="194" href="#194">194</a> <em> * @return <tt>true</tt> if the parameter is set at any level, <tt>false</tt></em>
204
<a name="195" href="#195">195</a> <em> * otherwise.</em>
205
<a name="196" href="#196">196</a> <em> */</em>
206
<a name="197" href="#197">197</a> <strong>public</strong> <strong>boolean</strong> isParameterSet(<strong>final</strong> String name);
207
<a name="198" href="#198">198</a>
208
<a name="199" href="#199">199</a> <em>/**<em>*</em></em>
209
<a name="200" href="#200">200</a> <em> * Returns <tt>true</tt> if the parameter is set locally, <tt>false</tt> otherwise.</em>
210
<a name="201" href="#201">201</a> <em> * </em>
211
<a name="202" href="#202">202</a> <em> * @param name parameter name</em>
212
<a name="203" href="#203">203</a> <em> * </em>
213
<a name="204" href="#204">204</a> <em> * @return <tt>true</tt> if the parameter is set locally, <tt>false</tt></em>
214
<a name="205" href="#205">205</a> <em> * otherwise.</em>
215
<a name="206" href="#206">206</a> <em> */</em>
216
<a name="207" href="#207">207</a> <strong>public</strong> <strong>boolean</strong> isParameterSetLocally(<strong>final</strong> String name);
217
<a name="208" href="#208">208</a>
218
<a name="209" href="#209">209</a> <em>/**<em>*</em></em>
219
<a name="210" href="#210">210</a> <em> * Returns <tt>true</tt> if the parameter is set and is <tt>true</tt>, <tt>false</tt></em>
220
<a name="211" href="#211">211</a> <em> * otherwise.</em>
221
<a name="212" href="#212">212</a> <em> * </em>
222
<a name="213" href="#213">213</a> <em> * @param name parameter name</em>
223
<a name="214" href="#214">214</a> <em> * </em>
224
<a name="215" href="#215">215</a> <em> * @return <tt>true</tt> if the parameter is set and is <tt>true</tt>, <tt>false</tt></em>
225
<a name="216" href="#216">216</a> <em> * otherwise.</em>
226
<a name="217" href="#217">217</a> <em> */</em>
227
<a name="218" href="#218">218</a> <strong>public</strong> <strong>boolean</strong> isParameterTrue(<strong>final</strong> String name);
228
<a name="219" href="#219">219</a>
229
<a name="220" href="#220">220</a> <em>/**<em>*</em></em>
230
<a name="221" href="#221">221</a> <em> * Returns <tt>true</tt> if the parameter is either not set or is <tt>false</tt>, </em>
231
<a name="222" href="#222">222</a> <em> * <tt>false</tt> otherwise.</em>
232
<a name="223" href="#223">223</a> <em> * </em>
233
<a name="224" href="#224">224</a> <em> * @param name parameter name</em>
234
<a name="225" href="#225">225</a> <em> * </em>
235
<a name="226" href="#226">226</a> <em> * @return <tt>true</tt> if the parameter is either not set or is <tt>false</tt>, </em>
236
<a name="227" href="#227">227</a> <em> * <tt>false</tt> otherwise.</em>
237
<a name="228" href="#228">228</a> <em> */</em>
238
<a name="229" href="#229">229</a> <strong>public</strong> <strong>boolean</strong> isParameterFalse(<strong>final</strong> String name);
239
<a name="230" href="#230">230</a>
240
<a name="231" href="#231">231</a> }
17
<a name="8" href="#8">8</a> <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
18
<a name="9" href="#9">9</a> <em class="comment"> * contributor license agreements. See the NOTICE file distributed with</em>
19
<a name="10" href="#10">10</a> <em class="comment"> * this work for additional information regarding copyright ownership.</em>
20
<a name="11" href="#11">11</a> <em class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
21
<a name="12" href="#12">12</a> <em class="comment"> * (the "License"); you may not use this file except in compliance with</em>
22
<a name="13" href="#13">13</a> <em class="comment"> * the License. You may obtain a copy of the License at</em>
23
<a name="14" href="#14">14</a> <em class="comment"> *</em>
24
<a name="15" href="#15">15</a> <em class="comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
25
<a name="16" href="#16">16</a> <em class="comment"> *</em>
26
<a name="17" href="#17">17</a> <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
27
<a name="18" href="#18">18</a> <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
28
<a name="19" href="#19">19</a> <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
29
<a name="20" href="#20">20</a> <em class="comment"> * See the License for the specific language governing permissions and</em>
30
<a name="21" href="#21">21</a> <em class="comment"> * limitations under the License.</em>
31
<a name="22" href="#22">22</a> <em class="comment"> * ====================================================================</em>
32
<a name="23" href="#23">23</a> <em class="comment"> *</em>
33
<a name="24" href="#24">24</a> <em class="comment"> * This software consists of voluntary contributions made by many</em>
34
<a name="25" href="#25">25</a> <em class="comment"> * individuals on behalf of the Apache Software Foundation. For more</em>
35
<a name="26" href="#26">26</a> <em class="comment"> * information on the Apache Software Foundation, please see</em>
36
<a name="27" href="#27">27</a> <em class="comment"> * <<a href="http://www.apache.org/" target="alexandria_uri">http://www.apache.org/</a>>.</em>
37
<a name="28" href="#28">28</a> <em class="comment"> *</em>
38
<a name="29" href="#29">29</a> <em class="comment"> */</em>
39
<a name="30" href="#30">30</a>
40
<a name="31" href="#31">31</a> <strong>package</strong> org.apache.commons.httpclient.params;
41
<a name="32" href="#32">32</a>
42
<a name="33" href="#33">33</a> <em>/**</em>
43
<a name="34" href="#34">34</a> <em> * This interface represents a collection of HTTP protocol parameters. Protocol parameters</em>
44
<a name="35" href="#35">35</a> <em> * may be linked together to form a hierarchy. If a particular parameter value has not been</em>
45
<a name="36" href="#36">36</a> <em> * explicitly defined in the collection itself, its value will be drawn from the parent </em>
46
<a name="37" href="#37">37</a> <em> * collection of parameters.</em>
47
<a name="38" href="#38">38</a> <em> * </em>
48
<a name="39" href="#39">39</a> <em> * @author <a href="<a href="mailto:oleg@ural.ru" target="alexandria_uri">mailto:oleg@ural.ru</a>">Oleg Kalnichevski</a></em>
49
<a name="40" href="#40">40</a> <em> * </em>
50
<a name="41" href="#41">41</a> <em> * @version $Revision: 480424 $</em>
51
<a name="42" href="#42">42</a> <em> *</em>
52
<a name="43" href="#43">43</a> <em> * @since 3.0</em>
53
<a name="44" href="#44">44</a> <em> */</em>
54
<a name="45" href="#45">45</a> <strong>public</strong> <strong>interface</strong> <a href="../../../../../org/apache/commons/httpclient/params/HttpParams.html">HttpParams</a> {
55
<a name="46" href="#46">46</a>
56
<a name="47" href="#47">47</a> <em>/**</em><em> </em>
57
<a name="48" href="#48">48</a> <em> * Returns the parent collection that this collection will defer to</em>
58
<a name="49" href="#49">49</a> <em> * for a default value if a particular parameter is not explicitly </em>
59
<a name="50" href="#50">50</a> <em> * set in the collection itself</em>
60
<a name="51" href="#51">51</a> <em> * </em>
61
<a name="52" href="#52">52</a> <em> * @return the parent collection to defer to, if a particular parameter</em>
62
<a name="53" href="#53">53</a> <em> * is not explictly set in the collection itself.</em>
63
<a name="54" href="#54">54</a> <em> * </em>
64
<a name="55" href="#55">55</a> <em> * @see #setDefaults(HttpParams)</em>
65
<a name="56" href="#56">56</a> <em> */</em>
66
<a name="57" href="#57">57</a> <strong>public</strong> <a href="../../../../../org/apache/commons/httpclient/params/HttpParams.html">HttpParams</a> getDefaults();
67
<a name="58" href="#58">58</a>
68
<a name="59" href="#59">59</a> <em>/**</em><em> </em>
69
<a name="60" href="#60">60</a> <em> * Assigns the parent collection that this collection will defer to</em>
70
<a name="61" href="#61">61</a> <em> * for a default value if a particular parameter is not explicitly </em>
71
<a name="62" href="#62">62</a> <em> * set in the collection itself</em>
72
<a name="63" href="#63">63</a> <em> * </em>
73
<a name="64" href="#64">64</a> <em> * @param params the parent collection to defer to, if a particular </em>
74
<a name="65" href="#65">65</a> <em> * parameter is not explictly set in the collection itself.</em>
75
<a name="66" href="#66">66</a> <em> * </em>
76
<a name="67" href="#67">67</a> <em> * @see #getDefaults()</em>
77
<a name="68" href="#68">68</a> <em> */</em>
78
<a name="69" href="#69">69</a> <strong>public</strong> <strong>void</strong> setDefaults(<strong>final</strong> <a href="../../../../../org/apache/commons/httpclient/params/HttpParams.html">HttpParams</a> params);
79
<a name="70" href="#70">70</a>
80
<a name="71" href="#71">71</a> <em>/**</em><em> </em>
81
<a name="72" href="#72">72</a> <em> * Returns a parameter value with the given name. If the parameter is</em>
82
<a name="73" href="#73">73</a> <em> * not explicitly defined in this collection, its value will be drawn </em>
83
<a name="74" href="#74">74</a> <em> * from a higer level collection at which this parameter is defined.</em>
84
<a name="75" href="#75">75</a> <em> * If the parameter is not explicitly set anywhere up the hierarchy,</em>
85
<a name="76" href="#76">76</a> <em> * <tt>null</tt> value is returned. </em>
86
<a name="77" href="#77">77</a> <em> * </em>
87
<a name="78" href="#78">78</a> <em> * @param name the parent name.</em>
88
<a name="79" href="#79">79</a> <em> * </em>
89
<a name="80" href="#80">80</a> <em> * @return an object that represents the value of the parameter.</em>
90
<a name="81" href="#81">81</a> <em> * </em>
91
<a name="82" href="#82">82</a> <em> * @see #setParameter(String, Object)</em>
92
<a name="83" href="#83">83</a> <em> */</em>
93
<a name="84" href="#84">84</a> <strong>public</strong> Object getParameter(<strong>final</strong> String name);
94
<a name="85" href="#85">85</a>
95
<a name="86" href="#86">86</a> <em>/**</em>
96
<a name="87" href="#87">87</a> <em> * Assigns the value to the parameter with the given name</em>
97
<a name="88" href="#88">88</a> <em> * </em>
98
<a name="89" href="#89">89</a> <em> * @param name parameter name</em>
99
<a name="90" href="#90">90</a> <em> * @param value parameter value</em>
100
<a name="91" href="#91">91</a> <em> */</em>
101
<a name="92" href="#92">92</a> <strong>public</strong> <strong>void</strong> setParameter(<strong>final</strong> String name, <strong>final</strong> Object value);
102
<a name="93" href="#93">93</a>
103
<a name="94" href="#94">94</a> <em>/**</em><em> </em>
104
<a name="95" href="#95">95</a> <em> * Returns a {@link Long} parameter value with the given name. </em>
105
<a name="96" href="#96">96</a> <em> * If the parameter is not explicitly defined in this collection, its </em>
106
<a name="97" href="#97">97</a> <em> * value will be drawn from a higer level collection at which this parameter </em>
107
<a name="98" href="#98">98</a> <em> * is defined. If the parameter is not explicitly set anywhere up the hierarchy,</em>
108
<a name="99" href="#99">99</a> <em> * the default value is returned. </em>
109
<a name="100" href="#100">100</a> <em> * </em>
110
<a name="101" href="#101">101</a> <em> * @param name the parent name.</em>
111
<a name="102" href="#102">102</a> <em> * @param defaultValue the default value.</em>
112
<a name="103" href="#103">103</a> <em> * </em>
113
<a name="104" href="#104">104</a> <em> * @return a {@link Long} that represents the value of the parameter.</em>
114
<a name="105" href="#105">105</a> <em> * </em>
115
<a name="106" href="#106">106</a> <em> * @see #setLongParameter(String, long)</em>
116
<a name="107" href="#107">107</a> <em> */</em>
117
<a name="108" href="#108">108</a> <strong>public</strong> <strong>long</strong> getLongParameter(<strong>final</strong> String name, <strong>long</strong> defaultValue);
118
<a name="109" href="#109">109</a>
119
<a name="110" href="#110">110</a> <em>/**</em>
120
<a name="111" href="#111">111</a> <em> * Assigns a {@link Long} to the parameter with the given name</em>
121
<a name="112" href="#112">112</a> <em> * </em>
122
<a name="113" href="#113">113</a> <em> * @param name parameter name</em>
123
<a name="114" href="#114">114</a> <em> * @param value parameter value</em>
124
<a name="115" href="#115">115</a> <em> */</em>
125
<a name="116" href="#116">116</a> <strong>public</strong> <strong>void</strong> setLongParameter(<strong>final</strong> String name, <strong>long</strong> value);
126
<a name="117" href="#117">117</a>
127
<a name="118" href="#118">118</a> <em>/**</em><em> </em>
128
<a name="119" href="#119">119</a> <em> * Returns an {@link Integer} parameter value with the given name. </em>
129
<a name="120" href="#120">120</a> <em> * If the parameter is not explicitly defined in this collection, its </em>
130
<a name="121" href="#121">121</a> <em> * value will be drawn from a higer level collection at which this parameter </em>
131
<a name="122" href="#122">122</a> <em> * is defined. If the parameter is not explicitly set anywhere up the hierarchy,</em>
132
<a name="123" href="#123">123</a> <em> * the default value is returned. </em>
133
<a name="124" href="#124">124</a> <em> * </em>
134
<a name="125" href="#125">125</a> <em> * @param name the parent name.</em>
135
<a name="126" href="#126">126</a> <em> * @param defaultValue the default value.</em>
136
<a name="127" href="#127">127</a> <em> * </em>
137
<a name="128" href="#128">128</a> <em> * @return a {@link Integer} that represents the value of the parameter.</em>
138
<a name="129" href="#129">129</a> <em> * </em>
139
<a name="130" href="#130">130</a> <em> * @see #setIntParameter(String, int)</em>
140
<a name="131" href="#131">131</a> <em> */</em>
141
<a name="132" href="#132">132</a> <strong>public</strong> <strong>int</strong> getIntParameter(<strong>final</strong> String name, <strong>int</strong> defaultValue);
142
<a name="133" href="#133">133</a>
143
<a name="134" href="#134">134</a> <em>/**</em>
144
<a name="135" href="#135">135</a> <em> * Assigns an {@link Integer} to the parameter with the given name</em>
145
<a name="136" href="#136">136</a> <em> * </em>
146
<a name="137" href="#137">137</a> <em> * @param name parameter name</em>
147
<a name="138" href="#138">138</a> <em> * @param value parameter value</em>
148
<a name="139" href="#139">139</a> <em> */</em>
149
<a name="140" href="#140">140</a> <strong>public</strong> <strong>void</strong> setIntParameter(<strong>final</strong> String name, <strong>int</strong> value);
150
<a name="141" href="#141">141</a>
151
<a name="142" href="#142">142</a> <em>/**</em><em> </em>
152
<a name="143" href="#143">143</a> <em> * Returns a {@link Double} parameter value with the given name. </em>
153
<a name="144" href="#144">144</a> <em> * If the parameter is not explicitly defined in this collection, its </em>
154
<a name="145" href="#145">145</a> <em> * value will be drawn from a higer level collection at which this parameter </em>
155
<a name="146" href="#146">146</a> <em> * is defined. If the parameter is not explicitly set anywhere up the hierarchy,</em>
156
<a name="147" href="#147">147</a> <em> * the default value is returned. </em>
157
<a name="148" href="#148">148</a> <em> * </em>
158
<a name="149" href="#149">149</a> <em> * @param name the parent name.</em>
159
<a name="150" href="#150">150</a> <em> * @param defaultValue the default value.</em>
160
<a name="151" href="#151">151</a> <em> * </em>
161
<a name="152" href="#152">152</a> <em> * @return a {@link Double} that represents the value of the parameter.</em>
162
<a name="153" href="#153">153</a> <em> * </em>
163
<a name="154" href="#154">154</a> <em> * @see #setDoubleParameter(String, double)</em>
164
<a name="155" href="#155">155</a> <em> */</em>
165
<a name="156" href="#156">156</a> <strong>public</strong> <strong>double</strong> getDoubleParameter(<strong>final</strong> String name, <strong>double</strong> defaultValue);
166
<a name="157" href="#157">157</a>
167
<a name="158" href="#158">158</a> <em>/**</em>
168
<a name="159" href="#159">159</a> <em> * Assigns a {@link Double} to the parameter with the given name</em>
169
<a name="160" href="#160">160</a> <em> * </em>
170
<a name="161" href="#161">161</a> <em> * @param name parameter name</em>
171
<a name="162" href="#162">162</a> <em> * @param value parameter value</em>
172
<a name="163" href="#163">163</a> <em> */</em>
173
<a name="164" href="#164">164</a> <strong>public</strong> <strong>void</strong> setDoubleParameter(<strong>final</strong> String name, <strong>double</strong> value);
174
<a name="165" href="#165">165</a>
175
<a name="166" href="#166">166</a> <em>/**</em><em> </em>
176
<a name="167" href="#167">167</a> <em> * Returns a {@link Boolean} parameter value with the given name. </em>
177
<a name="168" href="#168">168</a> <em> * If the parameter is not explicitly defined in this collection, its </em>
178
<a name="169" href="#169">169</a> <em> * value will be drawn from a higer level collection at which this parameter </em>
179
<a name="170" href="#170">170</a> <em> * is defined. If the parameter is not explicitly set anywhere up the hierarchy,</em>
180
<a name="171" href="#171">171</a> <em> * the default value is returned. </em>
181
<a name="172" href="#172">172</a> <em> * </em>
182
<a name="173" href="#173">173</a> <em> * @param name the parent name.</em>
183
<a name="174" href="#174">174</a> <em> * @param defaultValue the default value.</em>
184
<a name="175" href="#175">175</a> <em> * </em>
185
<a name="176" href="#176">176</a> <em> * @return a {@link Boolean} that represents the value of the parameter.</em>
186
<a name="177" href="#177">177</a> <em> * </em>
187
<a name="178" href="#178">178</a> <em> * @see #setBooleanParameter(String, boolean)</em>
188
<a name="179" href="#179">179</a> <em> */</em>
189
<a name="180" href="#180">180</a> <strong>public</strong> <strong>boolean</strong> getBooleanParameter(<strong>final</strong> String name, <strong>boolean</strong> defaultValue);
190
<a name="181" href="#181">181</a>
191
<a name="182" href="#182">182</a> <em>/**</em>
192
<a name="183" href="#183">183</a> <em> * Assigns a {@link Boolean} to the parameter with the given name</em>
193
<a name="184" href="#184">184</a> <em> * </em>
194
<a name="185" href="#185">185</a> <em> * @param name parameter name</em>
195
<a name="186" href="#186">186</a> <em> * @param value parameter value</em>
196
<a name="187" href="#187">187</a> <em> */</em>
197
<a name="188" href="#188">188</a> <strong>public</strong> <strong>void</strong> setBooleanParameter(<strong>final</strong> String name, <strong>boolean</strong> value);
198
<a name="189" href="#189">189</a>
199
<a name="190" href="#190">190</a> <em>/**</em>
200
<a name="191" href="#191">191</a> <em> * Returns <tt>true</tt> if the parameter is set at any level, <tt>false</tt> otherwise.</em>
201
<a name="192" href="#192">192</a> <em> * </em>
202
<a name="193" href="#193">193</a> <em> * @param name parameter name</em>
203
<a name="194" href="#194">194</a> <em> * </em>
204
<a name="195" href="#195">195</a> <em> * @return <tt>true</tt> if the parameter is set at any level, <tt>false</tt></em>
205
<a name="196" href="#196">196</a> <em> * otherwise.</em>
206
<a name="197" href="#197">197</a> <em> */</em>
207
<a name="198" href="#198">198</a> <strong>public</strong> <strong>boolean</strong> isParameterSet(<strong>final</strong> String name);
208
<a name="199" href="#199">199</a>
209
<a name="200" href="#200">200</a> <em>/**</em>
210
<a name="201" href="#201">201</a> <em> * Returns <tt>true</tt> if the parameter is set locally, <tt>false</tt> otherwise.</em>
211
<a name="202" href="#202">202</a> <em> * </em>
212
<a name="203" href="#203">203</a> <em> * @param name parameter name</em>
213
<a name="204" href="#204">204</a> <em> * </em>
214
<a name="205" href="#205">205</a> <em> * @return <tt>true</tt> if the parameter is set locally, <tt>false</tt></em>
215
<a name="206" href="#206">206</a> <em> * otherwise.</em>
216
<a name="207" href="#207">207</a> <em> */</em>
217
<a name="208" href="#208">208</a> <strong>public</strong> <strong>boolean</strong> isParameterSetLocally(<strong>final</strong> String name);
218
<a name="209" href="#209">209</a>
219
<a name="210" href="#210">210</a> <em>/**</em>
220
<a name="211" href="#211">211</a> <em> * Returns <tt>true</tt> if the parameter is set and is <tt>true</tt>, <tt>false</tt></em>
221
<a name="212" href="#212">212</a> <em> * otherwise.</em>
222
<a name="213" href="#213">213</a> <em> * </em>
223
<a name="214" href="#214">214</a> <em> * @param name parameter name</em>
224
<a name="215" href="#215">215</a> <em> * </em>
225
<a name="216" href="#216">216</a> <em> * @return <tt>true</tt> if the parameter is set and is <tt>true</tt>, <tt>false</tt></em>
226
<a name="217" href="#217">217</a> <em> * otherwise.</em>
227
<a name="218" href="#218">218</a> <em> */</em>
228
<a name="219" href="#219">219</a> <strong>public</strong> <strong>boolean</strong> isParameterTrue(<strong>final</strong> String name);
229
<a name="220" href="#220">220</a>
230
<a name="221" href="#221">221</a> <em>/**</em>
231
<a name="222" href="#222">222</a> <em> * Returns <tt>true</tt> if the parameter is either not set or is <tt>false</tt>, </em>
232
<a name="223" href="#223">223</a> <em> * <tt>false</tt> otherwise.</em>
233
<a name="224" href="#224">224</a> <em> * </em>
234
<a name="225" href="#225">225</a> <em> * @param name parameter name</em>
235
<a name="226" href="#226">226</a> <em> * </em>
236
<a name="227" href="#227">227</a> <em> * @return <tt>true</tt> if the parameter is either not set or is <tt>false</tt>, </em>
237
<a name="228" href="#228">228</a> <em> * <tt>false</tt> otherwise.</em>
238
<a name="229" href="#229">229</a> <em> */</em>
239
<a name="230" href="#230">230</a> <strong>public</strong> <strong>boolean</strong> isParameterFalse(<strong>final</strong> String name);
240
<a name="231" href="#231">231</a>
241
<a name="232" href="#232">232</a> }
242
243
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
added
removed
docs/xref/org/apache/commons/httpclient/params/HttpParams.html
