View Javadoc
1 package org.apache.commons.net.io; 2 3 /* ==================================================================== 4 * The Apache Software License, Version 1.1 5 * 6 * Copyright (c) 2001 The Apache Software Foundation. All rights 7 * reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in 18 * the documentation and/or other materials provided with the 19 * distribution. 20 * 21 * 3. The end-user documentation included with the redistribution, 22 * if any, must include the following acknowledgment: 23 * "This product includes software developed by the 24 * Apache Software Foundation (http://www.apache.org/)." 25 * Alternately, this acknowledgment may appear in the software itself, 26 * if and wherever such third-party acknowledgments normally appear. 27 * 28 * 4. The names "Apache" and "Apache Software Foundation" and 29 * "Apache Commons" must not be used to endorse or promote products 30 * derived from this software without prior written permission. For 31 * written permission, please contact apache@apache.org. 32 * 33 * 5. Products derived from this software may not be called "Apache", 34 * nor may "Apache" appear in their name, without 35 * prior written permission of the Apache Software Foundation. 36 * 37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 48 * SUCH DAMAGE. 49 * ==================================================================== 50 * 51 * This software consists of voluntary contributions made by many 52 * individuals on behalf of the Apache Software Foundation. For more 53 * information on the Apache Software Foundation, please see 54 * <http://www.apache.org/>;. 55 */ 56 57 import java.io.FilterOutputStream; 58 import java.io.IOException; 59 import java.io.OutputStream; 60 import java.net.Socket; 61 62 /**** 63 * This class wraps an output stream, storing a reference to its originating 64 * socket. When the stream is closed, it will also close the socket 65 * immediately afterward. This class is useful for situations where you 66 * are dealing with a stream originating from a socket, but do not have 67 * a reference to the socket, and want to make sure it closes when the 68 * stream closes. 69 * <p> 70 * <p> 71 * @author Daniel F. Savarese 72 * @see SocketInputStream 73 ***/ 74 75 public class SocketOutputStream extends FilterOutputStream 76 { 77 private Socket __socket; 78 79 /**** 80 * Creates a SocketOutputStream instance wrapping an output stream and 81 * storing a reference to a socket that should be closed on closing 82 * the stream. 83 * <p> 84 * @param socket The socket to close on closing the stream. 85 * @param stream The input stream to wrap. 86 ***/ 87 public SocketOutputStream(Socket socket, OutputStream stream) 88 { 89 super(stream); 90 __socket = socket; 91 } 92 93 94 /**** 95 * Writes a number of bytes from a byte array to the stream starting from 96 * a given offset. This method bypasses the equivalent method in 97 * FilterOutputStream because the FilterOutputStream implementation is 98 * very inefficient. 99 * <p> 100 * @param buffer The byte array to write. 101 * @param offset The offset into the array at which to start copying data. 102 * @param length The number of bytes to write. 103 * @exception IOException If an error occurs while writing to the underlying 104 * stream. 105 ***/ 106 public void write(byte buffer[], int offset, int length) throws IOException 107 { 108 out.write(buffer, offset, length); 109 } 110 111 112 /**** 113 * Closes the stream and immediately afterward closes the referenced 114 * socket. 115 * <p> 116 * @exception IOException If there is an error in closing the stream 117 * or socket. 118 ***/ 119 public void close() throws IOException 120 { 121 super.close(); 122 __socket.close(); 123 } 124 }

This page was automatically generated by Maven