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.tomcat.util.http.fileupload;
 
General IO stream manipulation utilities.

This class provides static utility methods for input/output operations.

  • closeQuietly - these methods close a stream ignoring nulls and exceptions
  • toXxx/read - these methods read data from a stream
  • write - these methods write data to a stream
  • copy - these methods copy all the data from one stream to another
  • contentEquals - these methods compare the content of two streams

The byte-to-char methods and char-to-byte methods involve a conversion step. Two methods are provided in each case, one that uses the platform default encoding and the other which allows you to specify an encoding. You are encouraged to always specify an encoding because relying on the platform default can lead to unexpected results, for example when moving from development to production.

All the methods in this class that read a stream are buffered internally. This means that there is no cause to use a BufferedInputStream or BufferedReader. The default buffer size of 4K has been shown to be efficient in tests.

Wherever possible, the methods in this class do not flush or close the stream. This is to avoid making non-portable assumptions about the streams' origin and further use. Thus the caller is still responsible for closing streams after use.

Origin of code: Excalibur.

Author(s):
Peter Donald
Jeff Turner
Matthew Hawthorne
Stephen Colebourne
Gareth Davis
Ian Springer
Niall Pemberton
Sandy McArthur
Version:
$Id: IOUtils.java 881493 2009-11-17 20:30:39Z markt $
 
 public class IOUtils {
     // NOTE: This class is focussed on InputStream, OutputStream, Reader and
     // Writer. Each method should take at least one of these as a parameter,
     // or return one of them.
 
    
The default buffer size to use.
 
     private static final int DEFAULT_BUFFER_SIZE = 1024 * 4;

    
Instances should NOT be constructed in standard programming.
 
     public IOUtils() {
         super();
     }


    
Unconditionally close an InputStream.

Equivalent to java.io.InputStream.close(), except any exceptions will be ignored. This is typically used in finally blocks.

Parameters:
input the InputStream to close, may be null or already closed
 
     public static void closeQuietly(InputStream input) {
         try {
             if (input != null) {
                 input.close();
             }
         } catch (IOException ioe) {
             // ignore
         }
     }
    // copy from InputStream
    //-----------------------------------------------------------------------
    
Copy bytes from an InputStream to an OutputStream.

This method buffers the input internally, so there is no need to use a BufferedInputStream.

Large streams (over 2GB) will return a bytes copied value of -1 after the copy has completed since the correct number of bytes cannot be returned as an int. For large streams use the copyLarge(InputStream, OutputStream) method.

Parameters:
input the InputStream to read from
output the OutputStream to write to
Returns:
the number of bytes copied
Throws:
java.lang.NullPointerException if the input or output is null
java.io.IOException if an I/O error occurs
java.lang.ArithmeticException if the byte count is too large
Since:
Commons IO 1.1
    public static int copy(InputStream inputOutputStream outputthrows IOException {
        long count = copyLarge(inputoutput);
        if (count > .) {
            return -1;
        }
        return (intcount;
    }

    
Copy bytes from a large (over 2GB) InputStream to an OutputStream.

This method buffers the input internally, so there is no need to use a BufferedInputStream.

Parameters:
input the InputStream to read from
output the OutputStream to write to
Returns:
the number of bytes copied
Throws:
java.lang.NullPointerException if the input or output is null
java.io.IOException if an I/O error occurs
Since:
Commons IO 1.3
    public static long copyLarge(InputStream inputOutputStream output)
            throws IOException {
        byte[] buffer = new byte[];
        long count = 0;
        int n = 0;
        while (-1 != (n = input.read(buffer))) {
            output.write(buffer, 0, n);
            count += n;
        }
        return count;
    }
    
    
New to GrepCode? Check out our FAQ X