1 /*
2  * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/entity/StringEntity.java $
3  * $Revision: 618367 $
4  * $Date: 2008-02-04 10:26:06 -0800 (Mon, 04 Feb 2008) $
5  *
6  * ====================================================================
7  * Licensed to the Apache Software Foundation (ASF) under one
8  * or more contributor license agreements.  See the NOTICE file
9  * distributed with this work for additional information
10  * regarding copyright ownership.  The ASF licenses this file
11  * to you under the Apache License, Version 2.0 (the
12  * "License"); you may not use this file except in compliance
13  * with the License.  You may obtain a copy of the License at
14  *
15  *   http://www.apache.org/licenses/LICENSE-2.0
16  *
17  * Unless required by applicable law or agreed to in writing,
18  * software distributed under the License is distributed on an
19  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
20  * KIND, either express or implied.  See the License for the
21  * specific language governing permissions and limitations
22  * under the License.
23  * ====================================================================
24  *
25  * This software consists of voluntary contributions made by many
26  * individuals on behalf of the Apache Software Foundation.  For more
27  * information on the Apache Software Foundation, please see
28  * <http://www.apache.org/>.
29  *
30  */
31 
32 package org.apache.http.entity;
33 
34 import java.io.ByteArrayInputStream;
35 import java.io.IOException;
36 import java.io.InputStream;
37 import java.io.OutputStream;
38 import java.io.UnsupportedEncodingException;
39 
40 import org.apache.http.protocol.HTTP;
41 
42 /**
43  *  An entity whose content is retrieved from a string.
44  *
45  * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
46  *
47  * @version $Revision: 618367 $
48  *
49  * @since 4.0
50  *
51  * @deprecated Please use {@link java.net.URL#openConnection} instead.
52  *     Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a>
53  *     for further details.
54  */
55 @Deprecated
56 public class StringEntity extends AbstractHttpEntity implements Cloneable {
57 
58     protected final byte[] content;
59 
StringEntity(final String s, String charset)60     public StringEntity(final String s, String charset)
61             throws UnsupportedEncodingException {
62         super();
63         if (s == null) {
64             throw new IllegalArgumentException("Source string may not be null");
65         }
66         if (charset == null) {
67             charset = HTTP.DEFAULT_CONTENT_CHARSET;
68         }
69         this.content = s.getBytes(charset);
70         setContentType(HTTP.PLAIN_TEXT_TYPE + HTTP.CHARSET_PARAM + charset);
71     }
72 
StringEntity(final String s)73     public StringEntity(final String s)
74             throws UnsupportedEncodingException {
75         this(s, null);
76     }
77 
isRepeatable()78     public boolean isRepeatable() {
79         return true;
80     }
81 
getContentLength()82     public long getContentLength() {
83         return this.content.length;
84     }
85 
getContent()86     public InputStream getContent() throws IOException {
87         return new ByteArrayInputStream(this.content);
88     }
89 
writeTo(final OutputStream outstream)90     public void writeTo(final OutputStream outstream) throws IOException {
91         if (outstream == null) {
92             throw new IllegalArgumentException("Output stream may not be null");
93         }
94         outstream.write(this.content);
95         outstream.flush();
96     }
97 
98     /**
99      * Tells that this entity is not streaming.
100      *
101      * @return <code>false</code>
102      */
isStreaming()103     public boolean isStreaming() {
104         return false;
105     }
106 
clone()107     public Object clone() throws CloneNotSupportedException {
108         return super.clone();
109     }
110 
111 } // class StringEntity
112