michael@0: /*
michael@0:  * ====================================================================
michael@0:  * Licensed to the Apache Software Foundation (ASF) under one
michael@0:  * or more contributor license agreements.  See the NOTICE file
michael@0:  * distributed with this work for additional information
michael@0:  * regarding copyright ownership.  The ASF licenses this file
michael@0:  * to you under the Apache License, Version 2.0 (the
michael@0:  * "License"); you may not use this file except in compliance
michael@0:  * with the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *   http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  * Unless required by applicable law or agreed to in writing,
michael@0:  * software distributed under the License is distributed on an
michael@0:  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0:  * KIND, either express or implied.  See the License for the
michael@0:  * specific language governing permissions and limitations
michael@0:  * under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib.entity;
michael@0: 
michael@0: import java.io.ByteArrayInputStream;
michael@0: import java.io.IOException;
michael@0: import java.io.InputStream;
michael@0: import java.io.OutputStream;
michael@0: import java.io.UnsupportedEncodingException;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.protocol.HTTP;
michael@0: 
michael@0: /**
michael@0:  * A self contained, repeatable entity that obtains its content from
michael@0:  * a {@link String}.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public class StringEntity extends AbstractHttpEntity implements Cloneable {
michael@0: 
michael@0:     protected final byte[] content;
michael@0: 
michael@0:     /**
michael@0:      * Creates a StringEntity with the specified content, mimetype and charset
michael@0:      *
michael@0:      * @param string content to be used. Not {@code null}.
michael@0:      * @param mimeType mime type to be used. May be {@code null}, in which case the default is {@link HTTP#PLAIN_TEXT_TYPE} i.e. "text/plain"
michael@0:      * @param charset character set to be used. May be {@code null}, in which case the default is {@link HTTP#DEFAULT_CONTENT_CHARSET} i.e. "ISO-8859-1"
michael@0:      *
michael@0:      * @since 4.1
michael@0:      * @throws IllegalArgumentException if the string parameter is null
michael@0:      */
michael@0:     public StringEntity(final String string, String mimeType, String charset)
michael@0:             throws UnsupportedEncodingException {
michael@0:         super();
michael@0:         if (string == null) {
michael@0:             throw new IllegalArgumentException("Source string may not be null");
michael@0:         }
michael@0:         if (mimeType == null) {
michael@0:             mimeType = HTTP.PLAIN_TEXT_TYPE;
michael@0:         }
michael@0:         if (charset == null) {
michael@0:             charset = HTTP.DEFAULT_CONTENT_CHARSET;
michael@0:         }
michael@0:         this.content = string.getBytes(charset);
michael@0:         setContentType(mimeType + HTTP.CHARSET_PARAM + charset);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Creates a StringEntity with the specified content and charset.
michael@0:      * <br/>
michael@0:      * The mime type defaults to {@link HTTP#PLAIN_TEXT_TYPE} i.e. "text/plain".
michael@0:      *
michael@0:      * @param string content to be used. Not {@code null}.
michael@0:      * @param charset character set to be used. May be {@code null}, in which case the default is {@link HTTP#DEFAULT_CONTENT_CHARSET} i.e. "ISO-8859-1"
michael@0:      *
michael@0:      * @throws IllegalArgumentException if the string parameter is null
michael@0:      */
michael@0:     public StringEntity(final String string, String charset)
michael@0:             throws UnsupportedEncodingException {
michael@0:         this(string, null, charset);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Creates a StringEntity with the specified content and charset.
michael@0:      * <br/>
michael@0:      * The charset defaults to {@link HTTP#DEFAULT_CONTENT_CHARSET} i.e. "ISO-8859-1".
michael@0:      * <br/>
michael@0:      * The mime type defaults to {@link HTTP#PLAIN_TEXT_TYPE} i.e. "text/plain".
michael@0:      *
michael@0:      * @param string content to be used. Not {@code null}.
michael@0:      *
michael@0:      * @throws IllegalArgumentException if the string parameter is null
michael@0:      */
michael@0:     public StringEntity(final String string)
michael@0:             throws UnsupportedEncodingException {
michael@0:         this(string, null);
michael@0:     }
michael@0: 
michael@0:     public boolean isRepeatable() {
michael@0:         return true;
michael@0:     }
michael@0: 
michael@0:     public long getContentLength() {
michael@0:         return this.content.length;
michael@0:     }
michael@0: 
michael@0:     public InputStream getContent() throws IOException {
michael@0:         return new ByteArrayInputStream(this.content);
michael@0:     }
michael@0: 
michael@0:     public void writeTo(final OutputStream outstream) throws IOException {
michael@0:         if (outstream == null) {
michael@0:             throw new IllegalArgumentException("Output stream may not be null");
michael@0:         }
michael@0:         outstream.write(this.content);
michael@0:         outstream.flush();
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Tells that this entity is not streaming.
michael@0:      *
michael@0:      * @return <code>false</code>
michael@0:      */
michael@0:     public boolean isStreaming() {
michael@0:         return false;
michael@0:     }
michael@0: 
michael@0:     public Object clone() throws CloneNotSupportedException {
michael@0:         return super.clone();
michael@0:     }
michael@0: 
michael@0: } // class StringEntity