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.fileupload.util;
 
 
 import  org.apache.commons.io.IOUtils;

Utility class for working with streams.

Version:
$Id: Streams.java 1565332 2014-02-06 16:42:19Z ggregory $
 
 public final class Streams {

    
Private constructor, to prevent instantiation. This class has only static methods.
 
     private Streams() {
         // Does nothing
     }

    
Default buffer size for use in copy(InputStream, OutputStream, boolean).
 
     private static final int DEFAULT_BUFFER_SIZE = 8192;

    
Copies the contents of the given InputStream to the given OutputStream. Shortcut for
   copy(pInputStream, pOutputStream, new byte[8192]);
 

Parameters:
inputStream The input stream, which is being read. It is guaranteed, that InputStream.close() is called on the stream.
outputStream The output stream, to which data should be written. May be null, in which case the input streams contents are simply discarded.
closeOutputStream True guarantees, that OutputStream.close() is called on the stream. False indicates, that only OutputStream.flush() should be called finally.
Returns:
Number of bytes, which have been copied.
Throws:
IOException An I/O error occurred.
 
     public static long copy(InputStream inputStreamOutputStream outputStreamboolean closeOutputStream)
             throws IOException {
         return copy(inputStreamoutputStreamcloseOutputStreamnew byte[]);
     }

    
Copies the contents of the given InputStream to the given OutputStream.

Parameters:
inputStream The input stream, which is being read. It is guaranteed, that InputStream.close() is called on the stream.
outputStream The output stream, to which data should be written. May be null, in which case the input streams contents are simply discarded.
closeOutputStream True guarantees, that OutputStream.close() is called on the stream. False indicates, that only OutputStream.flush() should be called finally.
buffer Temporary buffer, which is to be used for copying data.
Returns:
Number of bytes, which have been copied.
Throws:
IOException An I/O error occurred.
 
     public static long copy(InputStream inputStream,
             OutputStream outputStreamboolean closeOutputStream,
             byte[] buffer)
     throws IOException {
         OutputStream out = outputStream;
         InputStream in = inputStream;
         try {
             long total = 0;
             for (;;) {
                int res = in.read(buffer);
                if (res == -1) {
                    break;
                }
                if (res > 0) {
                    total += res;
                    if (out != null) {
                        out.write(buffer, 0, res);
                    }
                }
            }
            if (out != null) {
                if (closeOutputStream) {
                    out.close();
                } else {
                    out.flush();
                }
                out = null;
            }
            in.close();
            in = null;
            return total;
        } finally {
            IOUtils.closeQuietly(in);
            if (closeOutputStream) {
                IOUtils.closeQuietly(out);
            }
        }
    }

    
This convenience method allows to read a org.apache.commons.fileupload.FileItemStream's content into a string. The platform's default character encoding is used for converting bytes into characters.

Parameters:
inputStream The input stream to read.
Returns:
The streams contents, as a string.
Throws:
IOException An I/O error occurred.
See also:
asString(InputStream, String)
    public static String asString(InputStream inputStreamthrows IOException {
        ByteArrayOutputStream baos = new ByteArrayOutputStream();
        copy(inputStreambaostrue);
        return baos.toString();
    }

    
This convenience method allows to read a org.apache.commons.fileupload.FileItemStream's content into a string, using the given character encoding.

Parameters:
inputStream The input stream to read.
encoding The character encoding, typically "UTF-8".
Returns:
The streams contents, as a string.
Throws:
IOException An I/O error occurred.
See also:
asString(InputStream)
    public static String asString(InputStream inputStreamString encodingthrows IOException {
        ByteArrayOutputStream baos = new ByteArrayOutputStream();
        copy(inputStreambaostrue);
        return baos.toString(encoding);
    }

    
Checks, whether the given file name is valid in the sense, that it doesn't contain any NUL characters. If the file name is valid, it will be returned without any modifications. Otherwise, an InvalidFileNameException is raised.

Parameters:
fileName The file name to check
Returns:
Unmodified file name, if valid.
Throws:
InvalidFileNameException The file name was found to be invalid.
    public static String checkFileName(String fileName) {
        if (fileName != null  &&  fileName.indexOf('\u0000') != -1) {
            // pFileName.replace("\u0000", "\\0")
            final StringBuilder sb = new StringBuilder();
            for (int i = 0;  i < fileName.length();  i++) {
                char c = fileName.charAt(i);
                switch (c) {
                    case 0:
                        sb.append("\\0");
                        break;
                    default:
                        sb.append(c);
                        break;
                }
            }
            throw new InvalidFileNameException(fileName,
                    "Invalid file name: " + sb);
        }
        return fileName;
    }
New to GrepCode? Check out our FAQ X