Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * 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.
  */
 
 package org.apache.commons.net.io;
 
 import java.io.Reader;
 import java.io.Writer;
The Util class cannot be instantiated and stores short static convenience methods that are often quite useful.

 
 
 public final class Util
 {
    
The default buffer size () used by copyStream and copyReader and by the copyReader/copyStream methods if a zero or negative buffer size is supplied.
 
     public static final int DEFAULT_COPY_BUFFER_SIZE = 1024;
 
     // Cannot be instantiated
     private Util()
     { }


    
Copies the contents of an InputStream to an OutputStream using a copy buffer of a given size and notifies the provided CopyStreamListener of the progress of the copy operation by calling its bytesTransferred(long, int) method after each write to the destination. If you wish to notify more than one listener you should use a CopyStreamAdapter as the listener and register the additional listeners with the CopyStreamAdapter.

The contents of the InputStream are read until the end of the stream is reached, but neither the source nor the destination are closed. You must do this yourself outside of the method call. The number of bytes read/written is returned.

Parameters:
source The source InputStream.
dest The destination OutputStream.
bufferSize The number of bytes to buffer during the copy. A zero or negative value means to use DEFAULT_COPY_BUFFER_SIZE.
streamSize The number of bytes in the stream being copied. Should be set to CopyStreamEvent.UNKNOWN_STREAM_SIZE if unknown.
listener The CopyStreamListener to notify of progress. If this parameter is null, notification is not attempted.
flush Whether to flush the output stream after every write. This is necessary for interactive sessions that rely on buffered streams. If you don't flush, the data will stay in the stream buffer.
Throws:
CopyStreamException If an error occurs while reading from the source or writing to the destination. The CopyStreamException will contain the number of bytes confirmed to have been transferred before an IOException occurred, and it will also contain the IOException that caused the error. These values can be retrieved with the CopyStreamException getTotalBytesTransferred() and getIOException() methods.
 
     public static final long copyStream(InputStream sourceOutputStream dest,
                                         int bufferSizelong streamSize,
                                         CopyStreamListener listener,
                                         boolean flush)
     throws CopyStreamException
     {
         int bytes;
         long total = 0;
         byte[] buffer = new byte[bufferSize >= 0 ? bufferSize : ];
 
         try
         {
            while ((bytes = source.read(buffer)) != -1)
            {
                // Technically, some read(byte[]) methods may return 0 and we cannot
                // accept that as an indication of EOF.
                if (bytes == 0)
                {
                    bytes = source.read();
                    if (bytes < 0) {
                        break;
                    }
                    dest.write(bytes);
                    if(flush) {
                        dest.flush();
                    }
                    ++total;
                    if (listener != null) {
                        listener.bytesTransferred(total, 1, streamSize);
                    }
                    continue;
                }
                dest.write(buffer, 0, bytes);
                if(flush) {
                    dest.flush();
                }
                total += bytes;
                if (listener != null) {
                    listener.bytesTransferred(totalbytesstreamSize);
                }
            }
        }
        catch (IOException e)
        {
            throw new CopyStreamException("IOException caught while copying.",
                                          totale);
        }
        return total;
    }


    
Copies the contents of an InputStream to an OutputStream using a copy buffer of a given size and notifies the provided CopyStreamListener of the progress of the copy operation by calling its bytesTransferred(long, int) method after each write to the destination. If you wish to notify more than one listener you should use a CopyStreamAdapter as the listener and register the additional listeners with the CopyStreamAdapter.

The contents of the InputStream are read until the end of the stream is reached, but neither the source nor the destination are closed. You must do this yourself outside of the method call. The number of bytes read/written is returned.

Parameters:
source The source InputStream.
dest The destination OutputStream.
bufferSize The number of bytes to buffer during the copy. A zero or negative value means to use DEFAULT_COPY_BUFFER_SIZE.
streamSize The number of bytes in the stream being copied. Should be set to CopyStreamEvent.UNKNOWN_STREAM_SIZE if unknown.
listener The CopyStreamListener to notify of progress. If this parameter is null, notification is not attempted.
Throws:
CopyStreamException If an error occurs while reading from the source or writing to the destination. The CopyStreamException will contain the number of bytes confirmed to have been transferred before an IOException occurred, and it will also contain the IOException that caused the error. These values can be retrieved with the CopyStreamException getTotalBytesTransferred() and getIOException() methods.
    public static final long copyStream(InputStream sourceOutputStream dest,
                                        int bufferSizelong streamSize,
                                        CopyStreamListener listener)
    throws CopyStreamException
    {
      return copyStream(sourcedestbufferSizestreamSizelistener,
                        true);
    }


    
Copies the contents of an InputStream to an OutputStream using a copy buffer of a given size. The contents of the InputStream are read until the end of the stream is reached, but neither the source nor the destination are closed. You must do this yourself outside of the method call. The number of bytes read/written is returned.

Parameters:
source The source InputStream.
dest The destination OutputStream.
bufferSize The number of bytes to buffer during the copy. A zero or negative value means to use DEFAULT_COPY_BUFFER_SIZE.
Returns:
The number of bytes read/written in the copy operation.
Throws:
CopyStreamException If an error occurs while reading from the source or writing to the destination. The CopyStreamException will contain the number of bytes confirmed to have been transferred before an IOException occurred, and it will also contain the IOException that caused the error. These values can be retrieved with the CopyStreamException getTotalBytesTransferred() and getIOException() methods.
    public static final long copyStream(InputStream sourceOutputStream dest,
                                        int bufferSize)
    throws CopyStreamException
    {
        return copyStream(sourcedestbufferSize,
                          .null);
    }


    
Same as copyStream(source, dest, DEFAULT_COPY_BUFFER_SIZE);
    public static final long copyStream(InputStream sourceOutputStream dest)
    throws CopyStreamException
    {
        return copyStream(sourcedest);
    }


    
Copies the contents of a Reader to a Writer using a copy buffer of a given size and notifies the provided CopyStreamListener of the progress of the copy operation by calling its bytesTransferred(long, int) method after each write to the destination. If you wish to notify more than one listener you should use a CopyStreamAdapter as the listener and register the additional listeners with the CopyStreamAdapter.

The contents of the Reader are read until its end is reached, but neither the source nor the destination are closed. You must do this yourself outside of the method call. The number of characters read/written is returned.

Parameters:
source The source Reader.
dest The destination writer.
bufferSize The number of characters to buffer during the copy. A zero or negative value means to use DEFAULT_COPY_BUFFER_SIZE.
streamSize The number of characters in the stream being copied. Should be set to CopyStreamEvent.UNKNOWN_STREAM_SIZE if unknown.
listener The CopyStreamListener to notify of progress. If this parameter is null, notification is not attempted.
Returns:
The number of characters read/written in the copy operation.
Throws:
CopyStreamException If an error occurs while reading from the source or writing to the destination. The CopyStreamException will contain the number of bytes confirmed to have been transferred before an IOException occurred, and it will also contain the IOException that caused the error. These values can be retrieved with the CopyStreamException getTotalBytesTransferred() and getIOException() methods.
    public static final long copyReader(Reader sourceWriter dest,
                                        int bufferSizelong streamSize,
                                        CopyStreamListener listener)
    throws CopyStreamException
    {
        int chars;
        long total = 0;
        char[] buffer = new char[bufferSize >= 0 ? bufferSize : ];
        try
        {
            while ((chars = source.read(buffer)) != -1)
            {
                // Technically, some read(char[]) methods may return 0 and we cannot
                // accept that as an indication of EOF.
                if (chars == 0)
                {
                    chars = source.read();
                    if (chars < 0) {
                        break;
                    }
                    dest.write(chars);
                    dest.flush();
                    ++total;
                    if (listener != null) {
                        listener.bytesTransferred(totalcharsstreamSize);
                    }
                    continue;
                }
                dest.write(buffer, 0, chars);
                dest.flush();
                total += chars;
                if (listener != null) {
                    listener.bytesTransferred(totalcharsstreamSize);
                }
            }
        }
        catch (IOException e)
        {
            throw new CopyStreamException("IOException caught while copying.",
                                          totale);
        }
        return total;
    }


    
Copies the contents of a Reader to a Writer using a copy buffer of a given size. The contents of the Reader are read until its end is reached, but neither the source nor the destination are closed. You must do this yourself outside of the method call. The number of characters read/written is returned.

Parameters:
source The source Reader.
dest The destination writer.
bufferSize The number of characters to buffer during the copy. A zero or negative value means to use DEFAULT_COPY_BUFFER_SIZE.
Returns:
The number of characters read/written in the copy operation.
Throws:
CopyStreamException If an error occurs while reading from the source or writing to the destination. The CopyStreamException will contain the number of bytes confirmed to have been transferred before an IOException occurred, and it will also contain the IOException that caused the error. These values can be retrieved with the CopyStreamException getTotalBytesTransferred() and getIOException() methods.
    public static final long copyReader(Reader sourceWriter dest,
                                        int bufferSize)
    throws CopyStreamException
    {
        return copyReader(sourcedestbufferSize,
                          .null);
    }


    
Same as copyReader(source, dest, DEFAULT_COPY_BUFFER_SIZE);
    public static final long copyReader(Reader sourceWriter dest)
    throws CopyStreamException
    {
        return copyReader(sourcedest);
    }

    
Closes the object quietly, catching rather than throwing IOException. Intended for use from finally blocks.

Parameters:
closeable the object to close, may be null
Since:
3.0
    public static void closeQuietly(Closeable closeable) {
        if (closeable != null) {
            try {
                closeable.close();
            } catch (IOException e) {
            }
        }
    }

    
Closes the socket quietly, catching rather than throwing IOException. Intended for use from finally blocks.

Parameters:
socket the socket to close, may be null
Since:
3.0
    public static void closeQuietly(Socket socket) {
        if (socket != null) {
            try {
                socket.close();
            } catch (IOException e) {
            }
        }
    }
New to GrepCode? Check out our FAQ X