← Back to branch summary

~ubuntu-branches/ubuntu/hardy/commons-httpclient/hardy

« back to all changes in this revision

Viewing changes to docs/xref/org/apache/commons/httpclient/methods/multipart/PartBase.html

  • Committer: Bazaar Package Importer
  • Author(s): Michael Meskes
  • Date: 2006-09-15 20:07:43 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20060915200743-t2md4cgfsb07wgn7
Tags: 3.0.1-0.1
http://bugs.debian.org/381354
* Non-maintainer upload.
* Bump debhelper Build-Depends to (>= 4.1.0) as required by cdbs' 
  debhelper.mk
* Put the coppyright holders in debian/copyright
* Include the jar file in the package. (Closes: #381354)
* Only include one copy of the docs.
  done by James Westby <jw+debian@jameswestby.net>  Mon, 14 Aug 2006 02:29:47 +0100

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/xref/org/apache/commons/httpclient/methods/multipart/PartBase.html
8
8
<div id="overview"><a href="../../../../../../../apidocs/org/apache/commons/httpclient/methods/multipart/PartBase.html">View Javadoc</a></div><pre>
9
9
 
10
10
<a name="1" href="#1">1</a>   <em class="comment">/*</em>
11
 
<a name="2" href="#2">2</a>   <em class="comment"> * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/multipart/PartBase.java,v 1.1.2.3 2004/02/22 18:21:15 olegk Exp $</em>
12
 
<a name="3" href="#3">3</a>   <em class="comment"> * $Revision: 1.1.2.3 $</em>
13
 
<a name="4" href="#4">4</a>   <em class="comment"> * $Date: 2004/02/22 18:21:15 $</em>
 
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/methods/multipart/PartBase.java,v 1.5 2004/04/18 23:51:37 jsdever 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>
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>
34
34
<a name="25" href="#25">25</a>  <em class="comment"> * information on the Apache Software Foundation, please see</em>
35
35
<a name="26" href="#26">26</a>  <em class="comment"> * &lt;<a href="http://www.apache.org/" target="alexandria_uri">http://www.apache.org/</a>>.</em>
36
36
<a name="27" href="#27">27</a>  <em class="comment"> *</em>
37
 
<a name="28" href="#28">28</a>  <em class="comment"> * [Additional notices, if required by prior licensing conditions]</em>
38
 
<a name="29" href="#29">29</a>  <em class="comment"> *</em>
39
 
<a name="30" href="#30">30</a>  <em class="comment"> */</em>
40
 
<a name="31" href="#31">31</a>   
41
 
<a name="32" href="#32">32</a>  <strong>package</strong> <a href="../../../../../../org/apache/commons/httpclient/methods/multipart/package-summary.html">org.apache.commons.httpclient.methods.multipart</a>;
42
 
<a name="33" href="#33">33</a>  
43
 
<a name="34" href="#34">34</a>  
44
 
<a name="35" href="#35">35</a>  <em>/**<em>*</em></em>
45
 
<a name="36" href="#36">36</a>  <em> * Provides setters and getters for the basic Part properties.</em>
46
 
<a name="37" href="#37">37</a>  <em> * </em>
47
 
<a name="38" href="#38">38</a>  <em> * @author Michael Becke</em>
48
 
<a name="39" href="#39">39</a>  <em> */</em>
49
 
<a name="40" href="#40">40</a>  <strong>public</strong> <strong>abstract</strong> <strong>class</strong> <a href="../../../../../../org/apache/commons/httpclient/methods/multipart/PartBase.html">PartBase</a> <strong>extends</strong> <a href="../../../../../../org/apache/commons/httpclient/methods/multipart/Part.html">Part</a> {
50
 
<a name="41" href="#41">41</a>  
51
 
<a name="42" href="#42">42</a>      <em>/**<em>* Name of the file part. */</em></em>
52
 
<a name="43" href="#43">43</a>      <strong>private</strong> String name;
53
 
<a name="44" href="#44">44</a>          
54
 
<a name="45" href="#45">45</a>      <em>/**<em>* Content type of the file part. */</em></em>
55
 
<a name="46" href="#46">46</a>      <strong>private</strong> String contentType;
56
 
<a name="47" href="#47">47</a>  
57
 
<a name="48" href="#48">48</a>      <em>/**<em>* Content encoding of the file part. */</em></em>
58
 
<a name="49" href="#49">49</a>      <strong>private</strong> String charSet;
59
 
<a name="50" href="#50">50</a>      
60
 
<a name="51" href="#51">51</a>      <em>/**<em>* The transfer encoding. */</em></em>
61
 
<a name="52" href="#52">52</a>      <strong>private</strong> String transferEncoding;
62
 
<a name="53" href="#53">53</a>  
63
 
<a name="54" href="#54">54</a>      <em>/**<em>*</em></em>
64
 
<a name="55" href="#55">55</a>  <em>     * Constructor.</em>
65
 
<a name="56" href="#56">56</a>  <em>     * </em>
66
 
<a name="57" href="#57">57</a>  <em>     * @param name The name of the part</em>
67
 
<a name="58" href="#58">58</a>  <em>     * @param contentType The content type, or &lt;code>null&lt;/code></em>
68
 
<a name="59" href="#59">59</a>  <em>     * @param charSet The character encoding, or &lt;code>null&lt;/code> </em>
69
 
<a name="60" href="#60">60</a>  <em>     * @param transferEncoding The transfer encoding, or &lt;code>null&lt;/code></em>
70
 
<a name="61" href="#61">61</a>  <em>     */</em>
71
 
<a name="62" href="#62">62</a>      <strong>public</strong> <a href="../../../../../../org/apache/commons/httpclient/methods/multipart/PartBase.html">PartBase</a>(String name, String contentType, String charSet, String transferEncoding) {
72
 
<a name="63" href="#63">63</a>  
73
 
<a name="64" href="#64">64</a>          <strong>if</strong> (name == <strong>null</strong>) {
74
 
<a name="65" href="#65">65</a>              <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Name must not be null"</span>);
75
 
<a name="66" href="#66">66</a>          }
76
 
<a name="67" href="#67">67</a>          <strong>this</strong>.name = name;
77
 
<a name="68" href="#68">68</a>          <strong>this</strong>.contentType = contentType;
78
 
<a name="69" href="#69">69</a>          <strong>this</strong>.charSet = charSet;
79
 
<a name="70" href="#70">70</a>          <strong>this</strong>.transferEncoding = transferEncoding;
80
 
<a name="71" href="#71">71</a>      }
81
 
<a name="72" href="#72">72</a>  
82
 
<a name="73" href="#73">73</a>      <em>/**<em>*</em></em>
83
 
<a name="74" href="#74">74</a>  <em>     * Returns the name.</em>
84
 
<a name="75" href="#75">75</a>  <em>     * @return The name.</em>
85
 
<a name="76" href="#76">76</a>  <em>     * @see org.apache.commons.httpclient.methods.multipart.Part#getName()</em>
86
 
<a name="77" href="#77">77</a>  <em>     */</em>
87
 
<a name="78" href="#78">78</a>      <strong>public</strong> String getName() { 
88
 
<a name="79" href="#79">79</a>          <strong>return</strong> <strong>this</strong>.name; 
89
 
<a name="80" href="#80">80</a>      }
90
 
<a name="81" href="#81">81</a>  
91
 
<a name="82" href="#82">82</a>      <em>/**<em>*</em></em>
92
 
<a name="83" href="#83">83</a>  <em>     * Returns the content type of this part.</em>
93
 
<a name="84" href="#84">84</a>  <em>     * @return String The name.</em>
94
 
<a name="85" href="#85">85</a>  <em>     */</em>
95
 
<a name="86" href="#86">86</a>      <strong>public</strong> String getContentType() {
96
 
<a name="87" href="#87">87</a>          <strong>return</strong> <strong>this</strong>.contentType;
97
 
<a name="88" href="#88">88</a>      }
98
 
<a name="89" href="#89">89</a>  
99
 
<a name="90" href="#90">90</a>      <em>/**<em>*</em></em>
100
 
<a name="91" href="#91">91</a>  <em>     * Return the character encoding of this part.</em>
101
 
<a name="92" href="#92">92</a>  <em>     * @return String The name.</em>
102
 
<a name="93" href="#93">93</a>  <em>     */</em>
103
 
<a name="94" href="#94">94</a>      <strong>public</strong> String getCharSet() {
104
 
<a name="95" href="#95">95</a>          <strong>return</strong> <strong>this</strong>.charSet;
105
 
<a name="96" href="#96">96</a>      }
106
 
<a name="97" href="#97">97</a>  
107
 
<a name="98" href="#98">98</a>      <em>/**<em>*</em></em>
108
 
<a name="99" href="#99">99</a>  <em>     * Returns the transfer encoding of this part.</em>
109
 
<a name="100" href="#100">100</a> <em>     * @return String The name.</em>
110
 
<a name="101" href="#101">101</a> <em>     */</em>
111
 
<a name="102" href="#102">102</a>     <strong>public</strong> String getTransferEncoding() {
112
 
<a name="103" href="#103">103</a>         <strong>return</strong> transferEncoding;
113
 
<a name="104" href="#104">104</a>     }
114
 
<a name="105" href="#105">105</a> 
115
 
<a name="106" href="#106">106</a>     <em>/**<em>*</em></em>
116
 
<a name="107" href="#107">107</a> <em>     * Sets the character encoding.</em>
117
 
<a name="108" href="#108">108</a> <em>     * </em>
118
 
<a name="109" href="#109">109</a> <em>     * @param charSet the character encoding, or &lt;code>null&lt;/code> to exclude the character </em>
119
 
<a name="110" href="#110">110</a> <em>     * encoding header</em>
120
 
<a name="111" href="#111">111</a> <em>     */</em>
121
 
<a name="112" href="#112">112</a>     <strong>public</strong> <strong>void</strong> setCharSet(String charSet) {
122
 
<a name="113" href="#113">113</a>         <strong>this</strong>.charSet = charSet;
123
 
<a name="114" href="#114">114</a>     }
124
 
<a name="115" href="#115">115</a> 
125
 
<a name="116" href="#116">116</a>     <em>/**<em>*</em></em>
126
 
<a name="117" href="#117">117</a> <em>     * Sets the content type.</em>
127
 
<a name="118" href="#118">118</a> <em>     * </em>
128
 
<a name="119" href="#119">119</a> <em>     * @param contentType the content type, or &lt;code>null&lt;/code> to exclude the content type header</em>
129
 
<a name="120" href="#120">120</a> <em>     */</em>
130
 
<a name="121" href="#121">121</a>     <strong>public</strong> <strong>void</strong> setContentType(String contentType) {
131
 
<a name="122" href="#122">122</a>         <strong>this</strong>.contentType = contentType;
132
 
<a name="123" href="#123">123</a>     }
133
 
<a name="124" href="#124">124</a> 
134
 
<a name="125" href="#125">125</a>     <em>/**<em>*</em></em>
135
 
<a name="126" href="#126">126</a> <em>     * Sets the part name.</em>
136
 
<a name="127" href="#127">127</a> <em>     * </em>
137
 
<a name="128" href="#128">128</a> <em>     * @param name</em>
138
 
<a name="129" href="#129">129</a> <em>     */</em>
139
 
<a name="130" href="#130">130</a>     <strong>public</strong> <strong>void</strong> setName(String name) {
140
 
<a name="131" href="#131">131</a>         <strong>if</strong> (name == <strong>null</strong>) {
141
 
<a name="132" href="#132">132</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Name must not be null"</span>);
142
 
<a name="133" href="#133">133</a>         }
143
 
<a name="134" href="#134">134</a>         <strong>this</strong>.name = name;
144
 
<a name="135" href="#135">135</a>     }
145
 
<a name="136" href="#136">136</a> 
146
 
<a name="137" href="#137">137</a>     <em>/**<em>*</em></em>
147
 
<a name="138" href="#138">138</a> <em>     * Sets the transfer encoding.</em>
148
 
<a name="139" href="#139">139</a> <em>     * </em>
149
 
<a name="140" href="#140">140</a> <em>     * @param transferEncoding the transfer encoding, or &lt;code>null&lt;/code> to exclude the </em>
150
 
<a name="141" href="#141">141</a> <em>     * transfer encoding header</em>
151
 
<a name="142" href="#142">142</a> <em>     */</em>
152
 
<a name="143" href="#143">143</a>     <strong>public</strong> <strong>void</strong> setTransferEncoding(String transferEncoding) {
153
 
<a name="144" href="#144">144</a>         <strong>this</strong>.transferEncoding = transferEncoding;
154
 
<a name="145" href="#145">145</a>     }
155
 
<a name="146" href="#146">146</a> 
156
 
<a name="147" href="#147">147</a> }
 
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/methods/multipart/package-summary.html">org.apache.commons.httpclient.methods.multipart</a>;
 
40
<a name="31" href="#31">31</a>  
 
41
<a name="32" href="#32">32</a>  
 
42
<a name="33" href="#33">33</a>  <em>/**<em>*</em></em>
 
43
<a name="34" href="#34">34</a>  <em> * Provides setters and getters for the basic Part properties.</em>
 
44
<a name="35" href="#35">35</a>  <em> * </em>
 
45
<a name="36" href="#36">36</a>  <em> * @author Michael Becke</em>
 
46
<a name="37" href="#37">37</a>  <em> */</em>
 
47
<a name="38" href="#38">38</a>  <strong>public</strong> <strong>abstract</strong> <strong>class</strong> <a href="../../../../../../org/apache/commons/httpclient/methods/multipart/PartBase.html">PartBase</a> <strong>extends</strong> <a href="../../../../../../org/apache/commons/httpclient/methods/multipart/Part.html">Part</a> {
 
48
<a name="39" href="#39">39</a>  
 
49
<a name="40" href="#40">40</a>      <em>/**<em>* Name of the file part. */</em></em>
 
50
<a name="41" href="#41">41</a>      <strong>private</strong> String name;
 
51
<a name="42" href="#42">42</a>          
 
52
<a name="43" href="#43">43</a>      <em>/**<em>* Content type of the file part. */</em></em>
 
53
<a name="44" href="#44">44</a>      <strong>private</strong> String contentType;
 
54
<a name="45" href="#45">45</a>  
 
55
<a name="46" href="#46">46</a>      <em>/**<em>* Content encoding of the file part. */</em></em>
 
56
<a name="47" href="#47">47</a>      <strong>private</strong> String charSet;
 
57
<a name="48" href="#48">48</a>      
 
58
<a name="49" href="#49">49</a>      <em>/**<em>* The transfer encoding. */</em></em>
 
59
<a name="50" href="#50">50</a>      <strong>private</strong> String transferEncoding;
 
60
<a name="51" href="#51">51</a>  
 
61
<a name="52" href="#52">52</a>      <em>/**<em>*</em></em>
 
62
<a name="53" href="#53">53</a>  <em>     * Constructor.</em>
 
63
<a name="54" href="#54">54</a>  <em>     * </em>
 
64
<a name="55" href="#55">55</a>  <em>     * @param name The name of the part</em>
 
65
<a name="56" href="#56">56</a>  <em>     * @param contentType The content type, or &lt;code>null&lt;/code></em>
 
66
<a name="57" href="#57">57</a>  <em>     * @param charSet The character encoding, or &lt;code>null&lt;/code> </em>
 
67
<a name="58" href="#58">58</a>  <em>     * @param transferEncoding The transfer encoding, or &lt;code>null&lt;/code></em>
 
68
<a name="59" href="#59">59</a>  <em>     */</em>
 
69
<a name="60" href="#60">60</a>      <strong>public</strong> <a href="../../../../../../org/apache/commons/httpclient/methods/multipart/PartBase.html">PartBase</a>(String name, String contentType, String charSet, String transferEncoding) {
 
70
<a name="61" href="#61">61</a>  
 
71
<a name="62" href="#62">62</a>          <strong>if</strong> (name == <strong>null</strong>) {
 
72
<a name="63" href="#63">63</a>              <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Name must not be null"</span>);
 
73
<a name="64" href="#64">64</a>          }
 
74
<a name="65" href="#65">65</a>          <strong>this</strong>.name = name;
 
75
<a name="66" href="#66">66</a>          <strong>this</strong>.contentType = contentType;
 
76
<a name="67" href="#67">67</a>          <strong>this</strong>.charSet = charSet;
 
77
<a name="68" href="#68">68</a>          <strong>this</strong>.transferEncoding = transferEncoding;
 
78
<a name="69" href="#69">69</a>      }
 
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 the name.</em>
 
82
<a name="73" href="#73">73</a>  <em>     * @return The name.</em>
 
83
<a name="74" href="#74">74</a>  <em>     * @see org.apache.commons.httpclient.methods.multipart.Part#getName()</em>
 
84
<a name="75" href="#75">75</a>  <em>     */</em>
 
85
<a name="76" href="#76">76</a>      <strong>public</strong> String getName() { 
 
86
<a name="77" href="#77">77</a>          <strong>return</strong> <strong>this</strong>.name; 
 
87
<a name="78" href="#78">78</a>      }
 
88
<a name="79" href="#79">79</a>  
 
89
<a name="80" href="#80">80</a>      <em>/**<em>*</em></em>
 
90
<a name="81" href="#81">81</a>  <em>     * Returns the content type of this part.</em>
 
91
<a name="82" href="#82">82</a>  <em>     * @return String The name.</em>
 
92
<a name="83" href="#83">83</a>  <em>     */</em>
 
93
<a name="84" href="#84">84</a>      <strong>public</strong> String getContentType() {
 
94
<a name="85" href="#85">85</a>          <strong>return</strong> <strong>this</strong>.contentType;
 
95
<a name="86" href="#86">86</a>      }
 
96
<a name="87" href="#87">87</a>  
 
97
<a name="88" href="#88">88</a>      <em>/**<em>*</em></em>
 
98
<a name="89" href="#89">89</a>  <em>     * Return the character encoding of this part.</em>
 
99
<a name="90" href="#90">90</a>  <em>     * @return String The name.</em>
 
100
<a name="91" href="#91">91</a>  <em>     */</em>
 
101
<a name="92" href="#92">92</a>      <strong>public</strong> String getCharSet() {
 
102
<a name="93" href="#93">93</a>          <strong>return</strong> <strong>this</strong>.charSet;
 
103
<a name="94" href="#94">94</a>      }
 
104
<a name="95" href="#95">95</a>  
 
105
<a name="96" href="#96">96</a>      <em>/**<em>*</em></em>
 
106
<a name="97" href="#97">97</a>  <em>     * Returns the transfer encoding of this part.</em>
 
107
<a name="98" href="#98">98</a>  <em>     * @return String The name.</em>
 
108
<a name="99" href="#99">99</a>  <em>     */</em>
 
109
<a name="100" href="#100">100</a>     <strong>public</strong> String getTransferEncoding() {
 
110
<a name="101" href="#101">101</a>         <strong>return</strong> transferEncoding;
 
111
<a name="102" href="#102">102</a>     }
 
112
<a name="103" href="#103">103</a> 
 
113
<a name="104" href="#104">104</a>     <em>/**<em>*</em></em>
 
114
<a name="105" href="#105">105</a> <em>     * Sets the character encoding.</em>
 
115
<a name="106" href="#106">106</a> <em>     * </em>
 
116
<a name="107" href="#107">107</a> <em>     * @param charSet the character encoding, or &lt;code>null&lt;/code> to exclude the character </em>
 
117
<a name="108" href="#108">108</a> <em>     * encoding header</em>
 
118
<a name="109" href="#109">109</a> <em>     */</em>
 
119
<a name="110" href="#110">110</a>     <strong>public</strong> <strong>void</strong> setCharSet(String charSet) {
 
120
<a name="111" href="#111">111</a>         <strong>this</strong>.charSet = charSet;
 
121
<a name="112" href="#112">112</a>     }
 
122
<a name="113" href="#113">113</a> 
 
123
<a name="114" href="#114">114</a>     <em>/**<em>*</em></em>
 
124
<a name="115" href="#115">115</a> <em>     * Sets the content type.</em>
 
125
<a name="116" href="#116">116</a> <em>     * </em>
 
126
<a name="117" href="#117">117</a> <em>     * @param contentType the content type, or &lt;code>null&lt;/code> to exclude the content type header</em>
 
127
<a name="118" href="#118">118</a> <em>     */</em>
 
128
<a name="119" href="#119">119</a>     <strong>public</strong> <strong>void</strong> setContentType(String contentType) {
 
129
<a name="120" href="#120">120</a>         <strong>this</strong>.contentType = contentType;
 
130
<a name="121" href="#121">121</a>     }
 
131
<a name="122" href="#122">122</a> 
 
132
<a name="123" href="#123">123</a>     <em>/**<em>*</em></em>
 
133
<a name="124" href="#124">124</a> <em>     * Sets the part name.</em>
 
134
<a name="125" href="#125">125</a> <em>     * </em>
 
135
<a name="126" href="#126">126</a> <em>     * @param name</em>
 
136
<a name="127" href="#127">127</a> <em>     */</em>
 
137
<a name="128" href="#128">128</a>     <strong>public</strong> <strong>void</strong> setName(String name) {
 
138
<a name="129" href="#129">129</a>         <strong>if</strong> (name == <strong>null</strong>) {
 
139
<a name="130" href="#130">130</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Name must not be null"</span>);
 
140
<a name="131" href="#131">131</a>         }
 
141
<a name="132" href="#132">132</a>         <strong>this</strong>.name = name;
 
142
<a name="133" href="#133">133</a>     }
 
143
<a name="134" href="#134">134</a> 
 
144
<a name="135" href="#135">135</a>     <em>/**<em>*</em></em>
 
145
<a name="136" href="#136">136</a> <em>     * Sets the transfer encoding.</em>
 
146
<a name="137" href="#137">137</a> <em>     * </em>
 
147
<a name="138" href="#138">138</a> <em>     * @param transferEncoding the transfer encoding, or &lt;code>null&lt;/code> to exclude the </em>
 
148
<a name="139" href="#139">139</a> <em>     * transfer encoding header</em>
 
149
<a name="140" href="#140">140</a> <em>     */</em>
 
150
<a name="141" href="#141">141</a>     <strong>public</strong> <strong>void</strong> setTransferEncoding(String transferEncoding) {
 
151
<a name="142" href="#142">142</a>         <strong>this</strong>.transferEncoding = transferEncoding;
 
152
<a name="143" href="#143">143</a>     }
 
153
<a name="144" href="#144">144</a> 
 
154
<a name="145" href="#145">145</a> }
157
155
</pre>
158
156
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
159
157
</html>