Thu, 22 Jan 2015 13:21:57 +0100
Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6
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.impl.io; |
michael@0 | 29 | |
michael@0 | 30 | import java.io.IOException; |
michael@0 | 31 | import java.io.OutputStream; |
michael@0 | 32 | |
michael@0 | 33 | import ch.boye.httpclientandroidlib.io.SessionOutputBuffer; |
michael@0 | 34 | |
michael@0 | 35 | /** |
michael@0 | 36 | * Output stream that writes data without any transformation. The end of |
michael@0 | 37 | * the content entity is demarcated by closing the underlying connection |
michael@0 | 38 | * (EOF condition). Entities transferred using this input stream can be of |
michael@0 | 39 | * unlimited length. |
michael@0 | 40 | * <p> |
michael@0 | 41 | * Note that this class NEVER closes the underlying stream, even when close |
michael@0 | 42 | * gets called. Instead, the stream will be marked as closed and no further |
michael@0 | 43 | * output will be permitted. |
michael@0 | 44 | * |
michael@0 | 45 | * @since 4.0 |
michael@0 | 46 | */ |
michael@0 | 47 | public class IdentityOutputStream extends OutputStream { |
michael@0 | 48 | |
michael@0 | 49 | /** |
michael@0 | 50 | * Wrapped session output buffer. |
michael@0 | 51 | */ |
michael@0 | 52 | private final SessionOutputBuffer out; |
michael@0 | 53 | |
michael@0 | 54 | /** True if the stream is closed. */ |
michael@0 | 55 | private boolean closed = false; |
michael@0 | 56 | |
michael@0 | 57 | public IdentityOutputStream(final SessionOutputBuffer out) { |
michael@0 | 58 | super(); |
michael@0 | 59 | if (out == null) { |
michael@0 | 60 | throw new IllegalArgumentException("Session output buffer may not be null"); |
michael@0 | 61 | } |
michael@0 | 62 | this.out = out; |
michael@0 | 63 | } |
michael@0 | 64 | |
michael@0 | 65 | /** |
michael@0 | 66 | * <p>Does not close the underlying socket output.</p> |
michael@0 | 67 | * |
michael@0 | 68 | * @throws IOException If an I/O problem occurs. |
michael@0 | 69 | */ |
michael@0 | 70 | public void close() throws IOException { |
michael@0 | 71 | if (!this.closed) { |
michael@0 | 72 | this.closed = true; |
michael@0 | 73 | this.out.flush(); |
michael@0 | 74 | } |
michael@0 | 75 | } |
michael@0 | 76 | |
michael@0 | 77 | public void flush() throws IOException { |
michael@0 | 78 | this.out.flush(); |
michael@0 | 79 | } |
michael@0 | 80 | |
michael@0 | 81 | public void write(byte[] b, int off, int len) throws IOException { |
michael@0 | 82 | if (this.closed) { |
michael@0 | 83 | throw new IOException("Attempted write to closed stream."); |
michael@0 | 84 | } |
michael@0 | 85 | this.out.write(b, off, len); |
michael@0 | 86 | } |
michael@0 | 87 | |
michael@0 | 88 | public void write(byte[] b) throws IOException { |
michael@0 | 89 | write(b, 0, b.length); |
michael@0 | 90 | } |
michael@0 | 91 | |
michael@0 | 92 | public void write(int b) throws IOException { |
michael@0 | 93 | if (this.closed) { |
michael@0 | 94 | throw new IOException("Attempted write to closed stream."); |
michael@0 | 95 | } |
michael@0 | 96 | this.out.write(b); |
michael@0 | 97 | } |
michael@0 | 98 | |
michael@0 | 99 | } |