Class IO

java.lang.Object

edu.umd.cs.findbugs.io.IO

public class IO
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static ThreadLocal<byte[]>	myByteBuf
(package private) static ThreadLocal<char[]>	myCharBuf

Constructor Summary

Constructors

Constructor	Description
IO()

Method Summary

Modifier and Type	Method	Description
static void	close(Closeable c)	Close given Closeable instance, ignoring any resulting exception.
static void	close(InputStream inputStream)	Deprecated, for removal: This API element is subject to removal in a future version. This method is deprecated and will be removed in or after October 2026.
static void	close(OutputStream outputStream)	Close given OutputStream, ignoring any resulting exception.
static void	close(AutoCloseable c)	Close given AutoCloseable instance, ignoring any resulting exception.
static long	copy(InputStream in, OutputStream out)
static long	copy(InputStream in, OutputStream out, long maxBytes)
static long	copy(Reader in, Writer out)
static long	copy(Reader in, Writer out, long maxChars)
(package private) static byte[]	copyOf(byte[] original, int newLength)
static URLConnection	openNonCachedConnection(URL u)	When URL Connection uses cache, it may keep file handler.
static InputStream	openNonCachedStream(URL u)	When URL Connection uses cache, it may keep file handler.
static byte[]	readAll(InputStream in)
static byte[]	readAll(InputStream in, int size)
static String	readAll(Reader reader)
static void	skipFully(InputStream in, long bytes)	Provide a skip fully method.
static boolean	verifyURL(URL u)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

myByteBuf

static ThreadLocal<byte[]> myByteBuf

myCharBuf

static ThreadLocal<char[]> myCharBuf

Constructor Details

IO

public IO()

Method Details

readAll

public static byte[] readAll(@WillClose
 InputStream in)
                      throws IOException

Throws:

IOException

copyOf

static byte[] copyOf(byte[] original,
 int newLength)

readAll

public static byte[] readAll(@WillClose
 InputStream in,
 int size)
                      throws IOException

Throws:

IOException

readAll

public static String readAll(Reader reader)
                      throws IOException

Throws:

IOException

copy

public static long copy(@WillNotClose
 InputStream in,
 @WillNotClose
 OutputStream out)
                 throws IOException

Throws:

IOException

copy

public static long copy(Reader in,
 Writer out)
                 throws IOException

Throws:

IOException

copy

public static long copy(@WillNotClose
 InputStream in,
 @WillNotClose
 OutputStream out,
 long maxBytes)
                 throws IOException

Throws:

IOException

copy

public static long copy(Reader in,
 Writer out,
 long maxChars)
                 throws IOException

Throws:

IOException

close

public static void close(@CheckForNull
 AutoCloseable c)

Close given AutoCloseable instance, ignoring any resulting exception.

close

public static void close(@CheckForNull
 Closeable c)

Close given Closeable instance, ignoring any resulting exception.

close

@Deprecated(forRemoval=true)
public static void close(@CheckForNull
 InputStream inputStream)

Deprecated, for removal: This API element is subject to removal in a future version.

This method is deprecated and will be removed in or after October 2026. Use try-with resources when creating the stream instead.

Close given InputStream, ignoring any resulting exception.

Parameters:

inputStream - the InputStream to close; may be null (in which case nothing happens)

close

public static void close(@CheckForNull
 OutputStream outputStream)

Close given OutputStream, ignoring any resulting exception.

Parameters:

outputStream - the OutputStream to close; may be null (in which case nothing happens)

skipFully

public static void skipFully(InputStream in,
 long bytes)
                      throws IOException

Provide a skip fully method. Either skips the requested number of bytes or throws an IOException;

Parameters:

in - The input stream on which to perform the skip

bytes - Number of bytes to skip

Throws:

EOFException - if we reach EOF and still need to skip more bytes

IOException - if in.skip throws an IOException

verifyURL

public static boolean verifyURL(URL u)

openNonCachedConnection

@CheckReturnValue
@NonNull
public static URLConnection openNonCachedConnection(@NonNull
 URL u)
                                             throws IOException

When URL Connection uses cache, it may keep file handler. This method open connection without caching to avoid file handler leak.

Returns:

opened URLConnection which does not use cache to load data

Throws:

IOException

See Also:

• related GitHub issue

openNonCachedStream

@CheckReturnValue
@NonNull
public static InputStream openNonCachedStream(@NonNull
 URL u)
                                       throws IOException

When URL Connection uses cache, it may keep file handler. This method open connection without caching to avoid file handler leak.

Returns:

opened URLConnection which does not use cache to load data

Throws:

IOException

See Also:

• related GitHub issue