Home | History | Annotate | Download | only in entity 
      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 public class StringEntity extends AbstractHttpEntity implements Cloneable {
     52 
     53     protected final byte[] content;
     54 
     55     public StringEntity(final String s, String charset)
     56             throws UnsupportedEncodingException {
     57         super();
     58         if (s == null) {
     59             throw new IllegalArgumentException("Source string may not be null");
     60         }
     61         if (charset == null) {
     62             charset = HTTP.DEFAULT_CONTENT_CHARSET;
     63         }
     64         this.content = s.getBytes(charset);
     65         setContentType(HTTP.PLAIN_TEXT_TYPE + HTTP.CHARSET_PARAM + charset);
     66     }
     67 
     68     public StringEntity(final String s)
     69             throws UnsupportedEncodingException {
     70         this(s, null);
     71     }
     72 
     73     public boolean isRepeatable() {
     74         return true;
     75     }
     76 
     77     public long getContentLength() {
     78         return this.content.length;
     79     }
     80 
     81     public InputStream getContent() throws IOException {
     82         return new ByteArrayInputStream(this.content);
     83     }
     84 
     85     public void writeTo(final OutputStream outstream) throws IOException {
     86         if (outstream == null) {
     87             throw new IllegalArgumentException("Output stream may not be null");
     88         }
     89         outstream.write(this.content);
     90         outstream.flush();
     91     }
     92 
     93     /**
     94      * Tells that this entity is not streaming.
     95      *
     96      * @return <code>false</code>
     97      */
     98     public boolean isStreaming() {
     99         return false;
    100     }
    101 
    102     public Object clone() throws CloneNotSupportedException {
    103         return super.clone();
    104     }
    105 
    106 } // class StringEntity
    107