~ubuntu-branches/ubuntu/trusty/httpcomponents-core/trusty

/*

 * $HeadURL: https://svn.apache.org/repos/asf/httpcomponents/httpcore/tags/4.0.1/httpcore/src/main/java/org/apache/http/entity/StringEntity.java $

 * $Revision: 744523 $

 * $Date: 2009-02-14 17:57:41 +0100 (Sat, 14 Feb 2009) $

 *

 * ====================================================================

 * Licensed to the Apache Software Foundation (ASF) under one

 * or more contributor license agreements.  See the NOTICE file

 * distributed with this work for additional information

 * regarding copyright ownership.  The ASF licenses this file

 * to you under the Apache License, Version 2.0 (the

 * "License"); you may not use this file except in compliance

 * with the License.  You may obtain a copy of the License at

 *

 *   http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing,

 * software distributed under the License is distributed on an

 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY

 * KIND, either express or implied.  See the License for the

 * specific language governing permissions and limitations

 * under the License.

 * ====================================================================

 *

 * This software consists of voluntary contributions made by many

 * individuals on behalf of the Apache Software Foundation.  For more

 * information on the Apache Software Foundation, please see

 * <http://www.apache.org/>.

 *

 */

 

package org.apache.http.entity;

 

import java.io.ByteArrayInputStream;

import java.io.IOException;

import java.io.InputStream;

import java.io.OutputStream;

import java.io.UnsupportedEncodingException;

 

import org.apache.http.protocol.HTTP;

 

/**

 * A self contained, repeatable entity that obtains its content from 

 * a {@link String}.

 *

 *

 * @version $Revision: 744523 $

 * 

 * @since 4.0

 */

public class StringEntity extends AbstractHttpEntity implements Cloneable {

 

    protected final byte[] content;

 

    public StringEntity(final String s, String charset) 

            throws UnsupportedEncodingException {

        super();

        if (s == null) {

            throw new IllegalArgumentException("Source string may not be null");

        }

        if (charset == null) {

            charset = HTTP.DEFAULT_CONTENT_CHARSET;

        }

        this.content = s.getBytes(charset);

        setContentType(HTTP.PLAIN_TEXT_TYPE + HTTP.CHARSET_PARAM + charset);

    }

 

    public StringEntity(final String s) 

            throws UnsupportedEncodingException {

        this(s, null);

    }

 

    public boolean isRepeatable() {

        return true;

    }

 

    public long getContentLength() {

        return this.content.length;

    }

    

    public InputStream getContent() throws IOException {

        return new ByteArrayInputStream(this.content);

    }

    

    public void writeTo(final OutputStream outstream) throws IOException {

        if (outstream == null) {

            throw new IllegalArgumentException("Output stream may not be null");

        }

        outstream.write(this.content);

        outstream.flush();

    }

 

    /**

     * Tells that this entity is not streaming.

     *

     * @return <code>false</code>

     */

    public boolean isStreaming() {

        return false;

    }

 

    public Object clone() throws CloneNotSupportedException {

        return super.clone();

    }

 

} // class StringEntity