Deprecated API

Contents

• Classes
• Exceptions
• Fields
• Methods
• Constructors

Classes

Class	Description
org.apache.commons.io.CopyUtils	Use IOUtils. Will be removed in 3.0. Methods renamed to IOUtils.write() or IOUtils.copy(). Null handling behavior changed in IOUtils (null data does not throw NullPointerException).
org.apache.commons.io.DirectoryWalker	Apache Commons IO no longer uses this class. Instead, use PathUtils.walk(java.nio.file.Path, org.apache.commons.io.file.PathFilter, int, boolean, java.nio.file.FileVisitOption...) or Files.walkFileTree(java.nio.file.Path, java.util.Set, int, java.nio.file.FileVisitor), and friends.
org.apache.commons.io.FileCleaner	Use FileCleaningTracker
org.apache.commons.io.filefilter.WildcardFilter	Use WildcardFileFilter. Deprecated as this class performs directory filtering which it shouldn't do, but that can't be removed due to compatibility.
org.apache.commons.io.FileSystemUtils	As of 2.6 deprecated without replacement. Use equivalent methods in FileStore instead, Files.getFileStore(Paths.get("/home")).getUsableSpace() or iterate over FileSystems.getDefault().getFileStores()
org.apache.commons.io.input.CountingInputStream	Use BoundedInputStream (unbounded by default).
org.apache.commons.io.input.MessageDigestCalculatingInputStream	Use MessageDigestInputStream.

Exceptions

Exceptions	Description
org.apache.commons.io.IOExceptionWithCause	(since 2.5) use IOException instead

Fields

Field	Description
org.apache.commons.io.Charsets.ISO_8859_1	Use Java 7's StandardCharsets
org.apache.commons.io.Charsets.US_ASCII	Use Java 7's StandardCharsets
org.apache.commons.io.Charsets.UTF_16	Use Java 7's StandardCharsets
org.apache.commons.io.Charsets.UTF_16BE	Use Java 7's StandardCharsets
org.apache.commons.io.Charsets.UTF_16LE	Use Java 7's StandardCharsets
org.apache.commons.io.Charsets.UTF_8	Use Java 7's StandardCharsets
org.apache.commons.io.file.PathUtils.NOFOLLOW_LINK_OPTION_ARRAY	Use PathUtils.noFollowLinkOptionArray().
org.apache.commons.io.filefilter.FileFileFilter.FILE	Use FileFileFilter.INSTANCE.
org.apache.commons.io.HexDump.EOL	Use System.lineSeparator().
org.apache.commons.io.input.ClosedInputStream.CLOSED_INPUT_STREAM	Use ClosedInputStream.INSTANCE.
org.apache.commons.io.input.ClosedReader.CLOSED_READER	ClosedReader.INSTANCE.
org.apache.commons.io.input.NullInputStream.INSTANCE	Not reusable without calling NullInputStream.init() to reset state.
org.apache.commons.io.IOUtils.LINE_SEPARATOR	Use System.lineSeparator().
org.apache.commons.io.output.ClosedOutputStream.CLOSED_OUTPUT_STREAM	Use ClosedOutputStream.INSTANCE.
org.apache.commons.io.output.ClosedWriter.CLOSED_WRITER	Use ClosedWriter.INSTANCE.
org.apache.commons.io.output.NullOutputStream.NULL_OUTPUT_STREAM	Use NullOutputStream.INSTANCE.
org.apache.commons.io.output.NullPrintStream.NULL_PRINT_STREAM	Use NullPrintStream.INSTANCE.
org.apache.commons.io.output.NullWriter.NULL_WRITER	Use NullWriter.INSTANCE.

Methods

Method	Description
org.apache.commons.io.channels.FileChannels.contentEquals(FileChannel, FileChannel, int)	Use FileChannels.contentEquals(SeekableByteChannel, SeekableByteChannel, int).
org.apache.commons.io.CopyUtils.copy(byte[], Writer)	Use CopyUtils.copy(byte[], Writer, String) instead
org.apache.commons.io.file.PathUtils.readBasicFileAttributesUnchecked(Path)	Use PathUtils.readBasicFileAttributes(Path, LinkOption...).
org.apache.commons.io.FileCleaner.exitWhenFinished()	Use FileCleaningTracker.exitWhenFinished().
org.apache.commons.io.FileCleaner.getTrackCount()	Use FileCleaningTracker.getTrackCount().
org.apache.commons.io.FileCleaner.track(File, Object)	Use FileCleaningTracker.track(File, Object).
org.apache.commons.io.filefilter.FileFilterUtils.andFileFilter(IOFileFilter, IOFileFilter)	Use FileFilterUtils.and(IOFileFilter...)
org.apache.commons.io.filefilter.FileFilterUtils.orFileFilter(IOFileFilter, IOFileFilter)	Use FileFilterUtils.or(IOFileFilter...)
org.apache.commons.io.FileSystemUtils.freeSpace(String)	Use freeSpaceKb(String) Deprecated from 1.3, may be removed in 2.0
org.apache.commons.io.FileSystemUtils.freeSpaceKb()	As of 2.6 deprecated without replacement. Please use FileStore.getUsableSpace().
org.apache.commons.io.FileUtils.readFileToString(File)	Use FileUtils.readFileToString(File, Charset) instead (and specify the appropriate encoding).
org.apache.commons.io.FileUtils.readLines(File)	Use FileUtils.readLines(File, Charset) instead (and specify the appropriate encoding).
org.apache.commons.io.FileUtils.write(File, CharSequence)	Use FileUtils.write(File, CharSequence, Charset) instead (and specify the appropriate encoding).
org.apache.commons.io.FileUtils.writeStringToFile(File, String)	Use FileUtils.writeStringToFile(File, String, Charset) instead (and specify the appropriate encoding)
org.apache.commons.io.input.BoundedInputStream.getMaxLength()	Use BoundedInputStream.getMaxCount().
org.apache.commons.io.input.BoundedInputStream.setPropagateClose(boolean)	Use BoundedInputStream.AbstractBuilder.setPropagateClose(boolean).
org.apache.commons.io.input.CountingInputStream.getCount()	Use CountingInputStream.getByteCount().
org.apache.commons.io.input.CountingInputStream.resetCount()	Use CountingInputStream.resetByteCount().
org.apache.commons.io.input.Tailer.create(File, Charset, TailerListener, long, boolean, boolean, int)	Use Tailer.builder(), Tailer.Builder, and Tailer.Builder.get().
org.apache.commons.io.input.Tailer.getDelay()	Use Tailer.getDelayDuration().
org.apache.commons.io.input.Tailer.stop()	Use Tailer.close().
org.apache.commons.io.IOUtils.copy(InputStream, Writer)	Use IOUtils.copy(InputStream, Writer, Charset) instead.
org.apache.commons.io.IOUtils.readFully(InputStream, int)	Use IOUtils.toByteArray(InputStream, int).
org.apache.commons.io.IOUtils.readLines(InputStream)	Use IOUtils.readLines(InputStream, Charset) instead
org.apache.commons.io.IOUtils.toByteArray(Reader)	Use IOUtils.toByteArray(Reader, Charset) instead.
org.apache.commons.io.IOUtils.toCharArray(InputStream)	Use IOUtils.toCharArray(InputStream, Charset) instead
org.apache.commons.io.IOUtils.toInputStream(CharSequence)	Use IOUtils.toInputStream(CharSequence, Charset) instead.
org.apache.commons.io.IOUtils.toString(byte[])	Use String(byte[]) instead.
org.apache.commons.io.IOUtils.write(byte[], Writer)	Use IOUtils.write(byte[], Writer, Charset) instead.
org.apache.commons.io.IOUtils.writeLines(Collection<?>, String, OutputStream)	Use IOUtils.writeLines(Collection, String, OutputStream, Charset) instead
org.apache.commons.io.LineIterator.closeQuietly(LineIterator)	As of 2.6 deprecated without replacement. Please use the try-with-resources statement or handle suppressed exceptions manually.
org.apache.commons.io.LineIterator.nextLine()	Use LineIterator.next().
org.apache.commons.io.output.AbstractByteArrayOutputStream.toString()	Use AbstractByteArrayOutputStream.toString(String) instead.
org.apache.commons.io.output.DeferredFileOutputStream.getStream()	Use ThresholdingOutputStream.getOutputStream().
org.apache.commons.io.output.ThresholdingOutputStream.getStream()	Use ThresholdingOutputStream.getOutputStream().

Constructors

Constructor	Description
org.apache.commons.io.Charsets()	Will be private in 4.0
org.apache.commons.io.CopyUtils()	TODO Make private in 3.0.
org.apache.commons.io.EndianUtils()	TODO Make private in 3.0.
org.apache.commons.io.file.AccumulatorPathVisitor()	Use AccumulatorPathVisitor.builder().
org.apache.commons.io.file.Counters()	Will be private in 4.0
org.apache.commons.io.file.CountingPathVisitor(Counters.PathCounters, PathFilter, PathFilter, IOBiFunction<Path, IOException, FileVisitResult>)	Use CountingPathVisitor.Builder.
org.apache.commons.io.filefilter.WildcardFileFilter(List<String>)	Use WildcardFileFilter.builder(), WildcardFileFilter.Builder, and WildcardFileFilter.Builder.get()
org.apache.commons.io.FilenameUtils()	TODO Make private in 3.0.
org.apache.commons.io.FileSystemUtils()	TODO Make private in 3.0.
org.apache.commons.io.FileUtils()	TODO Make private in 3.0.
org.apache.commons.io.input.AutoCloseInputStream(InputStream)	Use AutoCloseInputStream.builder(), AutoCloseInputStream.Builder, and AutoCloseInputStream.Builder.get()
org.apache.commons.io.input.BOMInputStream(InputStream)	Use BOMInputStream.builder(), BOMInputStream.Builder, and BOMInputStream.Builder.get()
org.apache.commons.io.input.BoundedInputStream(InputStream)	Use IOSupplier.get().
org.apache.commons.io.input.BrokenInputStream(IOException)	Use BrokenInputStream(Throwable).
org.apache.commons.io.input.BrokenReader(IOException)	Use BrokenReader(Throwable).
org.apache.commons.io.input.BufferedFileChannelInputStream(File)	Use BufferedFileChannelInputStream.builder(), BufferedFileChannelInputStream.Builder, and BufferedFileChannelInputStream.Builder.get()
org.apache.commons.io.input.CharSequenceInputStream(CharSequence, Charset)	Use CharSequenceInputStream.builder(), CharSequenceInputStream.Builder, and CharSequenceInputStream.Builder.get()
org.apache.commons.io.input.CloseShieldInputStream(InputStream)	Using this constructor prevents IDEs from warning if the underlying input stream is never closed. Use CloseShieldInputStream.wrap(InputStream) instead.
org.apache.commons.io.input.CloseShieldReader(Reader)	Using this constructor prevents IDEs from warning if the underlying reader is never closed. Use CloseShieldReader.wrap(Reader) instead.
org.apache.commons.io.input.MessageDigestCalculatingInputStream(InputStream)	Use MessageDigestCalculatingInputStream.builder(), MessageDigestCalculatingInputStream.Builder, and MessageDigestCalculatingInputStream.Builder.get().
org.apache.commons.io.input.QueueInputStream(BlockingQueue<Integer>)	Use QueueInputStream.builder(), QueueInputStream.Builder, and QueueInputStream.Builder.get().
org.apache.commons.io.input.RandomAccessFileInputStream(RandomAccessFile)	Use RandomAccessFileInputStream.builder(), RandomAccessFileInputStream.Builder, and RandomAccessFileInputStream.Builder.get()
org.apache.commons.io.input.ReadAheadInputStream(InputStream, int)	Use ReadAheadInputStream.builder(), ReadAheadInputStream.Builder, and ReadAheadInputStream.Builder.get()
org.apache.commons.io.input.ReaderInputStream(Reader)	Use ReaderInputStream.builder() instead
org.apache.commons.io.input.ReversedLinesFileReader(File)	Use ReversedLinesFileReader.builder(), ReversedLinesFileReader.Builder, and ReversedLinesFileReader.Builder.get()
org.apache.commons.io.input.Tailer(File, Charset, TailerListener, long, boolean, boolean, int)	Use Tailer.builder(), Tailer.Builder, and Tailer.Builder.get().
org.apache.commons.io.input.UnsynchronizedByteArrayInputStream(byte[])	Use UnsynchronizedByteArrayInputStream.builder(), UnsynchronizedByteArrayInputStream.Builder, and UnsynchronizedByteArrayInputStream.Builder.get().
org.apache.commons.io.input.XmlStreamReader(File)	Use XmlStreamReader.builder(), XmlStreamReader.Builder, and XmlStreamReader.Builder.get()
org.apache.commons.io.IOUtils()	TODO Make private in 3.0.
org.apache.commons.io.monitor.FileAlterationObserver(File)	Use FileAlterationObserver.builder().
org.apache.commons.io.output.BrokenOutputStream(IOException)	Use BrokenOutputStream(Throwable).
org.apache.commons.io.output.BrokenWriter(IOException)	Use BrokenWriter(Throwable).
org.apache.commons.io.output.ChunkedOutputStream(OutputStream)	Use ChunkedOutputStream.builder(), ChunkedOutputStream.Builder, and ChunkedOutputStream.Builder.get().
org.apache.commons.io.output.CloseShieldOutputStream(OutputStream)	Using this constructor prevents IDEs from warning if the underlying output stream is never closed. Use CloseShieldOutputStream.wrap(OutputStream) instead.
org.apache.commons.io.output.CloseShieldWriter(Writer)	Using this constructor prevents IDEs from warning if the underlying writer is never closed. Use CloseShieldWriter.wrap(Writer) instead.
org.apache.commons.io.output.DeferredFileOutputStream(int, File)	Use DeferredFileOutputStream.builder(), DeferredFileOutputStream.Builder, and DeferredFileOutputStream.Builder.get()
org.apache.commons.io.output.FileWriterWithEncoding(File, Charset)	Use FileWriterWithEncoding.builder(), FileWriterWithEncoding.Builder, and FileWriterWithEncoding.Builder.get().
org.apache.commons.io.output.LockableFileWriter(File)	Use LockableFileWriter.builder(), LockableFileWriter.Builder, and LockableFileWriter.Builder.get().
org.apache.commons.io.output.NullOutputStream()	Use NullOutputStream.INSTANCE.
org.apache.commons.io.output.NullPrintStream()	Use NullPrintStream.INSTANCE.
org.apache.commons.io.output.NullWriter()	Use NullWriter.INSTANCE.
org.apache.commons.io.output.UnsynchronizedByteArrayOutputStream()	Use UnsynchronizedByteArrayOutputStream.builder(), UnsynchronizedByteArrayOutputStream.Builder, and UnsynchronizedByteArrayOutputStream.Builder.get().
org.apache.commons.io.output.WriterOutputStream(Writer)	Use WriterOutputStream.builder(), WriterOutputStream.Builder, and WriterOutputStream.Builder.get().
org.apache.commons.io.output.XmlStreamWriter(File)	Use XmlStreamWriter.builder(), XmlStreamWriter.Builder, and XmlStreamWriter.Builder.get().
org.apache.commons.io.RandomAccessFiles()	TODO Make private in 3.0.
org.apache.commons.io.serialization.ValidatingObjectInputStream(InputStream)	Use ValidatingObjectInputStream.builder().
org.apache.commons.io.serialization.ValidatingObjectInputStream.Builder()	Use ValidatingObjectInputStream.builder().
org.apache.commons.io.ThreadUtils()	TODO Make private in 3.0.