mobile/android/thirdparty/ch/boye/httpclientandroidlib/entity/StringEntity.java@fc2d59ddac77 (annotated)
mobile/android/thirdparty/ch/boye/httpclientandroidlib/entity/StringEntity.java
Wed, 31 Dec 2014 07:22:50 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 07:22:50 +0100
- branch
- TOR_BUG_3246
- changeset 4
- fc2d59ddac77
- permissions
- -rw-r--r--
Correct previous dual key logic pending first delivery installment.
| michael@0 | 1 | /* |
| michael@0 | 2 | * ==================================================================== |
| michael@0 | 3 | * Licensed to the Apache Software Foundation (ASF) under one |
| michael@0 | 4 | * or more contributor license agreements. See the NOTICE file |
| michael@0 | 5 | * distributed with this work for additional information |
| michael@0 | 6 | * regarding copyright ownership. The ASF licenses this file |
| michael@0 | 7 | * to you under the Apache License, Version 2.0 (the |
| michael@0 | 8 | * "License"); you may not use this file except in compliance |
| michael@0 | 9 | * with the License. You may obtain a copy of the License at |
| michael@0 | 10 | * |
| michael@0 | 11 | * http://www.apache.org/licenses/LICENSE-2.0 |
| michael@0 | 12 | * |
| michael@0 | 13 | * Unless required by applicable law or agreed to in writing, |
| michael@0 | 14 | * software distributed under the License is distributed on an |
| michael@0 | 15 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| michael@0 | 16 | * KIND, either express or implied. See the License for the |
| michael@0 | 17 | * specific language governing permissions and limitations |
| michael@0 | 18 | * under the License. |
| michael@0 | 19 | * ==================================================================== |
| michael@0 | 20 | * |
| michael@0 | 21 | * This software consists of voluntary contributions made by many |
| michael@0 | 22 | * individuals on behalf of the Apache Software Foundation. For more |
| michael@0 | 23 | * information on the Apache Software Foundation, please see |
| michael@0 | 24 | * <http://www.apache.org/>. |
| michael@0 | 25 | * |
| michael@0 | 26 | */ |
| michael@0 | 27 | |
| michael@0 | 28 | package ch.boye.httpclientandroidlib.entity; |
| michael@0 | 29 | |
| michael@0 | 30 | import java.io.ByteArrayInputStream; |
| michael@0 | 31 | import java.io.IOException; |
| michael@0 | 32 | import java.io.InputStream; |
| michael@0 | 33 | import java.io.OutputStream; |
| michael@0 | 34 | import java.io.UnsupportedEncodingException; |
| michael@0 | 35 | |
| michael@0 | 36 | import ch.boye.httpclientandroidlib.protocol.HTTP; |
| michael@0 | 37 | |
| michael@0 | 38 | /** |
| michael@0 | 39 | * A self contained, repeatable entity that obtains its content from |
| michael@0 | 40 | * a {@link String}. |
| michael@0 | 41 | * |
| michael@0 | 42 | * @since 4.0 |
| michael@0 | 43 | */ |
| michael@0 | 44 | public class StringEntity extends AbstractHttpEntity implements Cloneable { |
| michael@0 | 45 | |
| michael@0 | 46 | protected final byte[] content; |
| michael@0 | 47 | |
| michael@0 | 48 | /** |
| michael@0 | 49 | * Creates a StringEntity with the specified content, mimetype and charset |
| michael@0 | 50 | * |
| michael@0 | 51 | * @param string content to be used. Not {@code null}. |
| michael@0 | 52 | * @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 | 53 | * @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 | 54 | * |
| michael@0 | 55 | * @since 4.1 |
| michael@0 | 56 | * @throws IllegalArgumentException if the string parameter is null |
| michael@0 | 57 | */ |
| michael@0 | 58 | public StringEntity(final String string, String mimeType, String charset) |
| michael@0 | 59 | throws UnsupportedEncodingException { |
| michael@0 | 60 | super(); |
| michael@0 | 61 | if (string == null) { |
| michael@0 | 62 | throw new IllegalArgumentException("Source string may not be null"); |
| michael@0 | 63 | } |
| michael@0 | 64 | if (mimeType == null) { |
| michael@0 | 65 | mimeType = HTTP.PLAIN_TEXT_TYPE; |
| michael@0 | 66 | } |
| michael@0 | 67 | if (charset == null) { |
| michael@0 | 68 | charset = HTTP.DEFAULT_CONTENT_CHARSET; |
| michael@0 | 69 | } |
| michael@0 | 70 | this.content = string.getBytes(charset); |
| michael@0 | 71 | setContentType(mimeType + HTTP.CHARSET_PARAM + charset); |
| michael@0 | 72 | } |
| michael@0 | 73 | |
| michael@0 | 74 | /** |
| michael@0 | 75 | * Creates a StringEntity with the specified content and charset. |
| michael@0 | 76 | * <br/> |
| michael@0 | 77 | * The mime type defaults to {@link HTTP#PLAIN_TEXT_TYPE} i.e. "text/plain". |
| michael@0 | 78 | * |
| michael@0 | 79 | * @param string content to be used. Not {@code null}. |
| michael@0 | 80 | * @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 | 81 | * |
| michael@0 | 82 | * @throws IllegalArgumentException if the string parameter is null |
| michael@0 | 83 | */ |
| michael@0 | 84 | public StringEntity(final String string, String charset) |
| michael@0 | 85 | throws UnsupportedEncodingException { |
| michael@0 | 86 | this(string, null, charset); |
| michael@0 | 87 | } |
| michael@0 | 88 | |
| michael@0 | 89 | /** |
| michael@0 | 90 | * Creates a StringEntity with the specified content and charset. |
| michael@0 | 91 | * <br/> |
| michael@0 | 92 | * The charset defaults to {@link HTTP#DEFAULT_CONTENT_CHARSET} i.e. "ISO-8859-1". |
| michael@0 | 93 | * <br/> |
| michael@0 | 94 | * The mime type defaults to {@link HTTP#PLAIN_TEXT_TYPE} i.e. "text/plain". |
| michael@0 | 95 | * |
| michael@0 | 96 | * @param string content to be used. Not {@code null}. |
| michael@0 | 97 | * |
| michael@0 | 98 | * @throws IllegalArgumentException if the string parameter is null |
| michael@0 | 99 | */ |
| michael@0 | 100 | public StringEntity(final String string) |
| michael@0 | 101 | throws UnsupportedEncodingException { |
| michael@0 | 102 | this(string, null); |
| michael@0 | 103 | } |
| michael@0 | 104 | |
| michael@0 | 105 | public boolean isRepeatable() { |
| michael@0 | 106 | return true; |
| michael@0 | 107 | } |
| michael@0 | 108 | |
| michael@0 | 109 | public long getContentLength() { |
| michael@0 | 110 | return this.content.length; |
| michael@0 | 111 | } |
| michael@0 | 112 | |
| michael@0 | 113 | public InputStream getContent() throws IOException { |
| michael@0 | 114 | return new ByteArrayInputStream(this.content); |
| michael@0 | 115 | } |
| michael@0 | 116 | |
| michael@0 | 117 | public void writeTo(final OutputStream outstream) throws IOException { |
| michael@0 | 118 | if (outstream == null) { |
| michael@0 | 119 | throw new IllegalArgumentException("Output stream may not be null"); |
| michael@0 | 120 | } |
| michael@0 | 121 | outstream.write(this.content); |
| michael@0 | 122 | outstream.flush(); |
| michael@0 | 123 | } |
| michael@0 | 124 | |
| michael@0 | 125 | /** |
| michael@0 | 126 | * Tells that this entity is not streaming. |
| michael@0 | 127 | * |
| michael@0 | 128 | * @return <code>false</code> |
| michael@0 | 129 | */ |
| michael@0 | 130 | public boolean isStreaming() { |
| michael@0 | 131 | return false; |
| michael@0 | 132 | } |
| michael@0 | 133 | |
| michael@0 | 134 | public Object clone() throws CloneNotSupportedException { |
| michael@0 | 135 | return super.clone(); |
| michael@0 | 136 | } |
| michael@0 | 137 | |
| michael@0 | 138 | } // class StringEntity |
