1 /*
2 * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/multipart/PartBase.java,v 1.1.2.2 2004/01/14 19:12:26 olegk Exp $
3 * $Revision: 1.1.2.2 $
4 * $Date: 2004/01/14 19:12:26 $
5 *
6 * ====================================================================
7 *
8 * The Apache Software License, Version 1.1
9 *
10 * Copyright (c) 2002-2003 The Apache Software Foundation. All rights
11 * reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 *
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in
22 * the documentation and/or other materials provided with the
23 * distribution.
24 *
25 * 3. The end-user documentation included with the redistribution, if
26 * any, must include the following acknowlegement:
27 * "This product includes software developed by the
28 * Apache Software Foundation (http://www.apache.org/)."
29 * Alternately, this acknowlegement may appear in the software itself,
30 * if and wherever such third-party acknowlegements normally appear.
31 *
32 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
33 * Foundation" must not be used to endorse or promote products derived
34 * from this software without prior written permission. For written
35 * permission, please contact apache@apache.org.
36 *
37 * 5. Products derived from this software may not be called "Apache"
38 * nor may "Apache" appear in their names without prior written
39 * permission of the Apache Group.
40 *
41 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
42 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
45 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
47 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
48 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
49 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
51 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * SUCH DAMAGE.
53 * ====================================================================
54 *
55 * This software consists of voluntary contributions made by many
56 * individuals on behalf of the Apache Software Foundation. For more
57 * information on the Apache Software Foundation, please see
58 * <http://www.apache.org/>.
59 *
60 * [Additional notices, if required by prior licensing conditions]
61 *
62 */
63
64 package org.apache.commons.httpclient.methods.multipart;
65
66
67 /***
68 * Provides setters and getters for the basic Part properties.
69 *
70 * @author Michael Becke
71 */
72 public abstract class PartBase extends Part {
73
74 /*** Name of the file part. */
75 private String name;
76
77 /*** Content type of the file part. */
78 private String contentType;
79
80 /*** Content encoding of the file part. */
81 private String charSet;
82
83 /*** The transfer encoding. */
84 private String transferEncoding;
85
86 /***
87 * Constructor.
88 *
89 * @param name The name of the part
90 * @param contentType The content type, or <code>null</code>
91 * @param charSet The character encoding, or <code>null</code>
92 * @param transferEncoding The transfer encoding, or <code>null</code>
93 */
94 public PartBase(String name, String contentType, String charSet, String transferEncoding) {
95
96 if (name == null) {
97 throw new IllegalArgumentException("Name must not be null");
98 }
99 this.name = name;
100 this.contentType = contentType;
101 this.charSet = charSet;
102 this.transferEncoding = transferEncoding;
103 }
104
105 /***
106 * Returns the name.
107 * @return The name.
108 * @see org.apache.commons.httpclient.methods.multipart.Part#getName()
109 */
110 public String getName() {
111 return this.name;
112 }
113
114 /***
115 * Returns the content type of this part.
116 * @return String The name.
117 */
118 public String getContentType() {
119 return this.contentType;
120 }
121
122 /***
123 * Return the character encoding of this part.
124 * @return String The name.
125 */
126 public String getCharSet() {
127 return this.charSet;
128 }
129
130 /***
131 * Returns the transfer encoding of this part.
132 * @return String The name.
133 */
134 public String getTransferEncoding() {
135 return transferEncoding;
136 }
137
138 /***
139 * Sets the character encoding.
140 *
141 * @param charSet the character encoding, or <code>null</code> to exclude the character
142 * encoding header
143 */
144 public void setCharSet(String charSet) {
145 this.charSet = charSet;
146 }
147
148 /***
149 * Sets the content type.
150 *
151 * @param contentType the content type, or <code>null</code> to exclude the content type header
152 */
153 public void setContentType(String contentType) {
154 this.contentType = contentType;
155 }
156
157 /***
158 * Sets the part name.
159 *
160 * @param name
161 */
162 public void setName(String name) {
163 if (name == null) {
164 throw new IllegalArgumentException("Name must not be null");
165 }
166 this.name = name;
167 }
168
169 /***
170 * Sets the transfer encoding.
171 *
172 * @param transferEncoding the transfer encoding, or <code>null</code> to exclude the
173 * transfer encoding header
174 */
175 public void setTransferEncoding(String transferEncoding) {
176 this.transferEncoding = transferEncoding;
177 }
178
179 }
This page was automatically generated by Maven