Description
Copy bytes from a large (over 2GB) InputStream to an OutputStream.
License
Apache License
Parameter
| Parameter | Description |
|---|
| input | the InputStream to read from |
| output | the OutputStream to write to |
Exception
| Parameter | Description |
|---|
| NullPointerException | if the input or output is null |
| IOException | if an I/O error occurs |
Return
the number of bytes copied
Declaration
public static long copyLarge(InputStream input, OutputStream output) throws IOException
Method Source Code
//package com.java2s;
/*/*from w w w . ja v a2 s. c om*/
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* JBoss, Home of Professional Open Source
* Copyright 2011, Red Hat Middleware LLC, and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* Licensed 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.
*/
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.Reader;
import java.io.StringWriter;
import java.io.Writer;
public class Main {
/**
* The default buffer size to use.
*/
private static final int DEFAULT_BUFFER_SIZE = 1024 * 4;
/**
* 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.
*
* @param input the InputStream to read from
* @param output the OutputStream to write to
* @return the number of bytes copied
* @throws NullPointerException if the input or output is null
* @throws IOException if an I/O error occurs
* @since Commons IO 1.3
*/
public static long copyLarge(InputStream input, OutputStream output) throws IOException {
byte[] buffer = new byte[DEFAULT_BUFFER_SIZE];
long count = 0;
int n = 0;
while (-1 != (n = input.read(buffer))) {
output.write(buffer, 0, n);
count += n;
}
return count;
}
/**
* Copy chars from a large (over 2GB) Reader to a Writer.
*
* This method buffers the input internally, so there is no need to use a BufferedReader.
*
* @param input the Reader to read from
* @param output the Writer to write to
* @return the number of characters copied
* @throws NullPointerException if the input or output is null
* @throws IOException if an I/O error occurs
* @since Commons IO 1.3
*/
public static long copyLarge(Reader input, Writer output) throws IOException {
char[] buffer = new char[DEFAULT_BUFFER_SIZE];
long count = 0;
int n = 0;
while (-1 != (n = input.read(buffer))) {
output.write(buffer, 0, n);
count += n;
}
return count;
}
/**
* Writes bytes from a byte[] to an OutputStream.
*
* @param data the byte array to write, do not modify during output, null ignored
* @param output the OutputStream to write to
* @throws NullPointerException if output is null
* @throws IOException if an I/O error occurs
* @since Commons IO 1.1
*/
public static void write(byte[] data, OutputStream output) throws IOException {
if (data != null) {
output.write(data);
}
}
/**
* Writes bytes from a byte[] to chars on a Writer using the default character encoding of the platform.
*
* This method uses {@link String#String(byte[])}.
*
* @param data the byte array to write, do not modify during output, null ignored
* @param output the Writer to write to
* @throws NullPointerException if output is null
* @throws IOException if an I/O error occurs
* @since Commons IO 1.1
*/
public static void write(byte[] data, Writer output) throws IOException {
if (data != null) {
output.write(new String(data));
}
}
/**
* Writes bytes from a byte[] to chars on a Writer using the specified character encoding.
*
* Character encoding names can be found at IANA.
*
* This method uses {@link String#String(byte[], String)}.
*
* @param data the byte array to write, do not modify during output, null ignored
* @param output the Writer to write to
* @param encoding the encoding to use, null means platform default
* @throws NullPointerException if output is null
* @throws IOException if an I/O error occurs
* @since Commons IO 1.1
*/
public static void write(byte[] data, Writer output, String encoding) throws IOException {
if (data != null) {
if (encoding == null) {
write(data, output);
} else {
output.write(new String(data, encoding));
}
}
}
/**
* Writes chars from a char[] to a Writer using the default character encoding of the platform.
*
* @param data the char array to write, do not modify during output, null ignored
* @param output the Writer to write to
* @throws NullPointerException if output is null
* @throws IOException if an I/O error occurs
* @since Commons IO 1.1
*/
public static void write(char[] data, Writer output) throws IOException {
if (data != null) {
output.write(data);
}
}
/**
* Writes chars from a char[] to bytes on an OutputStream.
*
* This method uses {@link String#String(char[])} and {@link String#getBytes()}.
*
* @param data the char array to write, do not modify during output, null ignored
* @param output the OutputStream to write to
* @throws NullPointerException if output is null
* @throws IOException if an I/O error occurs
* @since Commons IO 1.1
*/
public static void write(char[] data, OutputStream output) throws IOException {
if (data != null) {
output.write(new String(data).getBytes());
}
}
/**
* Writes chars from a char[] to bytes on an OutputStream using the specified character encoding.
*
* Character encoding names can be found at IANA.
*
* This method uses {@link String#String(char[])} and {@link String#getBytes(String)}.
*
* @param data the char array to write, do not modify during output, null ignored
* @param output the OutputStream to write to
* @param encoding the encoding to use, null means platform default
* @throws NullPointerException if output is null
* @throws IOException if an I/O error occurs
* @since Commons IO 1.1
*/
public static void write(char[] data, OutputStream output, String encoding) throws IOException {
if (data != null) {
if (encoding == null) {
write(data, output);
} else {
output.write(new String(data).getBytes(encoding));
}
}
}
/**
* Writes chars from a CharSequence to a Writer.
*
* @param data the CharSequence to write, null ignored
* @param output the Writer to write to
* @throws NullPointerException if output is null
* @throws IOException if an I/O error occurs
* @since Commons IO 2.0
*/
public static void write(CharSequence data, Writer output) throws IOException {
if (data != null) {
write(data.toString(), output);
}
}
/**
* Writes chars from a CharSequence to bytes on an OutputStream using the default character encoding of the platform.
*
* This method uses {@link String#getBytes()}.
*
* @param data the CharSequence to write, null ignored
* @param output the OutputStream to write to
* @throws NullPointerException if output is null
* @throws IOException if an I/O error occurs
* @since Commons IO 2.0
*/
public static void write(CharSequence data, OutputStream output) throws IOException {
if (data != null) {
write(data.toString(), output);
}
}
/**
* Writes chars from a CharSequence to bytes on an OutputStream using the specified character encoding.
*
* Character encoding names can be found at IANA.
*
* This method uses {@link String#getBytes(String)}.
*
* @param data the CharSequence to write, null ignored
* @param output the OutputStream to write to
* @param encoding the encoding to use, null means platform default
* @throws NullPointerException if output is null
* @throws IOException if an I/O error occurs
* @since Commons IO 2.0
*/
public static void write(CharSequence data, OutputStream output, String encoding) throws IOException {
if (data != null) {
write(data.toString(), output, encoding);
}
}
/**
* Writes chars from a String to a Writer.
*
* @param data the String to write, null ignored
* @param output the Writer to write to
* @throws NullPointerException if output is null
* @throws IOException if an I/O error occurs
* @since Commons IO 1.1
*/
public static void write(String data, Writer output) throws IOException {
if (data != null) {
output.write(data);
}
}
/**
* Writes chars from a String to bytes on an OutputStream using the default character encoding of the platform.
*
* This method uses {@link String#getBytes()}.
*
* @param data the String to write, null ignored
* @param output the OutputStream to write to
* @throws NullPointerException if output is null
* @throws IOException if an I/O error occurs
* @since Commons IO 1.1
*/
public static void write(String data, OutputStream output) throws IOException {
if (data != null) {
output.write(data.getBytes());
}
}
/**
* Writes chars from a String to bytes on an OutputStream using the specified character encoding.
*
* Character encoding names can be found at IANA.
*
* This method uses {@link String#getBytes(String)}.
*
* @param data the String to write, null ignored
* @param output the OutputStream to write to
* @param encoding the encoding to use, null means platform default
* @throws NullPointerException if output is null
* @throws IOException if an I/O error occurs
* @since Commons IO 1.1
*/
public static void write(String data, OutputStream output, String encoding) throws IOException {
if (data != null) {
if (encoding == null) {
write(data, output);
} else {
output.write(data.getBytes(encoding));
}
}
}
/**
* Writes chars from a StringBuffer to a Writer.
*
* @param data the StringBuffer to write, null ignored
* @param output the Writer to write to
* @throws NullPointerException if output is null
* @throws IOException if an I/O error occurs
* @since Commons IO 1.1
* @deprecated replaced by write(CharSequence, Writer)
*/
@Deprecated
public static void write(StringBuffer data, Writer output) throws IOException {
if (data != null) {
output.write(data.toString());
}
}
/**
* Writes chars from a StringBuffer to bytes on an OutputStream using the default character encoding of the platform.
*
* This method uses {@link String#getBytes()}.
*
* @param data the StringBuffer to write, null ignored
* @param output the OutputStream to write to
* @throws NullPointerException if output is null
* @throws IOException if an I/O error occurs
* @since Commons IO 1.1
* @deprecated replaced by write(CharSequence, OutputStream)
*/
@Deprecated
public static void write(StringBuffer data, OutputStream output) throws IOException {
if (data != null) {
output.write(data.toString().getBytes());
}
}
/**
* Writes chars from a StringBuffer to bytes on an OutputStream using the specified character encoding.
*
* Character encoding names can be found at IANA.
*
* This method uses {@link String#getBytes(String)}.
*
* @param data the StringBuffer to write, null ignored
* @param output the OutputStream to write to
* @param encoding the encoding to use, null means platform default
* @throws NullPointerException if output is null
* @throws IOException if an I/O error occurs
* @since Commons IO 1.1
* @deprecated replaced by write(CharSequence, OutputStream, String)
*/
@Deprecated
public static void write(StringBuffer data, OutputStream output, String encoding) throws IOException {
if (data != null) {
if (encoding == null) {
write(data, output);
} else {
output.write(data.toString().getBytes(encoding));
}
}
}
/**
* Get the contents of an InputStream as a String using the default character encoding of the platform.
*
* This method buffers the input internally, so there is no need to use a BufferedInputStream.
*
* @param input the InputStream to read from
* @return the requested String
* @throws NullPointerException if the input is null
* @throws IOException if an I/O error occurs
*/
public static String toString(InputStream input) throws IOException {
StringWriter sw = new StringWriter();
copy(input, sw);
return sw.toString();
}
/**
* Get the contents of an InputStream as a String using the specified character encoding.
*
* Character encoding names can be found at IANA.
*
* This method buffers the input internally, so there is no need to use a BufferedInputStream.
*
* @param input the InputStream to read from
* @param encoding the encoding to use, null means platform default
* @return the requested String
* @throws NullPointerException if the input is null
* @throws IOException if an I/O error occurs
*/
public static String toString(InputStream input, String encoding) throws IOException {
StringWriter sw = new StringWriter();
copy(input, sw, encoding);
return sw.toString();
}
/**
* Get the contents of a Reader as a String.
*
* This method buffers the input internally, so there is no need to use a BufferedReader.
*
* @param input the Reader to read from
* @return the requested String
* @throws NullPointerException if the input is null
* @throws IOException if an I/O error occurs
*/
public static String toString(Reader input) throws IOException {
StringWriter sw = new StringWriter();
copy(input, sw);
return sw.toString();
}
/**
* Get the contents of a byte[] as a String using the default character encoding of the platform.
*
* @param input the byte array to read from
* @return the requested String
* @throws NullPointerException if the input is null
* @throws IOException if an I/O error occurs (never occurs)
* @deprecated Use {@link String#String(byte[])}
*/
@Deprecated
public static String toString(byte[] input) throws IOException {
return new String(input);
}
/**
* Get the contents of a byte[] as a String using the specified character encoding.
*
* Character encoding names can be found at IANA.
*
* @param input the byte array to read from
* @param encoding the encoding to use, null means platform default
* @return the requested String
* @throws NullPointerException if the input is null
* @throws IOException if an I/O error occurs (never occurs)
* @deprecated Use {@link String#String(byte[],String)}
*/
@Deprecated
public static String toString(byte[] input, String encoding) throws IOException {
if (encoding == null) {
return new String(input);
} else {
return new String(input, encoding);
}
}
/**
* 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.
*
* @param input the InputStream to read from
* @param output the OutputStream to write to
* @return the number of bytes copied
* @throws NullPointerException if the input or output is null
* @throws IOException if an I/O error occurs
* @throws ArithmeticException if the byte count is too large
* @since Commons IO 1.1
*/
public static int copy(InputStream input, OutputStream output) throws IOException {
long count = copyLarge(input, output);
if (count > Integer.MAX_VALUE) {
return -1;
}
return (int) count;
}
/**
* Copy bytes from an InputStream to chars on a Writer using the default character encoding of the platform.
*
* This method buffers the input internally, so there is no need to use a BufferedInputStream.
*
* This method uses {@link InputStreamReader}.
*
* @param input the InputStream to read from
* @param output the Writer to write to
* @throws NullPointerException if the input or output is null
* @throws IOException if an I/O error occurs
* @since Commons IO 1.1
*/
public static void copy(InputStream input, Writer output) throws IOException {
InputStreamReader in = new InputStreamReader(input);
copy(in, output);
}
/**
* Copy bytes from an InputStream to chars on a Writer using the specified character encoding.
*
* This method buffers the input internally, so there is no need to use a BufferedInputStream.
*
* Character encoding names can be found at IANA.
*
* This method uses {@link InputStreamReader}.
*
* @param input the InputStream to read from
* @param output the Writer to write to
* @param encoding the encoding to use, null means platform default
* @throws NullPointerException if the input or output is null
* @throws IOException if an I/O error occurs
* @since Commons IO 1.1
*/
public static void copy(InputStream input, Writer output, String encoding) throws IOException {
if (encoding == null) {
copy(input, output);
} else {
InputStreamReader in = new InputStreamReader(input, encoding);
copy(in, output);
}
}
/**
* Copy chars from a Reader to a Writer.
*
* This method buffers the input internally, so there is no need to use a BufferedReader.
*
* Large streams (over 2GB) will return a chars copied value of -1 after the copy has completed since the correct number of
* chars cannot be returned as an int. For large streams use the copyLarge(Reader, Writer) method.
*
* @param input the Reader to read from
* @param output the Writer to write to
* @return the number of characters copied
* @throws NullPointerException if the input or output is null
* @throws IOException if an I/O error occurs
* @throws ArithmeticException if the character count is too large
* @since Commons IO 1.1
*/
public static int copy(Reader input, Writer output) throws IOException {
long count = copyLarge(input, output);
if (count > Integer.MAX_VALUE) {
return -1;
}
return (int) count;
}
/**
* Copy chars from a Reader to bytes on an OutputStream using the default character encoding of the platform, and calling
* flush.
*
* This method buffers the input internally, so there is no need to use a BufferedReader.
*
* Due to the implementation of OutputStreamWriter, this method performs a flush.
*
* This method uses {@link OutputStreamWriter}.
*
* @param input the Reader to read from
* @param output the OutputStream to write to
* @throws NullPointerException if the input or output is null
* @throws IOException if an I/O error occurs
* @since Commons IO 1.1
*/
public static void copy(Reader input, OutputStream output) throws IOException {
OutputStreamWriter out = new OutputStreamWriter(output);
copy(input, out);
// XXX Unless anyone is planning on rewriting OutputStreamWriter, we
// have to flush here.
out.flush();
}
/**
* Copy chars from a Reader to bytes on an OutputStream using the specified character encoding, and calling flush.
*
* This method buffers the input internally, so there is no need to use a BufferedReader.
*
* Character encoding names can be found at IANA.
*
* Due to the implementation of OutputStreamWriter, this method performs a flush.
*
* This method uses {@link OutputStreamWriter}.
*
* @param input the Reader to read from
* @param output the OutputStream to write to
* @param encoding the encoding to use, null means platform default
* @throws NullPointerException if the input or output is null
* @throws IOException if an I/O error occurs
* @since Commons IO 1.1
*/
public static void copy(Reader input, OutputStream output, String encoding) throws IOException {
if (encoding == null) {
copy(input, output);
} else {
OutputStreamWriter out = new OutputStreamWriter(output, encoding);
copy(input, out);
// XXX Unless anyone is planning on rewriting OutputStreamWriter,
// we have to flush here.
out.flush();
}
}
}
Related
- copyLarge(InputStream input, OutputStream output)
- copyLarge(InputStream input, OutputStream output)
- copyLarge(InputStream input, OutputStream output)
- copyLarge(InputStream input, OutputStream output)
- copyLarge(InputStream input, OutputStream output)
- copyLarge(InputStream input, OutputStream output)
- copyLarge(InputStream input, OutputStream output)
- copyLarge(InputStream input, OutputStream output)
- copyLarge(InputStream input, OutputStream output)