Tomcat 10.1.19 · org.apache.tomcat.util.http.fileupload.util.Streams

Modifier and Type	Field and Description
public static final int	DEFAULT_BUFFER_SIZE Default buffer size for use in `copy(InputStream, OutputStream, boolean)`.

Access	Constructor and Description
private	Streams() Private constructor, to prevent instantiation.

Method Summary

Modifier and Type	Method and Description
public static String	Returns: Unmodified file name, if valid. checkFileName(final String The file name to check fileName) Checks, whether the given file name is valid in the sense, that it doesn't contain any NUL characters.
public static long	Returns: Number of bytes, which have been copied. copy(final InputStream The input stream, which is being read. It is guaranteed, that `InputStream#close()` is called on the stream. inputStream, final OutputStream The output stream, to which data should be written. May be null, in which case the input streams contents are simply discarded. outputStream, final boolean True guarantees, that `OutputStream#close()` is called on the stream. False indicates, that only `OutputStream#flush()` should be called finally. closeOutputStream) Copies the contents of the given `InputStream` to the given `OutputStream`.
public static long	Returns: Number of bytes, which have been copied. copy(final InputStream The input stream, which is being read. It is guaranteed, that `InputStream#close()` is called on the stream. inputStream, final OutputStream The output stream, to which data should be written. May be null, in which case the input streams contents are simply discarded. outputStream, final boolean True guarantees, that `OutputStream#close()` is called on the stream. False indicates, that only `OutputStream#flush()` should be called finally. closeOutputStream, final byte[] Temporary buffer, which is to be used for copying data. buffer) Copies the contents of the given `InputStream` to the given `OutputStream`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

DEFAULT_BUFFER_SIZE	back to summary
public static final int DEFAULT_BUFFER_SIZE Default buffer size for use in `copy(InputStream, OutputStream, boolean)`.

Streams	back to summary
private Streams() Private constructor, to prevent instantiation. This class has only static methods.

Method Detail

checkFileName back to summary

checkFileName	back to summary
public static String checkFileName(final String fileName) 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:String The file name to check Returns:String Unmodified file name, if valid. Exceptions InvalidFileNameException: The file name was found to be invalid.

public static String checkFileName(final String fileName)

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:String: The file name to check

Returns:String

Unmodified file name, if valid.

Exceptions

InvalidFileNameException:: The file name was found to be invalid.

copy back to summary

copy	back to summary
public static long copy(final InputStream inputStream, final OutputStream outputStream, final boolean closeOutputStream) throws IOException Copies the contents of the given `InputStream` to the given `OutputStream`. Shortcut for copy(pInputStream, pOutputStream, new byte[8192]); Parameters inputStream:InputStream The input stream, which is being read. It is guaranteed, that `InputStream#close()` is called on the stream. outputStream:OutputStream The output stream, to which data should be written. May be null, in which case the input streams contents are simply discarded. closeOutputStream:boolean True guarantees, that `OutputStream#close()` is called on the stream. False indicates, that only `OutputStream#flush()` should be called finally. Returns:long Number of bytes, which have been copied. Exceptions IOException: An I/O error occurred.

public static long copy(final InputStream inputStream, final OutputStream outputStream, final boolean closeOutputStream) throws IOException

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

  copy(pInputStream, pOutputStream, new byte[8192]);

Parameters

inputStream:InputStream: The input stream, which is being read. It is guaranteed, that InputStream#close() is called on the stream.
outputStream:OutputStream: The output stream, to which data should be written. May be null, in which case the input streams contents are simply discarded.
closeOutputStream:boolean: True guarantees, that OutputStream#close() is called on the stream. False indicates, that only OutputStream#flush() should be called finally.

Returns:long

Number of bytes, which have been copied.

Exceptions

IOException:: An I/O error occurred.

copy back to summary

copy	back to summary
public static long copy(final InputStream inputStream, final OutputStream outputStream, final boolean closeOutputStream, final byte[] buffer) throws IOException Copies the contents of the given `InputStream` to the given `OutputStream`. Parameters inputStream:InputStream The input stream, which is being read. It is guaranteed, that `InputStream#close()` is called on the stream. outputStream:OutputStream The output stream, to which data should be written. May be null, in which case the input streams contents are simply discarded. closeOutputStream:boolean True guarantees, that `OutputStream#close()` is called on the stream. False indicates, that only `OutputStream#flush()` should be called finally. buffer:byte[] Temporary buffer, which is to be used for copying data. Returns:long Number of bytes, which have been copied. Exceptions IOException: An I/O error occurred.

public static long copy(final InputStream inputStream, final OutputStream outputStream, final boolean closeOutputStream, final byte[] buffer) throws IOException

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

Parameters

inputStream:InputStream: The input stream, which is being read. It is guaranteed, that InputStream#close() is called on the stream.
outputStream:OutputStream: The output stream, to which data should be written. May be null, in which case the input streams contents are simply discarded.
closeOutputStream:boolean: True guarantees, that OutputStream#close() is called on the stream. False indicates, that only OutputStream#flush() should be called finally.
buffer:byte[]: Temporary buffer, which is to be used for copying data.

Returns:long

Number of bytes, which have been copied.

Exceptions

IOException:: An I/O error occurred.

public final Class Streams

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail