Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractBuilder() - Constructor for class org.apache.commons.io.input.ObservableInputStream.AbstractBuilder
- AbstractBuilder() - Constructor for class org.apache.commons.io.input.ProxyInputStream.AbstractBuilder
- AbstractByteArrayOutputStream - Class in org.apache.commons.io.output
-
This is the base class for implementing an output stream in which the data is written into a byte array.
- AbstractByteArrayOutputStream() - Constructor for class org.apache.commons.io.output.AbstractByteArrayOutputStream
- AbstractByteArrayOutputStream.InputStreamConstructor<T extends InputStream> - Interface in org.apache.commons.io.output
-
Constructor for an InputStream subclass.
- AbstractCharacterFilterReader - Class in org.apache.commons.io.input
-
A filter reader that filters out characters where subclasses decide which characters to filter out.
- AbstractCharacterFilterReader(Reader) - Constructor for class org.apache.commons.io.input.AbstractCharacterFilterReader
-
Constructs a new reader.
- AbstractCharacterFilterReader(Reader, IntPredicate) - Constructor for class org.apache.commons.io.input.AbstractCharacterFilterReader
-
Constructs a new reader.
- AbstractFileFilter - Class in org.apache.commons.io.filefilter
-
Abstracts the implementation of the
FileFilter
(IO),FilenameFilter
(IO),PathFilter
(NIO) interfaces via our ownIOFileFilter
interface. - AbstractFileFilter() - Constructor for class org.apache.commons.io.filefilter.AbstractFileFilter
-
Constructs a new instance.
- AbstractFileFilter(FileVisitResult, FileVisitResult) - Constructor for class org.apache.commons.io.filefilter.AbstractFileFilter
-
Constructs a new instance.
- AbstractInputStream - Class in org.apache.commons.io.input
-
Abstracts some InputStream operations for implementations in this package.
- AbstractInputStream() - Constructor for class org.apache.commons.io.input.AbstractInputStream
- AbstractOrigin<T,
B extends AbstractOrigin<T, B>> - Class in org.apache.commons.io.build -
Abstracts the origin of data for builders like a
File
,Path
,Reader
,Writer
,InputStream
,OutputStream
, andURI
. - AbstractOrigin(T) - Constructor for class org.apache.commons.io.build.AbstractOrigin
-
Constructs a new instance for a subclass.
- AbstractOrigin.AbstractRandomAccessFileOrigin<T extends RandomAccessFile,
B extends AbstractOrigin.AbstractRandomAccessFileOrigin<T, B>> - Class in org.apache.commons.io.build -
A
RandomAccessFile
origin. - AbstractOrigin.ByteArrayOrigin - Class in org.apache.commons.io.build
-
A
byte[]
origin. - AbstractOrigin.CharSequenceOrigin - Class in org.apache.commons.io.build
-
A
CharSequence
origin. - AbstractOrigin.FileOrigin - Class in org.apache.commons.io.build
-
A
File
origin. - AbstractOrigin.InputStreamOrigin - Class in org.apache.commons.io.build
-
An
InputStream
origin. - AbstractOrigin.IORandomAccessFileOrigin - Class in org.apache.commons.io.build
-
A
IORandomAccessFile
origin. - AbstractOrigin.OutputStreamOrigin - Class in org.apache.commons.io.build
-
An
OutputStream
origin. - AbstractOrigin.PathOrigin - Class in org.apache.commons.io.build
-
A
Path
origin. - AbstractOrigin.RandomAccessFileOrigin - Class in org.apache.commons.io.build
-
A
RandomAccessFile
origin. - AbstractOrigin.ReaderOrigin - Class in org.apache.commons.io.build
-
A
Reader
origin. - AbstractOrigin.URIOrigin - Class in org.apache.commons.io.build
-
A
URI
origin. - AbstractOrigin.WriterOrigin - Class in org.apache.commons.io.build
-
A
Writer
origin. - AbstractOriginSupplier<T,
B extends AbstractOriginSupplier<T, B>> - Class in org.apache.commons.io.build -
Abstracts building an instance of
T
. - AbstractOriginSupplier() - Constructor for class org.apache.commons.io.build.AbstractOriginSupplier
- AbstractRandomAccessFileOrigin(T) - Constructor for class org.apache.commons.io.build.AbstractOrigin.AbstractRandomAccessFileOrigin
-
A
RandomAccessFile
origin. - AbstractStreamBuilder<T,
B extends AbstractStreamBuilder<T, B>> - Class in org.apache.commons.io.build -
Abstracts building a typed instance of
T
. - AbstractStreamBuilder() - Constructor for class org.apache.commons.io.build.AbstractStreamBuilder
- AbstractSupplier<T,
B extends AbstractSupplier<T, B>> - Class in org.apache.commons.io.build -
Abstracts supplying an instance of
T
. - AbstractSupplier() - Constructor for class org.apache.commons.io.build.AbstractSupplier
- accept(int) - Method in interface org.apache.commons.io.function.IOIntConsumer
-
Performs this operation on the given argument.
- accept(File) - Method in class org.apache.commons.io.filefilter.AbstractFileFilter
-
Checks to see if the File should be accepted by this filter.
- accept(File) - Method in class org.apache.commons.io.filefilter.AgeFileFilter
-
Checks to see if the last modification of the file matches cutoff favorably.
- accept(File) - Method in class org.apache.commons.io.filefilter.AndFileFilter
-
Checks to see if the File should be accepted by this filter.
- accept(File) - Method in class org.apache.commons.io.filefilter.CanExecuteFileFilter
-
Checks to see if the file can be executed.
- accept(File) - Method in class org.apache.commons.io.filefilter.CanReadFileFilter
-
Checks to see if the file can be read.
- accept(File) - Method in class org.apache.commons.io.filefilter.CanWriteFileFilter
-
Checks to see if the file can be written to.
- accept(File) - Method in class org.apache.commons.io.filefilter.DelegateFileFilter
-
Checks the filter.
- accept(File) - Method in class org.apache.commons.io.filefilter.DirectoryFileFilter
-
Checks to see if the file is a directory.
- accept(File) - Method in class org.apache.commons.io.filefilter.EmptyFileFilter
-
Checks to see if the file is empty.
- accept(File) - Method in class org.apache.commons.io.filefilter.FalseFileFilter
-
Returns false.
- accept(File) - Method in class org.apache.commons.io.filefilter.FileEqualsFileFilter
- accept(File) - Method in class org.apache.commons.io.filefilter.FileFileFilter
-
Checks to see if the file is a file.
- accept(File) - Method in class org.apache.commons.io.filefilter.HiddenFileFilter
-
Checks to see if the file is hidden.
- accept(File) - Method in interface org.apache.commons.io.filefilter.IOFileFilter
-
Tests if a File should be accepted by this filter.
- accept(File) - Method in class org.apache.commons.io.filefilter.MagicNumberFileFilter
-
Accepts the provided file if the file contains the file filter's magic number at the specified offset.
- accept(File) - Method in class org.apache.commons.io.filefilter.NameFileFilter
-
Checks to see if the file name matches.
- accept(File) - Method in class org.apache.commons.io.filefilter.NotFileFilter
-
Returns the logical NOT of the underlying filter's return value for the same File.
- accept(File) - Method in class org.apache.commons.io.filefilter.OrFileFilter
-
Checks to see if the File should be accepted by this filter.
- accept(File) - Method in class org.apache.commons.io.filefilter.PathEqualsFileFilter
- accept(File) - Method in class org.apache.commons.io.filefilter.PathMatcherFileFilter
- accept(File) - Method in class org.apache.commons.io.filefilter.PathVisitorFileFilter
- accept(File) - Method in class org.apache.commons.io.filefilter.PrefixFileFilter
-
Checks to see if the file name starts with the prefix.
- accept(File) - Method in class org.apache.commons.io.filefilter.SizeFileFilter
-
Checks to see if the size of the file is favorable.
- accept(File) - Method in class org.apache.commons.io.filefilter.SuffixFileFilter
-
Checks to see if the file name ends with the suffix.
- accept(File) - Method in class org.apache.commons.io.filefilter.SymbolicLinkFileFilter
-
Checks to see if the file is a symbolic link.
- accept(File) - Method in class org.apache.commons.io.filefilter.TrueFileFilter
-
Returns true.
- accept(File) - Method in class org.apache.commons.io.filefilter.WildcardFileFilter
-
Checks to see if the file name matches one of the wildcards.
- accept(File) - Method in class org.apache.commons.io.filefilter.WildcardFilter
-
Deprecated.Checks to see if the file name matches one of the wildcards.
- accept(File, String) - Method in class org.apache.commons.io.filefilter.AbstractFileFilter
-
Checks to see if the File should be accepted by this filter.
- accept(File, String) - Method in class org.apache.commons.io.filefilter.AndFileFilter
-
Checks to see if the File should be accepted by this filter.
- accept(File, String) - Method in class org.apache.commons.io.filefilter.DelegateFileFilter
-
Checks the filter.
- accept(File, String) - Method in class org.apache.commons.io.filefilter.FalseFileFilter
-
Returns false.
- accept(File, String) - Method in interface org.apache.commons.io.filefilter.IOFileFilter
-
Tests if a File should be accepted by this filter.
- accept(File, String) - Method in class org.apache.commons.io.filefilter.NameFileFilter
-
Checks to see if the file name matches.
- accept(File, String) - Method in class org.apache.commons.io.filefilter.NotFileFilter
-
Returns the logical NOT of the underlying filter's return value for the same arguments.
- accept(File, String) - Method in class org.apache.commons.io.filefilter.OrFileFilter
-
Checks to see if the File should be accepted by this filter.
- accept(File, String) - Method in class org.apache.commons.io.filefilter.PathVisitorFileFilter
- accept(File, String) - Method in class org.apache.commons.io.filefilter.PrefixFileFilter
-
Checks to see if the file name starts with the prefix.
- accept(File, String) - Method in class org.apache.commons.io.filefilter.RegexFileFilter
-
Checks to see if the file name matches one of the regular expressions.
- accept(File, String) - Method in class org.apache.commons.io.filefilter.SuffixFileFilter
-
Checks to see if the file name ends with the suffix.
- accept(File, String) - Method in class org.apache.commons.io.filefilter.TrueFileFilter
-
Returns true.
- accept(File, String) - Method in class org.apache.commons.io.filefilter.WildcardFileFilter
-
Checks to see if the file name matches one of the wildcards.
- accept(File, String) - Method in class org.apache.commons.io.filefilter.WildcardFilter
-
Deprecated.Checks to see if the file name matches one of the wildcards.
- accept(Class<?>...) - Method in class org.apache.commons.io.serialization.ObjectStreamClassPredicate
-
Accepts the specified classes for deserialization, unless they are otherwise rejected.
- accept(Class<?>...) - Method in class org.apache.commons.io.serialization.ValidatingObjectInputStream
-
Accepts the specified classes for deserialization, unless they are otherwise rejected.
- accept(Class<?>...) - Method in class org.apache.commons.io.serialization.ValidatingObjectInputStream.Builder
-
Accepts the specified classes for deserialization, unless they are otherwise rejected.
- accept(String...) - Method in class org.apache.commons.io.serialization.ObjectStreamClassPredicate
-
Accepts the wildcard specified classes for deserialization, unless they are otherwise rejected.
- accept(String...) - Method in class org.apache.commons.io.serialization.ValidatingObjectInputStream
-
Accepts the wildcard specified classes for deserialization, unless they are otherwise rejected.
- accept(String...) - Method in class org.apache.commons.io.serialization.ValidatingObjectInputStream.Builder
-
Accepts the wildcard specified classes for deserialization, unless they are otherwise rejected.
- accept(Path) - Method in class org.apache.commons.io.file.DirectoryStreamFilter
- accept(Path, BasicFileAttributes) - Method in interface org.apache.commons.io.file.PathFilter
-
Tests whether or not to include the specified Path in a result.
- accept(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.AgeFileFilter
-
Checks to see if the last modification of the file matches cutoff favorably.
- accept(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.AndFileFilter
-
Checks to see if a Path should be accepted by this filter.
- accept(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.CanExecuteFileFilter
-
Checks to see if the file can be executed.
- accept(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.CanReadFileFilter
-
Checks to see if the file can be read.
- accept(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.CanWriteFileFilter
-
Checks to see if the file can be written to.
- accept(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.DirectoryFileFilter
-
Checks to see if the file is a directory.
- accept(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.EmptyFileFilter
-
Checks to see if the file is empty.
- accept(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.FalseFileFilter
-
Returns false.
- accept(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.FileEqualsFileFilter
- accept(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.FileFileFilter
-
Checks to see if the file is a file.
- accept(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.HiddenFileFilter
-
Checks to see if the file is hidden.
- accept(Path, BasicFileAttributes) - Method in interface org.apache.commons.io.filefilter.IOFileFilter
-
Checks to see if a Path should be accepted by this filter.
- accept(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.MagicNumberFileFilter
-
Accepts the provided file if the file contains the file filter's magic number at the specified offset.
- accept(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.NameFileFilter
-
Checks to see if the file name matches.
- accept(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.NotFileFilter
-
Returns the logical NOT of the underlying filter's return value for the same File.
- accept(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.OrFileFilter
-
Checks to see if a Path should be accepted by this filter.
- accept(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.PathEqualsFileFilter
- accept(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.PathVisitorFileFilter
- accept(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.PrefixFileFilter
-
Checks to see if the file name starts with the prefix.
- accept(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.RegexFileFilter
-
Checks to see if the file name matches one of the regular expressions.
- accept(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.SizeFileFilter
-
Checks to see if the size of the file is favorable.
- accept(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.SuffixFileFilter
-
Checks to see if the file name ends with the suffix.
- accept(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.SymbolicLinkFileFilter
-
Checks to see if the file is a symbolic link.
- accept(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.TrueFileFilter
-
Returns true.
- accept(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.WildcardFileFilter
-
Checks to see if the file name matches one of the wildcards.
- accept(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.WildcardFilter
-
Deprecated.Checks to see if the file name matches one of the wildcards.
- accept(Path, IOConsumer<RandomAccessFile>) - Method in enum org.apache.commons.io.RandomAccessFileMode
-
Performs an operation on the
RandomAccessFile
specified at the givenPath
. - accept(Pattern) - Method in class org.apache.commons.io.serialization.ObjectStreamClassPredicate
-
Accepts class names that match the supplied pattern for deserialization, unless they are otherwise rejected.
- accept(Pattern) - Method in class org.apache.commons.io.serialization.ValidatingObjectInputStream
-
Accepts class names that match the supplied pattern for deserialization, unless they are otherwise rejected.
- accept(Pattern) - Method in class org.apache.commons.io.serialization.ValidatingObjectInputStream.Builder
-
Accepts class names that match the supplied pattern for deserialization, unless they are otherwise rejected.
- accept(IOBiConsumer<T, U>, T, U) - Static method in class org.apache.commons.io.function.Uncheck
-
Accepts an IO consumer with the given arguments.
- accept(IOConsumer<T>, T) - Static method in class org.apache.commons.io.function.Uncheck
-
Accepts an IO consumer with the given argument.
- accept(IOIntConsumer, int) - Static method in class org.apache.commons.io.function.Uncheck
-
Accepts an IO consumer with the given argument.
- accept(IOTriConsumer<T, U, V>, T, U, V) - Static method in class org.apache.commons.io.function.Uncheck
-
Accepts an IO consumer with the given arguments.
- accept(ClassNameMatcher) - Method in class org.apache.commons.io.serialization.ObjectStreamClassPredicate
-
Accepts class names where the supplied ClassNameMatcher matches for deserialization, unless they are otherwise rejected.
- accept(ClassNameMatcher) - Method in class org.apache.commons.io.serialization.ValidatingObjectInputStream
-
Accepts class names where the supplied ClassNameMatcher matches for deserialization, unless they are otherwise rejected.
- accept(ClassNameMatcher) - Method in class org.apache.commons.io.serialization.ValidatingObjectInputStream.Builder
-
Accepts class names where the supplied ClassNameMatcher matches for deserialization, unless they are otherwise rejected.
- accept(T) - Method in interface org.apache.commons.io.function.IOConsumer
-
Performs this operation on the given argument.
- accept(T, U) - Method in interface org.apache.commons.io.function.IOBiConsumer
-
Performs this operation on the given arguments.
- accept(T, U, V) - Method in interface org.apache.commons.io.function.IOTriConsumer
-
Performs this operation on the given arguments.
- AccumulatorPathVisitor - Class in org.apache.commons.io.file
-
Accumulates normalized paths during visitation.
- AccumulatorPathVisitor() - Constructor for class org.apache.commons.io.file.AccumulatorPathVisitor
-
Constructs a new instance.
- AccumulatorPathVisitor(Counters.PathCounters) - Constructor for class org.apache.commons.io.file.AccumulatorPathVisitor
-
Constructs a new instance that counts file system elements.
- AccumulatorPathVisitor(Counters.PathCounters, PathFilter, PathFilter) - Constructor for class org.apache.commons.io.file.AccumulatorPathVisitor
-
Constructs a new instance.
- AccumulatorPathVisitor(Counters.PathCounters, PathFilter, PathFilter, IOBiFunction<Path, IOException, FileVisitResult>) - Constructor for class org.apache.commons.io.file.AccumulatorPathVisitor
-
Constructs a new instance.
- adapt(Iterable<E>) - Static method in interface org.apache.commons.io.function.IOIterator
-
Adapts the given Iterable as an IOIterator.
- adapt(Iterator<E>) - Static method in interface org.apache.commons.io.function.IOIterator
-
Adapts the given Iterator as an IOIterator.
- adapt(Spliterator<E>) - Static method in interface org.apache.commons.io.function.IOSpliterator
-
Adapts the given Spliterator as an IOSpliterator.
- adapt(Stream<T>) - Static method in interface org.apache.commons.io.function.IOStream
-
Constructs a new IOStream for the given Stream.
- add(byte) - Method in class org.apache.commons.io.input.buffer.CircularByteBuffer
-
Adds a new byte to the buffer, which will eventually be returned by following invocations of
CircularByteBuffer.read()
. - add(byte[], int, int) - Method in class org.apache.commons.io.input.buffer.CircularByteBuffer
-
Adds the given bytes to the buffer.
- add(long) - Method in interface org.apache.commons.io.file.Counters.Counter
-
Adds the given number to this counter.
- add(ObservableInputStream.Observer) - Method in class org.apache.commons.io.input.ObservableInputStream
-
Adds an Observer.
- addFileFilter(IOFileFilter) - Method in class org.apache.commons.io.filefilter.AndFileFilter
-
Adds the specified file filter to the list of file filters at the end of the list.
- addFileFilter(IOFileFilter) - Method in interface org.apache.commons.io.filefilter.ConditionalFileFilter
-
Adds the specified file filter to the list of file filters at the end of the list.
- addFileFilter(IOFileFilter) - Method in class org.apache.commons.io.filefilter.OrFileFilter
-
Adds the specified file filter to the list of file filters at the end of the list.
- addFileFilter(IOFileFilter...) - Method in class org.apache.commons.io.filefilter.AndFileFilter
-
Adds the given file filters.
- addFileFilter(IOFileFilter...) - Method in class org.apache.commons.io.filefilter.OrFileFilter
-
Adds the given file filters.
- addListener(FileAlterationListener) - Method in class org.apache.commons.io.monitor.FileAlterationObserver
-
Adds a file system listener.
- addObserver(FileAlterationObserver) - Method in class org.apache.commons.io.monitor.FileAlterationMonitor
-
Adds a file system observer to this monitor.
- afterRead(int) - Method in class org.apache.commons.io.input.AutoCloseInputStream
-
Automatically closes the stream if the end of stream was reached.
- afterRead(int) - Method in class org.apache.commons.io.input.BoundedInputStream
-
Adds the number of read bytes to the count.
- afterRead(int) - Method in class org.apache.commons.io.input.ChecksumInputStream
- afterRead(int) - Method in class org.apache.commons.io.input.CountingInputStream
-
Deprecated.Adds the number of read bytes to the count.
- afterRead(int) - Method in class org.apache.commons.io.input.ProxyInputStream
-
Called by the
read
methods after the proxied call has returned successfully. - afterRead(int) - Method in class org.apache.commons.io.input.ProxyReader
-
Invoked by the read methods after the proxied call has returned successfully.
- afterWrite(int) - Method in class org.apache.commons.io.output.ProxyCollectionWriter
-
Invoked by the write methods after the proxied call has returned successfully.
- afterWrite(int) - Method in class org.apache.commons.io.output.ProxyOutputStream
-
Invoked by the write methods after the proxied call has returned successfully.
- afterWrite(int) - Method in class org.apache.commons.io.output.ProxyWriter
-
Invoked by the write methods after the proxied call has returned successfully.
- ageFileFilter(long) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that returns true if the file was last modified before or at the specified cutoff time.
- ageFileFilter(long, boolean) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that filters files based on a cutoff time.
- ageFileFilter(File) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that returns true if the file was last modified before or at the same time as the specified reference file.
- ageFileFilter(File, boolean) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that filters files based on a cutoff reference file.
- ageFileFilter(Date) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that returns true if the file was last modified before or at the specified cutoff date.
- ageFileFilter(Date, boolean) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that filters files based on a cutoff date.
- AgeFileFilter - Class in org.apache.commons.io.filefilter
-
Filters files based on a cutoff time, can filter either newer files or files equal to or older.
- AgeFileFilter(long) - Constructor for class org.apache.commons.io.filefilter.AgeFileFilter
-
Constructs a new age file filter for files equal to or older than a certain cutoff
- AgeFileFilter(long, boolean) - Constructor for class org.apache.commons.io.filefilter.AgeFileFilter
-
Constructs a new age file filter for files on any one side of a certain cutoff.
- AgeFileFilter(File) - Constructor for class org.apache.commons.io.filefilter.AgeFileFilter
-
Constructs a new age file filter for files older than (at or before) a certain File (whose last modification time will be used as reference).
- AgeFileFilter(File, boolean) - Constructor for class org.apache.commons.io.filefilter.AgeFileFilter
-
Constructs a new age file filter for files on any one side of a certain File (whose last modification time will be used as reference).
- AgeFileFilter(Instant) - Constructor for class org.apache.commons.io.filefilter.AgeFileFilter
-
Constructs a new age file filter for files equal to or older than a certain cutoff.
- AgeFileFilter(Instant, boolean) - Constructor for class org.apache.commons.io.filefilter.AgeFileFilter
-
Constructs a new age file filter for files on any one side of a certain cutoff.
- AgeFileFilter(Date) - Constructor for class org.apache.commons.io.filefilter.AgeFileFilter
-
Constructs a new age file filter for files older than (at or before) a certain cutoff date.
- AgeFileFilter(Date, boolean) - Constructor for class org.apache.commons.io.filefilter.AgeFileFilter
-
Constructs a new age file filter for files on any one side of a certain cutoff date.
- allMatch(IOPredicate<? super T>) - Method in interface org.apache.commons.io.function.IOStream
-
Like
Stream.allMatch(java.util.function.Predicate)
but throwsIOException
. - alwaysFalse() - Static method in interface org.apache.commons.io.function.IOPredicate
-
Always false.
- alwaysTrue() - Static method in interface org.apache.commons.io.function.IOPredicate
-
Always true.
- and(IOFileFilter) - Method in class org.apache.commons.io.filefilter.FalseFileFilter
- and(IOFileFilter) - Method in interface org.apache.commons.io.filefilter.IOFileFilter
-
Constructs a new "and" filter with this filter.
- and(IOFileFilter) - Method in class org.apache.commons.io.filefilter.TrueFileFilter
- and(IOFileFilter...) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that ANDs the specified filters.
- and(IOPredicate<? super T>) - Method in interface org.apache.commons.io.function.IOPredicate
-
Creates a composed predicate that represents a short-circuiting logical AND of this predicate and another.
- andFileFilter(IOFileFilter, IOFileFilter) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Deprecated.
- AndFileFilter - Class in org.apache.commons.io.filefilter
-
A
FileFilter
providing conditional AND logic across a list of file filters. - AndFileFilter() - Constructor for class org.apache.commons.io.filefilter.AndFileFilter
-
Constructs a new empty instance.
- AndFileFilter(List<IOFileFilter>) - Constructor for class org.apache.commons.io.filefilter.AndFileFilter
-
Constructs a new instance of
AndFileFilter
with the specified list of filters. - AndFileFilter(IOFileFilter...) - Constructor for class org.apache.commons.io.filefilter.AndFileFilter
-
Constructs a new instance for the give filters.
- AndFileFilter(IOFileFilter, IOFileFilter) - Constructor for class org.apache.commons.io.filefilter.AndFileFilter
-
Constructs a new file filter that ANDs the result of other filters.
- andThen(Consumer<? super R>) - Method in interface org.apache.commons.io.function.IOFunction
-
Returns a composed
IOFunction
that first applies this function to its input, and then applies theafter
consumer to the result. - andThen(Function<? super R, ? extends V>) - Method in interface org.apache.commons.io.function.IOFunction
-
Returns a composed
IOFunction
that first applies this function to its input, and then applies theafter
function to the result. - andThen(IOBiConsumer<? super T, ? super U>) - Method in interface org.apache.commons.io.function.IOBiConsumer
-
Creates a composed
IOBiConsumer
that performs, in sequence, this operation followed by theafter
operation. - andThen(IOConsumer<? super R>) - Method in interface org.apache.commons.io.function.IOFunction
-
Returns a composed
IOFunction
that first applies this function to its input, and then applies theafter
consumer to the result. - andThen(IOConsumer<? super T>) - Method in interface org.apache.commons.io.function.IOConsumer
-
Returns a composed
IOConsumer
that performs, in sequence, this operation followed by theafter
operation. - andThen(IOFunction<? super R, ? extends V>) - Method in interface org.apache.commons.io.function.IOBiFunction
-
Creates a composed function that first applies this function to its input, and then applies the
after
function to the result. - andThen(IOFunction<? super R, ? extends V>) - Method in interface org.apache.commons.io.function.IOFunction
-
Returns a composed
IOFunction
that first applies this function to its input, and then applies theafter
function to the result. - andThen(IOFunction<? super R, ? extends W>) - Method in interface org.apache.commons.io.function.IOTriFunction
-
Creates a composed function that first applies this function to its input, and then applies the
after
function to the result. - andThen(IOFunction<? super R, ? extends X>) - Method in interface org.apache.commons.io.function.IOQuadFunction
-
Creates a composed function that first applies this function to its input, and then applies the
after
function to the result. - andThen(IOIntConsumer) - Method in interface org.apache.commons.io.function.IOIntConsumer
-
Returns a composed
IOIntConsumer
that performs, in sequence, this operation followed by theafter
operation. - andThen(IOTriConsumer<? super T, ? super U, ? super V>) - Method in interface org.apache.commons.io.function.IOTriConsumer
-
Creates a composed
IOTriConsumer
that performs, in sequence, this operation followed by theafter
operation. - anyMatch(IOPredicate<? super T>) - Method in interface org.apache.commons.io.function.IOStream
-
Like
Stream.anyMatch(java.util.function.Predicate)
but throwsIOException
. - append(char) - Method in class org.apache.commons.io.output.AppendableWriter
-
Appends the specified character to the underlying appendable.
- append(char) - Method in class org.apache.commons.io.output.FilterCollectionWriter
- append(char) - Method in class org.apache.commons.io.output.NullAppendable
- append(char) - Method in class org.apache.commons.io.output.NullWriter
-
Does nothing - output to
/dev/null
. - append(char) - Method in class org.apache.commons.io.output.ProxyCollectionWriter
-
Invokes the delegates'
append(char)
methods. - append(char) - Method in class org.apache.commons.io.output.ProxyWriter
-
Invokes the delegate's
append(char)
method. - append(char) - Method in class org.apache.commons.io.output.StringBuilderWriter
-
Appends a single character to this Writer.
- append(char) - Method in interface org.apache.commons.io.output.UncheckedAppendable
- append(char) - Method in class org.apache.commons.io.output.UncheckedFilterWriter
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - append(CharSequence) - Method in class org.apache.commons.io.output.AppendableWriter
-
Appends the specified character sequence to the underlying appendable.
- append(CharSequence) - Method in class org.apache.commons.io.output.FilterCollectionWriter
- append(CharSequence) - Method in class org.apache.commons.io.output.NullAppendable
- append(CharSequence) - Method in class org.apache.commons.io.output.NullWriter
-
Does nothing - output to
/dev/null
. - append(CharSequence) - Method in class org.apache.commons.io.output.ProxyCollectionWriter
-
Invokes the delegates'
append(CharSequence)
methods. - append(CharSequence) - Method in class org.apache.commons.io.output.ProxyWriter
-
Invokes the delegate's
append(CharSequence)
method. - append(CharSequence) - Method in class org.apache.commons.io.output.StringBuilderWriter
-
Appends a character sequence to this Writer.
- append(CharSequence) - Method in interface org.apache.commons.io.output.UncheckedAppendable
- append(CharSequence) - Method in class org.apache.commons.io.output.UncheckedFilterWriter
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - append(CharSequence, int, int) - Method in class org.apache.commons.io.output.AppendableWriter
-
Appends a subsequence of the specified character sequence to the underlying appendable.
- append(CharSequence, int, int) - Method in class org.apache.commons.io.output.FilterCollectionWriter
- append(CharSequence, int, int) - Method in class org.apache.commons.io.output.NullAppendable
- append(CharSequence, int, int) - Method in class org.apache.commons.io.output.NullWriter
-
Does nothing - output to
/dev/null
. - append(CharSequence, int, int) - Method in class org.apache.commons.io.output.ProxyCollectionWriter
-
Invokes the delegates'
append(CharSequence, int, int)
methods. - append(CharSequence, int, int) - Method in class org.apache.commons.io.output.ProxyWriter
-
Invokes the delegate's
append(CharSequence, int, int)
method. - append(CharSequence, int, int) - Method in class org.apache.commons.io.output.StringBuilderWriter
-
Appends a portion of a character sequence to the
StringBuilder
. - append(CharSequence, int, int) - Method in interface org.apache.commons.io.output.UncheckedAppendable
-
Appends per
Appendable.append(CharSequence, int, int)
but rethrowsIOException
asUncheckedIOException
. - append(CharSequence, int, int) - Method in class org.apache.commons.io.output.UncheckedFilterWriter
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - AppendableOutputStream<T extends Appendable> - Class in org.apache.commons.io.output
-
OutputStream implementation that writes the data to an
Appendable
Object. - AppendableOutputStream(T) - Constructor for class org.apache.commons.io.output.AppendableOutputStream
-
Constructs a new instance with the specified appendable.
- AppendableWriter<T extends Appendable> - Class in org.apache.commons.io.output
-
Writer implementation that writes the data to an
Appendable
Object. - AppendableWriter(T) - Constructor for class org.apache.commons.io.output.AppendableWriter
-
Constructs a new instance with the specified appendable.
- apply(Path, IOFunction<RandomAccessFile, T>) - Method in enum org.apache.commons.io.RandomAccessFileMode
-
Applies the given function for a
RandomAccessFile
specified at the givenPath
. - apply(IOBiFunction<T, U, R>, T, U) - Static method in class org.apache.commons.io.function.Uncheck
-
Applies an IO function with the given arguments.
- apply(IOFunction<T, R>, T) - Static method in class org.apache.commons.io.function.Uncheck
-
Applies an IO function with the given arguments.
- apply(IOQuadFunction<T, U, V, W, R>, T, U, V, W) - Static method in class org.apache.commons.io.function.Uncheck
-
Applies an IO quad-function with the given arguments.
- apply(IOTriFunction<T, U, V, R>, T, U, V) - Static method in class org.apache.commons.io.function.Uncheck
-
Applies an IO tri-function with the given arguments.
- apply(T) - Method in interface org.apache.commons.io.function.IOFunction
-
Applies this function to the given argument.
- apply(T, U) - Method in interface org.apache.commons.io.function.IOBiFunction
-
Applies this function to the given arguments.
- apply(T, U, V) - Method in interface org.apache.commons.io.function.IOTriFunction
-
Applies this function to the given arguments.
- apply(T, U, V, W) - Method in interface org.apache.commons.io.function.IOQuadFunction
-
Applies this function to the given arguments.
- asBaseStream() - Method in interface org.apache.commons.io.function.IOBaseStream
- asBiConsumer() - Method in interface org.apache.commons.io.function.IOBiConsumer
- asBiFunction() - Method in interface org.apache.commons.io.function.IOBiFunction
- asBinaryOperator() - Method in interface org.apache.commons.io.function.IOBinaryOperator
- asComparator() - Method in interface org.apache.commons.io.function.IOComparator
- asConsumer() - Method in interface org.apache.commons.io.function.IOConsumer
- asConsumer() - Method in interface org.apache.commons.io.function.IOIntConsumer
- asFileFilter(FileFilter) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns an
IOFileFilter
that wraps theFileFilter
instance. - asFileFilter(FilenameFilter) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns an
IOFileFilter
that wraps theFilenameFilter
instance. - asFunction() - Method in interface org.apache.commons.io.function.IOFunction
- asIntConsumer() - Method in interface org.apache.commons.io.function.IOIntConsumer
- asIntSupplier() - Method in interface org.apache.commons.io.function.IOIntSupplier
- asIterator() - Method in interface org.apache.commons.io.function.IOIterator
- asPredicate() - Method in interface org.apache.commons.io.function.IOPredicate
- asRunnable() - Method in interface org.apache.commons.io.function.IORunnable
- asSpliterator() - Method in interface org.apache.commons.io.function.IOSpliterator
- asSupplier() - Method in interface org.apache.commons.io.function.IOLongSupplier
- asSupplier() - Method in interface org.apache.commons.io.function.IOSupplier
- asThis() - Method in class org.apache.commons.io.build.AbstractSupplier
-
Returns this instance typed as the subclass type
B
. - asUnaryOperator() - Method in interface org.apache.commons.io.function.IOUnaryOperator
- AutoCloseInputStream - Class in org.apache.commons.io.input
-
Proxy stream that closes and discards the underlying stream as soon as the end of input has been reached or when the stream is explicitly closed.
- AutoCloseInputStream(InputStream) - Constructor for class org.apache.commons.io.input.AutoCloseInputStream
-
Deprecated.
- AutoCloseInputStream.Builder - Class in org.apache.commons.io.input
-
Builds a new
AutoCloseInputStream
instance. - available() - Method in class org.apache.commons.io.input.BoundedInputStream
-
Invokes the delegate's
InputStream.available()
method. - available() - Method in class org.apache.commons.io.input.BrokenInputStream
-
Throws the configured exception.
- available() - Method in class org.apache.commons.io.input.BufferedFileChannelInputStream
- available() - Method in class org.apache.commons.io.input.CharSequenceInputStream
-
Gets a lower bound on the number of bytes remaining in the byte stream.
- available() - Method in class org.apache.commons.io.input.CircularInputStream
- available() - Method in class org.apache.commons.io.input.MemoryMappedFileInputStream
- available() - Method in class org.apache.commons.io.input.NullInputStream
- available() - Method in class org.apache.commons.io.input.ProxyInputStream
-
Invokes the delegate's
InputStream.available()
method. - available() - Method in class org.apache.commons.io.input.RandomAccessFileInputStream
-
Gets an estimate of the number of bytes that can be read (or skipped over) from this input stream.
- available() - Method in class org.apache.commons.io.input.ReadAheadInputStream
- available() - Method in class org.apache.commons.io.input.ReaderInputStream
- available() - Method in class org.apache.commons.io.input.UncheckedFilterInputStream
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - available() - Method in class org.apache.commons.io.input.UnsynchronizedBufferedInputStream
-
Returns the number of bytes that are available before this stream will block.
- available() - Method in class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream
- available() - Method in class org.apache.commons.io.input.UnsynchronizedFilterInputStream
-
Returns the number of bytes that are available before this stream will block.
- availableLong() - Method in class org.apache.commons.io.input.RandomAccessFileInputStream
-
Gets the number of bytes that can be read (or skipped over) from this input stream.
B
- beforeRead(int) - Method in class org.apache.commons.io.input.ProxyInputStream
-
Invoked by the
read
methods before the call is proxied. - beforeRead(int) - Method in class org.apache.commons.io.input.ProxyReader
-
Invoked by the read methods before the call is proxied.
- beforeRead(int) - Method in class org.apache.commons.io.input.ThrottledInputStream
- beforeWrite(int) - Method in class org.apache.commons.io.output.CountingOutputStream
-
Updates the count with the number of bytes that are being written.
- beforeWrite(int) - Method in class org.apache.commons.io.output.ProxyCollectionWriter
-
Invoked by the write methods before the call is proxied.
- beforeWrite(int) - Method in class org.apache.commons.io.output.ProxyOutputStream
-
Invoked by the write methods before the call is proxied.
- beforeWrite(int) - Method in class org.apache.commons.io.output.ProxyWriter
-
Invoked by the write methods before the call is proxied.
- bigIntegerCounter() - Static method in class org.apache.commons.io.file.Counters
-
Returns a new BigInteger Counter.
- bigIntegerPathCounters() - Static method in class org.apache.commons.io.file.Counters
-
Returns a new BigInteger PathCounters.
- bindStream(InputStream) - Method in class org.apache.commons.io.input.DemuxInputStream
-
Binds the specified stream to the current thread.
- bindStream(OutputStream) - Method in class org.apache.commons.io.output.DemuxOutputStream
-
Binds the specified stream to the current thread.
- BOMInputStream - Class in org.apache.commons.io.input
-
This class is used to wrap a stream that includes an encoded
ByteOrderMark
as its first bytes. - BOMInputStream(InputStream) - Constructor for class org.apache.commons.io.input.BOMInputStream
-
Deprecated.
- BOMInputStream(InputStream, boolean) - Constructor for class org.apache.commons.io.input.BOMInputStream
-
Deprecated.
- BOMInputStream(InputStream, boolean, ByteOrderMark...) - Constructor for class org.apache.commons.io.input.BOMInputStream
-
Deprecated.
- BOMInputStream(InputStream, ByteOrderMark...) - Constructor for class org.apache.commons.io.input.BOMInputStream
-
Deprecated.
- BOMInputStream.Builder - Class in org.apache.commons.io.input
-
Builds a new
BOMInputStream
. - BoundedInputStream - Class in org.apache.commons.io.input
-
Reads bytes up to a maximum count and stops once reached.
- BoundedInputStream(InputStream) - Constructor for class org.apache.commons.io.input.BoundedInputStream
-
Deprecated.Use
IOSupplier.get()
. - BoundedInputStream(InputStream, long) - Constructor for class org.apache.commons.io.input.BoundedInputStream
-
Deprecated.Use
IOSupplier.get()
. - BoundedInputStream.Builder - Class in org.apache.commons.io.input
-
Builds a new
BoundedInputStream
. - BoundedReader - Class in org.apache.commons.io.input
-
A reader that imposes a limit to the number of characters that can be read from an underlying reader, returning EOF when this limit is reached, regardless of state of underlying reader.
- BoundedReader(Reader, int) - Constructor for class org.apache.commons.io.input.BoundedReader
-
Constructs a bounded reader
- branch - Variable in class org.apache.commons.io.output.TeeOutputStream
-
The second OutputStream to write to.
- BrokenInputStream - Class in org.apache.commons.io.input
-
Always throws an exception from all
InputStream
methods whereIOException
is declared. - BrokenInputStream() - Constructor for class org.apache.commons.io.input.BrokenInputStream
-
Constructs a new stream that always throws an
IOException
. - BrokenInputStream(IOException) - Constructor for class org.apache.commons.io.input.BrokenInputStream
-
Deprecated.
- BrokenInputStream(Throwable) - Constructor for class org.apache.commons.io.input.BrokenInputStream
-
Constructs a new stream that always throws the given exception.
- BrokenInputStream(Supplier<Throwable>) - Constructor for class org.apache.commons.io.input.BrokenInputStream
-
Constructs a new stream that always throws the supplied exception.
- BrokenOutputStream - Class in org.apache.commons.io.output
-
Always throws an exception from all
OutputStream
methods whereIOException
is declared. - BrokenOutputStream() - Constructor for class org.apache.commons.io.output.BrokenOutputStream
-
Constructs a new stream that always throws an
IOException
. - BrokenOutputStream(IOException) - Constructor for class org.apache.commons.io.output.BrokenOutputStream
-
Deprecated.
- BrokenOutputStream(Throwable) - Constructor for class org.apache.commons.io.output.BrokenOutputStream
-
Constructs a new stream that always throws the given exception.
- BrokenOutputStream(Supplier<Throwable>) - Constructor for class org.apache.commons.io.output.BrokenOutputStream
-
Constructs a new stream that always throws the supplied exception.
- BrokenReader - Class in org.apache.commons.io.input
-
Always throws an exception from all
Reader
methods whereIOException
is declared. - BrokenReader() - Constructor for class org.apache.commons.io.input.BrokenReader
-
Constructs a new reader that always throws an
IOException
. - BrokenReader(IOException) - Constructor for class org.apache.commons.io.input.BrokenReader
-
Deprecated.
- BrokenReader(Throwable) - Constructor for class org.apache.commons.io.input.BrokenReader
-
Constructs a new reader that always throws the given exception.
- BrokenReader(Supplier<Throwable>) - Constructor for class org.apache.commons.io.input.BrokenReader
-
Constructs a new reader that always throws the supplied exception.
- BrokenWriter - Class in org.apache.commons.io.output
-
Always throws an exception from all
Writer
methods whereIOException
is declared. - BrokenWriter() - Constructor for class org.apache.commons.io.output.BrokenWriter
-
Constructs a new writer that always throws an
IOException
. - BrokenWriter(IOException) - Constructor for class org.apache.commons.io.output.BrokenWriter
-
Deprecated.
- BrokenWriter(Throwable) - Constructor for class org.apache.commons.io.output.BrokenWriter
-
Constructs a new writer that always throws the given exception.
- BrokenWriter(Supplier<Throwable>) - Constructor for class org.apache.commons.io.output.BrokenWriter
-
Constructs a new writer that always throws the supplied exception.
- buffer - Variable in class org.apache.commons.io.input.buffer.CircularBufferInputStream
-
Internal buffer.
- buffer - Variable in class org.apache.commons.io.input.UnsynchronizedBufferedInputStream
-
The buffer containing the current bytes read from the target InputStream.
- buffer(InputStream) - Static method in class org.apache.commons.io.IOUtils
-
Returns the given InputStream if it is already a
BufferedInputStream
, otherwise creates a BufferedInputStream from the given InputStream. - buffer(InputStream, int) - Static method in class org.apache.commons.io.IOUtils
-
Returns the given InputStream if it is already a
BufferedInputStream
, otherwise creates a BufferedInputStream from the given InputStream. - buffer(OutputStream) - Static method in class org.apache.commons.io.IOUtils
-
Returns the given OutputStream if it is already a
BufferedOutputStream
, otherwise creates a BufferedOutputStream from the given OutputStream. - buffer(OutputStream, int) - Static method in class org.apache.commons.io.IOUtils
-
Returns the given OutputStream if it is already a
BufferedOutputStream
, otherwise creates a BufferedOutputStream from the given OutputStream. - buffer(Reader) - Static method in class org.apache.commons.io.IOUtils
-
Returns the given reader if it is already a
BufferedReader
, otherwise creates a BufferedReader from the given reader. - buffer(Reader, int) - Static method in class org.apache.commons.io.IOUtils
-
Returns the given reader if it is already a
BufferedReader
, otherwise creates a BufferedReader from the given reader. - buffer(Writer) - Static method in class org.apache.commons.io.IOUtils
-
Returns the given Writer if it is already a
BufferedWriter
, otherwise creates a BufferedWriter from the given Writer. - buffer(Writer, int) - Static method in class org.apache.commons.io.IOUtils
-
Returns the given Writer if it is already a
BufferedWriter
, otherwise creates a BufferedWriter from the given Writer. - BufferedFileChannelInputStream - Class in org.apache.commons.io.input
-
InputStream
implementation which uses direct buffer to read a file to avoid extra copy of data between Java and native memory which happens when usingBufferedInputStream
. - BufferedFileChannelInputStream(File) - Constructor for class org.apache.commons.io.input.BufferedFileChannelInputStream
- BufferedFileChannelInputStream(File, int) - Constructor for class org.apache.commons.io.input.BufferedFileChannelInputStream
- BufferedFileChannelInputStream(Path) - Constructor for class org.apache.commons.io.input.BufferedFileChannelInputStream
- BufferedFileChannelInputStream(Path, int) - Constructor for class org.apache.commons.io.input.BufferedFileChannelInputStream
- BufferedFileChannelInputStream.Builder - Class in org.apache.commons.io.input
-
Builds a new
BufferedFileChannelInputStream
. - bufferSize - Variable in class org.apache.commons.io.input.buffer.CircularBufferInputStream
-
Internal buffer size.
- builder() - Static method in class org.apache.commons.io.filefilter.WildcardFileFilter
-
Constructs a new
WildcardFileFilter.Builder
. - builder() - Static method in class org.apache.commons.io.input.AutoCloseInputStream
-
Constructs a new
AutoCloseInputStream.Builder
. - builder() - Static method in class org.apache.commons.io.input.BOMInputStream
-
Constructs a new
BOMInputStream.Builder
. - builder() - Static method in class org.apache.commons.io.input.BoundedInputStream
-
Constructs a new
BoundedInputStream.AbstractBuilder
. - builder() - Static method in class org.apache.commons.io.input.BufferedFileChannelInputStream
-
Constructs a new
BufferedFileChannelInputStream.Builder
. - builder() - Static method in class org.apache.commons.io.input.CharSequenceInputStream
-
Constructs a new
CharSequenceInputStream.Builder
. - builder() - Static method in class org.apache.commons.io.input.ChecksumInputStream
-
Constructs a new
ChecksumInputStream.Builder
. - builder() - Static method in class org.apache.commons.io.input.MemoryMappedFileInputStream
-
Constructs a new
MemoryMappedFileInputStream.Builder
. - builder() - Static method in class org.apache.commons.io.input.MessageDigestCalculatingInputStream
-
Deprecated.Constructs a new
MessageDigestCalculatingInputStream.Builder
. - builder() - Static method in class org.apache.commons.io.input.MessageDigestInputStream
-
Constructs a new
MessageDigestInputStream.Builder
. - builder() - Static method in class org.apache.commons.io.input.QueueInputStream
-
Constructs a new
QueueInputStream.Builder
. - builder() - Static method in class org.apache.commons.io.input.RandomAccessFileInputStream
-
Constructs a new
RandomAccessFileInputStream.Builder
. - builder() - Static method in class org.apache.commons.io.input.ReadAheadInputStream
-
Constructs a new
ReadAheadInputStream.Builder
. - builder() - Static method in class org.apache.commons.io.input.ReaderInputStream
-
Constructs a new
ReaderInputStream.Builder
. - builder() - Static method in class org.apache.commons.io.input.ReversedLinesFileReader
-
Constructs a new
ReversedLinesFileReader.Builder
. - builder() - Static method in class org.apache.commons.io.input.Tailer
-
Constructs a new
Tailer.Builder
. - builder() - Static method in class org.apache.commons.io.input.ThrottledInputStream
-
Constructs a new
ThrottledInputStream.Builder
. - builder() - Static method in class org.apache.commons.io.input.UncheckedBufferedReader
-
Constructs a new
UncheckedBufferedReader.Builder
. - builder() - Static method in class org.apache.commons.io.input.UncheckedFilterInputStream
-
Constructs a new
UncheckedFilterInputStream.Builder
. - builder() - Static method in class org.apache.commons.io.input.UncheckedFilterReader
-
Constructs a new
UncheckedFilterReader.Builder
. - builder() - Static method in class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream
-
Constructs a new
UnsynchronizedByteArrayInputStream.Builder
. - builder() - Static method in class org.apache.commons.io.input.UnsynchronizedFilterInputStream
-
Constructs a new
UnsynchronizedFilterInputStream.Builder
. - builder() - Static method in class org.apache.commons.io.input.XmlStreamReader
-
Constructs a new
XmlStreamReader.Builder
. - builder() - Static method in class org.apache.commons.io.monitor.FileAlterationObserver
-
Creates a new builder.
- builder() - Static method in class org.apache.commons.io.output.ChunkedOutputStream
-
Constructs a new
ChunkedOutputStream.Builder
. - builder() - Static method in class org.apache.commons.io.output.DeferredFileOutputStream
-
Constructs a new
DeferredFileOutputStream.Builder
. - builder() - Static method in class org.apache.commons.io.output.FileWriterWithEncoding
-
Constructs a new
FileWriterWithEncoding.Builder
. - builder() - Static method in class org.apache.commons.io.output.LockableFileWriter
-
Constructs a new
LockableFileWriter.Builder
. - builder() - Static method in class org.apache.commons.io.output.RandomAccessFileOutputStream
-
Constructs a new
RandomAccessFileOutputStream.Builder
. - builder() - Static method in class org.apache.commons.io.output.UncheckedFilterOutputStream
-
Constructs a new
UncheckedFilterOutputStream.Builder
. - builder() - Static method in class org.apache.commons.io.output.UncheckedFilterWriter
-
Constructs a new
UncheckedFilterWriter.Builder
. - builder() - Static method in class org.apache.commons.io.output.UnsynchronizedByteArrayOutputStream
-
Constructs a new
UnsynchronizedByteArrayOutputStream.Builder
. - builder() - Static method in class org.apache.commons.io.output.WriterOutputStream
-
Constructs a new
WriterOutputStream.Builder
. - builder() - Static method in class org.apache.commons.io.output.XmlStreamWriter
-
Constructs a new
XmlStreamWriter.Builder
. - builder() - Static method in class org.apache.commons.io.serialization.ValidatingObjectInputStream
-
Constructs a new
ValidatingObjectInputStream.Builder
. - Builder() - Constructor for class org.apache.commons.io.filefilter.WildcardFileFilter.Builder
- Builder() - Constructor for class org.apache.commons.io.input.AutoCloseInputStream.Builder
- Builder() - Constructor for class org.apache.commons.io.input.BOMInputStream.Builder
- Builder() - Constructor for class org.apache.commons.io.input.BoundedInputStream.Builder
- Builder() - Constructor for class org.apache.commons.io.input.BufferedFileChannelInputStream.Builder
- Builder() - Constructor for class org.apache.commons.io.input.CharSequenceInputStream.Builder
- Builder() - Constructor for class org.apache.commons.io.input.ChecksumInputStream.Builder
- Builder() - Constructor for class org.apache.commons.io.input.MemoryMappedFileInputStream.Builder
-
Constructs a new
MemoryMappedFileInputStream.Builder
. - Builder() - Constructor for class org.apache.commons.io.input.MessageDigestCalculatingInputStream.Builder
-
Deprecated.Constructs a new
MessageDigestCalculatingInputStream.Builder
. - Builder() - Constructor for class org.apache.commons.io.input.MessageDigestInputStream.Builder
-
Constructs a new
MessageDigestInputStream.Builder
. - Builder() - Constructor for class org.apache.commons.io.input.ObservableInputStream.Builder
- Builder() - Constructor for class org.apache.commons.io.input.QueueInputStream.Builder
- Builder() - Constructor for class org.apache.commons.io.input.RandomAccessFileInputStream.Builder
- Builder() - Constructor for class org.apache.commons.io.input.ReadAheadInputStream.Builder
- Builder() - Constructor for class org.apache.commons.io.input.ReaderInputStream.Builder
- Builder() - Constructor for class org.apache.commons.io.input.ReversedLinesFileReader.Builder
-
Constructs a new
ReversedLinesFileReader.Builder
. - Builder() - Constructor for class org.apache.commons.io.input.Tailer.Builder
- Builder() - Constructor for class org.apache.commons.io.input.ThrottledInputStream.Builder
- Builder() - Constructor for class org.apache.commons.io.input.UncheckedBufferedReader.Builder
- Builder() - Constructor for class org.apache.commons.io.input.UncheckedFilterInputStream.Builder
- Builder() - Constructor for class org.apache.commons.io.input.UncheckedFilterReader.Builder
- Builder() - Constructor for class org.apache.commons.io.input.UnsynchronizedBufferedInputStream.Builder
- Builder() - Constructor for class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream.Builder
- Builder() - Constructor for class org.apache.commons.io.input.UnsynchronizedFilterInputStream.Builder
- Builder() - Constructor for class org.apache.commons.io.input.XmlStreamReader.Builder
- Builder() - Constructor for class org.apache.commons.io.output.ChunkedOutputStream.Builder
- Builder() - Constructor for class org.apache.commons.io.output.DeferredFileOutputStream.Builder
-
Constructs a new builder.
- Builder() - Constructor for class org.apache.commons.io.output.FileWriterWithEncoding.Builder
- Builder() - Constructor for class org.apache.commons.io.output.LockableFileWriter.Builder
-
Builds a new
LockableFileWriter
. - Builder() - Constructor for class org.apache.commons.io.output.UncheckedFilterOutputStream.Builder
- Builder() - Constructor for class org.apache.commons.io.output.UncheckedFilterWriter.Builder
- Builder() - Constructor for class org.apache.commons.io.output.UnsynchronizedByteArrayOutputStream.Builder
- Builder() - Constructor for class org.apache.commons.io.output.WriterOutputStream.Builder
-
Constructs a new Builder.
- Builder() - Constructor for class org.apache.commons.io.output.XmlStreamWriter.Builder
-
Constructs a new
XmlStreamWriter.Builder
. - Builder() - Constructor for class org.apache.commons.io.serialization.ValidatingObjectInputStream.Builder
-
Deprecated.
- byteArray() - Static method in class org.apache.commons.io.IOUtils
-
Returns a new byte array of size
IOUtils.DEFAULT_BUFFER_SIZE
. - byteArray(int) - Static method in class org.apache.commons.io.IOUtils
-
Returns a new byte array of the given size.
- ByteArrayOrigin(byte[]) - Constructor for class org.apache.commons.io.build.AbstractOrigin.ByteArrayOrigin
-
Constructs a new instance for the given origin.
- ByteArrayOutputStream - Class in org.apache.commons.io.output
-
Implements a ThreadSafe version of
AbstractByteArrayOutputStream
using instance synchronization. - ByteArrayOutputStream() - Constructor for class org.apache.commons.io.output.ByteArrayOutputStream
-
Constructs a new byte array output stream.
- ByteArrayOutputStream(int) - Constructor for class org.apache.commons.io.output.ByteArrayOutputStream
-
Constructs a new byte array output stream, with a buffer capacity of the specified size, in bytes.
- byteCountToDisplaySize(long) - Static method in class org.apache.commons.io.FileUtils
-
Returns a human-readable version of the file size, where the input represents a specific number of bytes.
- byteCountToDisplaySize(Number) - Static method in class org.apache.commons.io.FileUtils
-
Returns a human-readable version of the file size, where the input represents a specific number of bytes.
- byteCountToDisplaySize(BigInteger) - Static method in class org.apache.commons.io.FileUtils
-
Returns a human-readable version of the file size, where the input represents a specific number of bytes.
- ByteOrderMark - Class in org.apache.commons.io
-
Byte Order Mark (BOM) representation.
- ByteOrderMark(String, int...) - Constructor for class org.apache.commons.io.ByteOrderMark
-
Constructs a new instance.
- ByteOrderParser - Class in org.apache.commons.io
-
Converts Strings to
ByteOrder
instances.
C
- CAN_EXECUTE - Static variable in class org.apache.commons.io.filefilter.CanExecuteFileFilter
-
Singleton instance of executable filter
- CAN_READ - Static variable in class org.apache.commons.io.filefilter.CanReadFileFilter
-
Singleton instance of readable filter
- CAN_WRITE - Static variable in class org.apache.commons.io.filefilter.CanWriteFileFilter
-
Singleton instance of writable filter
- CancelException(File, int) - Constructor for exception org.apache.commons.io.DirectoryWalker.CancelException
-
Deprecated.Constructs a
DirectoryWalker.CancelException
with the file and depth when cancellation occurred. - CancelException(String, File, int) - Constructor for exception org.apache.commons.io.DirectoryWalker.CancelException
-
Deprecated.Constructs a
DirectoryWalker.CancelException
with an appropriate message and the file and depth when cancellation occurred. - CanExecuteFileFilter - Class in org.apache.commons.io.filefilter
-
This filter accepts
File
s that can be executed. - CanExecuteFileFilter() - Constructor for class org.apache.commons.io.filefilter.CanExecuteFileFilter
-
Restrictive constructor.
- CANNOT_EXECUTE - Static variable in class org.apache.commons.io.filefilter.CanExecuteFileFilter
-
Singleton instance of not executable filter
- CANNOT_READ - Static variable in class org.apache.commons.io.filefilter.CanReadFileFilter
-
Singleton instance of not readable filter
- CANNOT_WRITE - Static variable in class org.apache.commons.io.filefilter.CanWriteFileFilter
-
Singleton instance of not writable filter
- CanReadFileFilter - Class in org.apache.commons.io.filefilter
-
This filter accepts
File
s that can be read. - CanReadFileFilter() - Constructor for class org.apache.commons.io.filefilter.CanReadFileFilter
-
Restrictive constructor.
- CanWriteFileFilter - Class in org.apache.commons.io.filefilter
-
This filter accepts
File
s that can be written to. - CanWriteFileFilter() - Constructor for class org.apache.commons.io.filefilter.CanWriteFileFilter
-
Restrictive constructor.
- CharacterFilterReader - Class in org.apache.commons.io.input
-
A filter reader that filters out a given character represented as an
int
code point, handy to remove known junk characters from CSV files for example. - CharacterFilterReader(Reader, int) - Constructor for class org.apache.commons.io.input.CharacterFilterReader
-
Constructs a new reader.
- CharacterFilterReader(Reader, IntPredicate) - Constructor for class org.apache.commons.io.input.CharacterFilterReader
-
Constructs a new reader.
- characteristics() - Method in interface org.apache.commons.io.function.IOSpliterator
- CharacterSetFilterReader - Class in org.apache.commons.io.input
-
A filter reader that removes a given set of characters represented as
int
code points, handy to remove known junk characters from CSV files for example. - CharacterSetFilterReader(Reader, Integer...) - Constructor for class org.apache.commons.io.input.CharacterSetFilterReader
-
Constructs a new reader.
- CharacterSetFilterReader(Reader, Set<Integer>) - Constructor for class org.apache.commons.io.input.CharacterSetFilterReader
-
Constructs a new reader.
- CharSequenceInputStream - Class in org.apache.commons.io.input
-
Implements an
InputStream
to read bytes from String, StringBuffer, StringBuilder or CharBuffer, encoded using the specified Charset. - CharSequenceInputStream(CharSequence, String) - Constructor for class org.apache.commons.io.input.CharSequenceInputStream
- CharSequenceInputStream(CharSequence, String, int) - Constructor for class org.apache.commons.io.input.CharSequenceInputStream
- CharSequenceInputStream(CharSequence, Charset) - Constructor for class org.apache.commons.io.input.CharSequenceInputStream
- CharSequenceInputStream(CharSequence, Charset, int) - Constructor for class org.apache.commons.io.input.CharSequenceInputStream
- CharSequenceInputStream.Builder - Class in org.apache.commons.io.input
-
Builds a new
CharSequenceInputStream
. - CharSequenceOrigin(CharSequence) - Constructor for class org.apache.commons.io.build.AbstractOrigin.CharSequenceOrigin
-
Constructs a new instance for the given origin.
- CharSequenceReader - Class in org.apache.commons.io.input
-
Reader
implementation that can read from String, StringBuffer, StringBuilder or CharBuffer. - CharSequenceReader(CharSequence) - Constructor for class org.apache.commons.io.input.CharSequenceReader
-
Constructs a new instance with the specified character sequence.
- CharSequenceReader(CharSequence, int) - Constructor for class org.apache.commons.io.input.CharSequenceReader
-
Constructs a new instance with a portion of the specified character sequence.
- CharSequenceReader(CharSequence, int, int) - Constructor for class org.apache.commons.io.input.CharSequenceReader
-
Constructs a new instance with a portion of the specified character sequence.
- CharsetDecoders - Class in org.apache.commons.io.charset
-
Works with
CharsetDecoder
. - CharsetEncoders - Class in org.apache.commons.io.charset
-
Works with
CharsetEncoder
. - Charsets - Class in org.apache.commons.io
-
Charsets required of every implementation of the Java platform.
- Charsets() - Constructor for class org.apache.commons.io.Charsets
- checkAndNotify() - Method in class org.apache.commons.io.monitor.FileAlterationObserver
-
Checks whether the file and its children have been created, modified or deleted.
- checkCompareTo(String, String) - Method in enum org.apache.commons.io.IOCase
-
Compares two strings using the case-sensitivity rule.
- checkEmpty(List<? extends Throwable>, Object) - Static method in exception org.apache.commons.io.IOExceptionList
-
Throws this exception if the list is not null or empty.
- checkEndsWith(String, String) - Method in enum org.apache.commons.io.IOCase
-
Checks if one string ends with another using the case-sensitivity rule.
- checkEquals(String, String) - Method in enum org.apache.commons.io.IOCase
-
Compares two strings using the case-sensitivity rule.
- checkIfCancelled(File, int, Collection<T>) - Method in class org.apache.commons.io.DirectoryWalker
-
Deprecated.Checks whether the walk has been cancelled by calling
DirectoryWalker.handleIsCancelled(java.io.File, int, java.util.Collection<T>)
, throwing aDirectoryWalker.CancelException
if it has. - checkIndexOf(String, int, String) - Method in enum org.apache.commons.io.IOCase
-
Checks if one string contains another starting at a specific index using the case-sensitivity rule.
- checkOrigin() - Method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Checks whether the origin is null.
- checkRegionMatches(String, int, String) - Method in enum org.apache.commons.io.IOCase
-
Checks if one string contains another at a specific index using the case-sensitivity rule.
- checkStartsWith(String, String) - Method in enum org.apache.commons.io.IOCase
-
Checks if one string starts with another using the case-sensitivity rule.
- checksum(File, Checksum) - Static method in class org.apache.commons.io.FileUtils
-
Computes the checksum of a file using the specified checksum object.
- checksumCRC32(File) - Static method in class org.apache.commons.io.FileUtils
-
Computes the checksum of a file using the CRC32 checksum routine.
- ChecksumInputStream - Class in org.apache.commons.io.input
-
Automatically verifies a
Checksum
value once the stream is exhausted or the count threshold is reached. - ChecksumInputStream.Builder - Class in org.apache.commons.io.input
-
Builds a new
ChecksumInputStream
. - checkThreshold(int) - Method in class org.apache.commons.io.output.ThresholdingOutputStream
-
Checks to see if writing the specified number of bytes would cause the configured threshold to be exceeded.
- ChunkedOutputStream - Class in org.apache.commons.io.output
-
OutputStream which breaks larger output blocks into chunks.
- ChunkedOutputStream(OutputStream) - Constructor for class org.apache.commons.io.output.ChunkedOutputStream
-
Deprecated.
- ChunkedOutputStream(OutputStream, int) - Constructor for class org.apache.commons.io.output.ChunkedOutputStream
-
Deprecated.
- ChunkedOutputStream.Builder - Class in org.apache.commons.io.output
-
Builds a new
UnsynchronizedByteArrayOutputStream
. - ChunkedWriter - Class in org.apache.commons.io.output
-
Writer which breaks larger output blocks into chunks.
- ChunkedWriter(Writer) - Constructor for class org.apache.commons.io.output.ChunkedWriter
-
Constructs a new writer that uses a chunk size of
ChunkedWriter.DEFAULT_CHUNK_SIZE
- ChunkedWriter(Writer, int) - Constructor for class org.apache.commons.io.output.ChunkedWriter
-
Constructs a new writer that uses the specified chunk size.
- CircularBufferInputStream - Class in org.apache.commons.io.input.buffer
-
Implements a buffered input stream, which is internally based on a
CircularByteBuffer
. - CircularBufferInputStream(InputStream) - Constructor for class org.apache.commons.io.input.buffer.CircularBufferInputStream
-
Constructs a new instance, which filters the given input stream, and uses a reasonable default buffer size (
IOUtils.DEFAULT_BUFFER_SIZE
). - CircularBufferInputStream(InputStream, int) - Constructor for class org.apache.commons.io.input.buffer.CircularBufferInputStream
-
Constructs a new instance, which filters the given input stream, and uses the given buffer size.
- CircularByteBuffer - Class in org.apache.commons.io.input.buffer
-
A buffer, which doesn't need reallocation of byte arrays, because it reuses a single byte array.
- CircularByteBuffer() - Constructor for class org.apache.commons.io.input.buffer.CircularByteBuffer
-
Constructs a new instance with a reasonable default buffer size (
IOUtils.DEFAULT_BUFFER_SIZE
). - CircularByteBuffer(int) - Constructor for class org.apache.commons.io.input.buffer.CircularByteBuffer
-
Constructs a new instance with the given buffer size.
- CircularInputStream - Class in org.apache.commons.io.input
-
An
InputStream
that repeats provided bytes for given target byte count. - CircularInputStream(byte[], long) - Constructor for class org.apache.commons.io.input.CircularInputStream
-
Constructs an instance from the specified array of bytes.
- ClassLoaderObjectInputStream - Class in org.apache.commons.io.input
-
A special ObjectInputStream that loads a class based on a specified
ClassLoader
rather than the system default. - ClassLoaderObjectInputStream(ClassLoader, InputStream) - Constructor for class org.apache.commons.io.input.ClassLoaderObjectInputStream
-
Constructs a new ClassLoaderObjectInputStream.
- ClassNameMatcher - Interface in org.apache.commons.io.serialization
-
An object that matches a Class name to a condition.
- cleanDirectory(File) - Static method in class org.apache.commons.io.FileUtils
-
Cleans a directory without deleting it.
- cleanDirectory(Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Cleans a directory by deleting only files, including in subdirectories, but without deleting the directories.
- cleanDirectory(Path, DeleteOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Cleans a directory by deleting only files, including in subdirectories, but without deleting the directories.
- CleaningPathVisitor - Class in org.apache.commons.io.file
-
Deletes files but not directories as a visit proceeds.
- CleaningPathVisitor(Counters.PathCounters, String...) - Constructor for class org.apache.commons.io.file.CleaningPathVisitor
-
Constructs a new instance that deletes files except for the files and directories explicitly given.
- CleaningPathVisitor(Counters.PathCounters, DeleteOption[], String...) - Constructor for class org.apache.commons.io.file.CleaningPathVisitor
-
Constructs a instance that deletes files except for the files and directories explicitly given.
- clear() - Method in class org.apache.commons.io.input.buffer.CircularByteBuffer
-
Removes all bytes from the buffer.
- close() - Method in interface org.apache.commons.io.function.IOBaseStream
-
Like
BaseStream.close()
. - close() - Method in class org.apache.commons.io.input.AbstractInputStream
- close() - Method in class org.apache.commons.io.input.AutoCloseInputStream
-
Closes the underlying input stream and replaces the reference to it with a
ClosedInputStream
instance. - close() - Method in class org.apache.commons.io.input.BoundedInputStream
- close() - Method in class org.apache.commons.io.input.BoundedReader
-
Closes the target
- close() - Method in class org.apache.commons.io.input.BrokenInputStream
-
Throws the configured exception.
- close() - Method in class org.apache.commons.io.input.BrokenReader
-
Throws the configured exception.
- close() - Method in class org.apache.commons.io.input.buffer.CircularBufferInputStream
- close() - Method in class org.apache.commons.io.input.BufferedFileChannelInputStream
- close() - Method in class org.apache.commons.io.input.CharSequenceInputStream
- close() - Method in class org.apache.commons.io.input.CharSequenceReader
-
Close resets the file back to the start and removes any marked position.
- close() - Method in class org.apache.commons.io.input.CircularInputStream
- close() - Method in class org.apache.commons.io.input.ClosedReader
- close() - Method in class org.apache.commons.io.input.CloseShieldInputStream
-
Replaces the underlying input stream with a
ClosedInputStream
sentinel. - close() - Method in class org.apache.commons.io.input.CloseShieldReader
-
Replaces the underlying reader with a
ClosedReader
sentinel. - close() - Method in class org.apache.commons.io.input.DemuxInputStream
-
Closes stream associated with current thread.
- close() - Method in class org.apache.commons.io.input.MemoryMappedFileInputStream
- close() - Method in class org.apache.commons.io.input.NullInputStream
-
Closes this input stream.
- close() - Method in class org.apache.commons.io.input.NullReader
-
Closes this Reader - resets the internal state to the initial values.
- close() - Method in class org.apache.commons.io.input.ObservableInputStream
- close() - Method in class org.apache.commons.io.input.ProxyInputStream
-
Invokes the delegate's
InputStream.close()
method. - close() - Method in class org.apache.commons.io.input.ProxyReader
-
Invokes the delegate's
close()
method. - close() - Method in class org.apache.commons.io.input.RandomAccessFileInputStream
- close() - Method in class org.apache.commons.io.input.ReadAheadInputStream
- close() - Method in class org.apache.commons.io.input.ReaderInputStream
-
Closes the stream.
- close() - Method in class org.apache.commons.io.input.ReversedLinesFileReader
-
Closes underlying resources.
- close() - Method in class org.apache.commons.io.input.SequenceReader
- close() - Method in class org.apache.commons.io.input.Tailer
-
Requests the tailer to complete its current loop and return.
- close() - Method in class org.apache.commons.io.input.TeeInputStream
-
Closes the proxied input stream and, if so configured, the associated output stream.
- close() - Method in class org.apache.commons.io.input.TeeReader
-
Closes the proxied reader and, if so configured, the associated writer.
- close() - Method in class org.apache.commons.io.input.UncheckedBufferedReader
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - close() - Method in class org.apache.commons.io.input.UncheckedFilterInputStream
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - close() - Method in class org.apache.commons.io.input.UncheckedFilterReader
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - close() - Method in class org.apache.commons.io.input.UnixLineEndingInputStream
-
Closes the stream.
- close() - Method in class org.apache.commons.io.input.UnsynchronizedBufferedInputStream
-
Closes this stream.
- close() - Method in class org.apache.commons.io.input.UnsynchronizedBufferedReader
-
Closes this reader.
- close() - Method in class org.apache.commons.io.input.UnsynchronizedFilterInputStream
-
Closes this stream.
- close() - Method in class org.apache.commons.io.input.UnsynchronizedReader
- close() - Method in class org.apache.commons.io.input.WindowsLineEndingInputStream
-
Closes the stream.
- close() - Method in class org.apache.commons.io.input.XmlStreamReader
-
Closes the XmlStreamReader stream.
- close() - Method in class org.apache.commons.io.LineIterator
-
Closes the underlying
Reader
. - close() - Method in class org.apache.commons.io.output.AbstractByteArrayOutputStream
-
Does nothing.
- close() - Method in class org.apache.commons.io.output.AppendableWriter
-
Closes the stream.
- close() - Method in class org.apache.commons.io.output.BrokenOutputStream
-
Throws the configured exception.
- close() - Method in class org.apache.commons.io.output.BrokenWriter
-
Throws the configured exception.
- close() - Method in class org.apache.commons.io.output.ClosedWriter
- close() - Method in class org.apache.commons.io.output.CloseShieldOutputStream
-
Replaces the underlying output stream with a
ClosedOutputStream
sentinel. - close() - Method in class org.apache.commons.io.output.CloseShieldWriter
-
Replaces the underlying writer with a
ClosedWriter
sentinel. - close() - Method in class org.apache.commons.io.output.DeferredFileOutputStream
-
Closes underlying output stream, and mark this as closed
- close() - Method in class org.apache.commons.io.output.DemuxOutputStream
-
Closes stream associated with current thread.
- close() - Method in class org.apache.commons.io.output.FilterCollectionWriter
- close() - Method in class org.apache.commons.io.output.LockableFileWriter
-
Closes the file writer and deletes the lock file.
- close() - Method in class org.apache.commons.io.output.NullWriter
- close() - Method in class org.apache.commons.io.output.ProxyCollectionWriter
-
Invokes the delegate's
close()
method. - close() - Method in class org.apache.commons.io.output.ProxyOutputStream
-
Invokes the delegate's
close()
method. - close() - Method in class org.apache.commons.io.output.ProxyWriter
-
Invokes the delegate's
close()
method. - close() - Method in class org.apache.commons.io.output.RandomAccessFileOutputStream
- close() - Method in class org.apache.commons.io.output.StringBuilderWriter
-
Closing this writer has no effect.
- close() - Method in class org.apache.commons.io.output.TeeOutputStream
-
Closes both output streams.
- close() - Method in class org.apache.commons.io.output.ThresholdingOutputStream
-
Closes this output stream and releases any system resources associated with this stream.
- close() - Method in class org.apache.commons.io.output.UncheckedFilterOutputStream
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - close() - Method in class org.apache.commons.io.output.UncheckedFilterWriter
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - close() - Method in class org.apache.commons.io.output.WriterOutputStream
-
Close the stream.
- close() - Method in class org.apache.commons.io.output.XmlStreamWriter
-
Closes the underlying writer.
- close() - Method in class org.apache.commons.io.StreamIterator
-
Closes the underlying stream.
- close(Closeable) - Static method in class org.apache.commons.io.IOUtils
-
Closes the given
Closeable
as a null-safe operation. - close(Closeable...) - Static method in class org.apache.commons.io.IOUtils
-
Closes the given
Closeable
s as null-safe operations. - close(Closeable, IOConsumer<IOException>) - Static method in class org.apache.commons.io.IOUtils
-
Closes the given
Closeable
as a null-safe operation. - close(URLConnection) - Static method in class org.apache.commons.io.IOUtils
-
Closes a URLConnection.
- closed() - Method in class org.apache.commons.io.input.ObservableInputStream.Observer
-
Called to indicate that the
ObservableInputStream
has been closed. - closed() - Method in class org.apache.commons.io.input.TimestampedObserver
- CLOSED_INPUT_STREAM - Static variable in class org.apache.commons.io.input.ClosedInputStream
-
Deprecated.
- CLOSED_OUTPUT_STREAM - Static variable in class org.apache.commons.io.output.ClosedOutputStream
-
Deprecated.
- CLOSED_READER - Static variable in class org.apache.commons.io.input.ClosedReader
-
Deprecated.
- CLOSED_WRITER - Static variable in class org.apache.commons.io.output.ClosedWriter
-
Deprecated.
- ClosedInputStream - Class in org.apache.commons.io.input
-
Always returns
IOUtils.EOF
to all attempts to read something from an input stream. - ClosedInputStream() - Constructor for class org.apache.commons.io.input.ClosedInputStream
- ClosedOutputStream - Class in org.apache.commons.io.output
-
Throws an IOException on all attempts to write to the stream.
- ClosedOutputStream() - Constructor for class org.apache.commons.io.output.ClosedOutputStream
- ClosedReader - Class in org.apache.commons.io.input
-
Always returns
IOUtils.EOF
to all attempts to read something from it. - ClosedReader() - Constructor for class org.apache.commons.io.input.ClosedReader
- ClosedWriter - Class in org.apache.commons.io.output
-
Throws an IOException on all attempts to write with
ClosedWriter.close()
implemented as a noop. - ClosedWriter() - Constructor for class org.apache.commons.io.output.ClosedWriter
- closeQuietly(Closeable) - Static method in class org.apache.commons.io.IOUtils
-
Closes a
Closeable
unconditionally. - closeQuietly(Closeable...) - Static method in class org.apache.commons.io.IOUtils
-
Closes a
Closeable
unconditionally. - closeQuietly(Closeable, Consumer<IOException>) - Static method in class org.apache.commons.io.IOUtils
-
Closes the given
Closeable
as a null-safe operation while consuming IOException by the givenconsumer
. - closeQuietly(InputStream) - Static method in class org.apache.commons.io.IOUtils
-
Closes an
InputStream
unconditionally. - closeQuietly(OutputStream) - Static method in class org.apache.commons.io.IOUtils
-
Closes an
OutputStream
unconditionally. - closeQuietly(Reader) - Static method in class org.apache.commons.io.IOUtils
-
Closes an
Reader
unconditionally. - closeQuietly(Writer) - Static method in class org.apache.commons.io.IOUtils
-
Closes an
Writer
unconditionally. - closeQuietly(Iterable<Closeable>) - Static method in class org.apache.commons.io.IOUtils
-
Closes an iterable of
Closeable
unconditionally. - closeQuietly(ServerSocket) - Static method in class org.apache.commons.io.IOUtils
-
Closes a
ServerSocket
unconditionally. - closeQuietly(Socket) - Static method in class org.apache.commons.io.IOUtils
-
Closes a
Socket
unconditionally. - closeQuietly(Selector) - Static method in class org.apache.commons.io.IOUtils
-
Closes a
Selector
unconditionally. - closeQuietly(Stream<Closeable>) - Static method in class org.apache.commons.io.IOUtils
-
Closes a stream of
Closeable
unconditionally. - closeQuietly(LineIterator) - Static method in class org.apache.commons.io.LineIterator
-
Deprecated.As of 2.6 deprecated without replacement. Please use the try-with-resources statement or handle suppressed exceptions manually.
- CloseShieldInputStream - Class in org.apache.commons.io.input
-
Proxy stream that prevents the underlying input stream from being closed.
- CloseShieldInputStream(InputStream) - Constructor for class org.apache.commons.io.input.CloseShieldInputStream
-
Deprecated.Using this constructor prevents IDEs from warning if the underlying input stream is never closed. Use
CloseShieldInputStream.wrap(InputStream)
instead. - CloseShieldOutputStream - Class in org.apache.commons.io.output
-
Proxy stream that prevents the underlying output stream from being closed.
- CloseShieldOutputStream(OutputStream) - Constructor for class org.apache.commons.io.output.CloseShieldOutputStream
-
Deprecated.Using this constructor prevents IDEs from warning if the underlying output stream is never closed. Use
CloseShieldOutputStream.wrap(OutputStream)
instead. - CloseShieldReader - Class in org.apache.commons.io.input
-
Proxy reader that prevents the underlying reader from being closed.
- CloseShieldReader(Reader) - Constructor for class org.apache.commons.io.input.CloseShieldReader
-
Deprecated.Using this constructor prevents IDEs from warning if the underlying reader is never closed. Use
CloseShieldReader.wrap(Reader)
instead. - CloseShieldWriter - Class in org.apache.commons.io.output
-
Proxy writer that prevents the underlying writer from being closed.
- CloseShieldWriter(Writer) - Constructor for class org.apache.commons.io.output.CloseShieldWriter
-
Deprecated.Using this constructor prevents IDEs from warning if the underlying writer is never closed. Use
CloseShieldWriter.wrap(Writer)
instead. - collect(Collector<? super T, A, R>) - Method in interface org.apache.commons.io.function.IOStream
-
TODO Package-private for now, needs IOCollector?
- collect(IOSupplier<R>, IOBiConsumer<R, ? super T>, IOBiConsumer<R, R>) - Method in interface org.apache.commons.io.function.IOStream
- compare(File, File) - Method in class org.apache.commons.io.comparator.CompositeFileComparator
-
Compares the two files using delegate comparators.
- compare(File, File) - Method in class org.apache.commons.io.comparator.DefaultFileComparator
-
Compares the two files using the
File.compareTo(File)
method. - compare(File, File) - Method in class org.apache.commons.io.comparator.DirectoryFileComparator
-
Compares the two files using the
File.isDirectory()
method. - compare(File, File) - Method in class org.apache.commons.io.comparator.ExtensionFileComparator
-
Compares the extensions of two files the specified case sensitivity.
- compare(File, File) - Method in class org.apache.commons.io.comparator.LastModifiedFileComparator
-
Compares the last modified date/time of two files.
- compare(File, File) - Method in class org.apache.commons.io.comparator.NameFileComparator
-
Compares the names of two files with the specified case sensitivity.
- compare(File, File) - Method in class org.apache.commons.io.comparator.PathFileComparator
-
Compares the paths of two files the specified case sensitivity.
- compare(File, File) - Method in class org.apache.commons.io.comparator.SizeFileComparator
-
Compares the length of two files.
- compare(IOComparator<T>, T, T) - Static method in class org.apache.commons.io.function.Uncheck
-
Compares the arguments with the comparator.
- compare(T, T) - Method in interface org.apache.commons.io.function.IOComparator
-
Like
Comparator.compare(Object, Object)
but throwsIOException
. - compose(Function<? super V, ? extends T>) - Method in interface org.apache.commons.io.function.IOFunction
-
Returns a composed
IOFunction
that first applies thebefore
function to its input, and then applies this function to the result. - compose(Supplier<? extends T>) - Method in interface org.apache.commons.io.function.IOFunction
-
Returns a composed
IOFunction
that first applies thebefore
function to its input, and then applies this function to the result. - compose(IOFunction<? super V, ? extends T>) - Method in interface org.apache.commons.io.function.IOFunction
-
Returns a composed
IOFunction
that first applies thebefore
function to its input, and then applies this function to the result. - compose(IOSupplier<? extends T>) - Method in interface org.apache.commons.io.function.IOFunction
-
Returns a composed
IOFunction
that first applies thebefore
function to its input, and then applies this function to the result. - CompositeFileComparator - Class in org.apache.commons.io.comparator
-
Compare two files using a set of delegate file
Comparator
. - CompositeFileComparator(Iterable<Comparator<File>>) - Constructor for class org.apache.commons.io.comparator.CompositeFileComparator
-
Constructs a composite comparator for the set of delegate comparators.
- CompositeFileComparator(Comparator<File>...) - Constructor for class org.apache.commons.io.comparator.CompositeFileComparator
-
Constructs a composite comparator for the set of delegate comparators.
- concat(String, String) - Static method in class org.apache.commons.io.FilenameUtils
-
Concatenates a fileName to a base path using normal command line style rules.
- ConditionalFileFilter - Interface in org.apache.commons.io.filefilter
-
Defines operations for conditional file filters.
- construct(byte[], int, int) - Method in interface org.apache.commons.io.output.AbstractByteArrayOutputStream.InputStreamConstructor
-
Constructs an InputStream subclass.
- consume() - Method in class org.apache.commons.io.input.ObservableInputStream
-
Reads all data from the underlying
InputStream
, while notifying the observers. - consume(InputStream) - Static method in class org.apache.commons.io.IOUtils
-
Consumes bytes from a
InputStream
and ignores them. - consume(Reader) - Static method in class org.apache.commons.io.IOUtils
-
Consumes characters from a
Reader
and ignores them. - contentEquals(File, File) - Static method in class org.apache.commons.io.FileUtils
-
Tests whether the contents of two files are equal.
- contentEquals(InputStream, InputStream) - Static method in class org.apache.commons.io.IOUtils
-
Compares the contents of two Streams to determine if they are equal or not.
- contentEquals(RandomAccessFile, RandomAccessFile) - Static method in class org.apache.commons.io.RandomAccessFiles
-
Tests if two RandomAccessFile contents are equal.
- contentEquals(Reader, Reader) - Static method in class org.apache.commons.io.IOUtils
-
Compares the contents of two Readers to determine if they are equal or not.
- contentEquals(FileChannel, FileChannel, int) - Static method in class org.apache.commons.io.channels.FileChannels
-
Tests if two RandomAccessFiles contents are equal.
- contentEqualsIgnoreEOL(File, File, String) - Static method in class org.apache.commons.io.FileUtils
-
Compares the contents of two files to determine if they are equal or not.
- contentEqualsIgnoreEOL(Reader, Reader) - Static method in class org.apache.commons.io.IOUtils
-
Compares the contents of two Readers to determine if they are equal or not, ignoring EOL characters.
- convertFileCollectionToFileArray(Collection<File>) - Static method in class org.apache.commons.io.FileUtils
-
Converts a Collection containing
File
instances into array representation. - copy(byte[], OutputStream) - Static method in class org.apache.commons.io.CopyUtils
-
Deprecated.Copies bytes from a
byte[]
to anOutputStream
. - copy(byte[], Writer) - Static method in class org.apache.commons.io.CopyUtils
-
Deprecated.Use
CopyUtils.copy(byte[], Writer, String)
instead - copy(byte[], Writer, String) - Static method in class org.apache.commons.io.CopyUtils
-
Deprecated.Copies and convert bytes from a
byte[]
to chars on aWriter
, using the specified encoding. - copy(ByteArrayOutputStream) - Static method in class org.apache.commons.io.IOUtils
-
Copies bytes from a
ByteArrayOutputStream
to aQueueInputStream
. - copy(InputStream, OutputStream) - Static method in class org.apache.commons.io.CopyUtils
-
Deprecated.Copies bytes from an
InputStream
to anOutputStream
. - copy(InputStream, OutputStream) - Static method in class org.apache.commons.io.IOUtils
-
Copies bytes from an
InputStream
to anOutputStream
. - copy(InputStream, OutputStream, int) - Static method in class org.apache.commons.io.IOUtils
-
Copies bytes from an
InputStream
to anOutputStream
using an internal buffer of the given size. - copy(InputStream, Writer) - Static method in class org.apache.commons.io.CopyUtils
-
Deprecated.Use
CopyUtils.copy(InputStream, Writer, String)
instead - copy(InputStream, Writer) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.Use
IOUtils.copy(InputStream, Writer, Charset)
instead - copy(InputStream, Writer, String) - Static method in class org.apache.commons.io.CopyUtils
-
Deprecated.Copies and convert bytes from an
InputStream
to chars on aWriter
, using the specified encoding. - copy(InputStream, Writer, String) - Static method in class org.apache.commons.io.IOUtils
-
Copies bytes from an
InputStream
to chars on aWriter
using the specified character encoding. - copy(InputStream, Writer, Charset) - Static method in class org.apache.commons.io.IOUtils
-
Copies bytes from an
InputStream
to chars on aWriter
using the specified character encoding. - copy(InputStream, Path, CopyOption...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.copy(InputStream, Path, CopyOption...)
throwingUncheckedIOException
instead ofIOException
. - copy(Reader, OutputStream) - Static method in class org.apache.commons.io.CopyUtils
-
Deprecated.Use
CopyUtils.copy(Reader, OutputStream, String)
instead - copy(Reader, OutputStream) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.Use
IOUtils.copy(Reader, OutputStream, Charset)
instead - copy(Reader, OutputStream, String) - Static method in class org.apache.commons.io.CopyUtils
-
Deprecated.
- copy(Reader, OutputStream, String) - Static method in class org.apache.commons.io.IOUtils
-
Copies chars from a
Reader
to bytes on anOutputStream
using the specified character encoding, and calling flush. - copy(Reader, OutputStream, Charset) - Static method in class org.apache.commons.io.IOUtils
-
Copies chars from a
Reader
to bytes on anOutputStream
using the specified character encoding, and calling flush. - copy(Reader, Writer) - Static method in class org.apache.commons.io.CopyUtils
-
Deprecated.
- copy(Reader, Writer) - Static method in class org.apache.commons.io.IOUtils
- copy(Reader, Appendable) - Static method in class org.apache.commons.io.IOUtils
-
Copies chars from a
Reader
to aAppendable
. - copy(Reader, Appendable, CharBuffer) - Static method in class org.apache.commons.io.IOUtils
-
Copies chars from a
Reader
to anAppendable
. - copy(String, OutputStream) - Static method in class org.apache.commons.io.CopyUtils
-
Deprecated.Use
CopyUtils.copy(String, OutputStream, String)
instead - copy(String, OutputStream, String) - Static method in class org.apache.commons.io.CopyUtils
-
Deprecated.
- copy(String, Writer) - Static method in class org.apache.commons.io.CopyUtils
-
Deprecated.
- copy(URL, File) - Static method in class org.apache.commons.io.IOUtils
-
Copies bytes from a
URL
to anOutputStream
. - copy(URL, OutputStream) - Static method in class org.apache.commons.io.IOUtils
-
Copies bytes from a
URL
to anOutputStream
. - copy(Path, OutputStream) - Static method in class org.apache.commons.io.file.FilesUncheck
- copy(Path, Path) - Method in class org.apache.commons.io.file.CopyDirectoryVisitor
-
Copies the sourceFile to the targetFile.
- copy(Path, Path, CopyOption...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.copy(Path, Path, CopyOption...)
throwingUncheckedIOException
instead ofIOException
. - copy(IOSupplier<InputStream>, Path, CopyOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Copies the InputStream from the supplier with
Files.copy(InputStream, Path, CopyOption...)
. - copyDirectory(File, File) - Static method in class org.apache.commons.io.FileUtils
-
Copies a whole directory to a new location, preserving the file dates.
- copyDirectory(File, File, boolean) - Static method in class org.apache.commons.io.FileUtils
-
Copies a whole directory to a new location.
- copyDirectory(File, File, FileFilter) - Static method in class org.apache.commons.io.FileUtils
-
Copies a filtered directory to a new location preserving the file dates.
- copyDirectory(File, File, FileFilter, boolean) - Static method in class org.apache.commons.io.FileUtils
-
Copies a filtered directory to a new location.
- copyDirectory(File, File, FileFilter, boolean, CopyOption...) - Static method in class org.apache.commons.io.FileUtils
-
Copies a filtered directory to a new location.
- copyDirectory(Path, Path, CopyOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Copies a directory to another directory.
- copyDirectoryToDirectory(File, File) - Static method in class org.apache.commons.io.FileUtils
-
Copies a directory to within another directory preserving the file dates.
- CopyDirectoryVisitor - Class in org.apache.commons.io.file
-
Copies a source directory to a target directory.
- CopyDirectoryVisitor(Counters.PathCounters, Path, Path, CopyOption...) - Constructor for class org.apache.commons.io.file.CopyDirectoryVisitor
-
Constructs a instance that deletes files except for the files and directories explicitly given.
- CopyDirectoryVisitor(Counters.PathCounters, PathFilter, PathFilter, Path, Path, CopyOption...) - Constructor for class org.apache.commons.io.file.CopyDirectoryVisitor
-
Constructs a instance that deletes files except for the files and directories explicitly given.
- copyFile(File, File) - Static method in class org.apache.commons.io.FileUtils
-
Copies a file to a new location preserving the file date.
- copyFile(File, File, boolean) - Static method in class org.apache.commons.io.FileUtils
-
Copies an existing file to a new file location.
- copyFile(File, File, boolean, CopyOption...) - Static method in class org.apache.commons.io.FileUtils
-
Copies the contents of a file to a new location.
- copyFile(File, File, CopyOption...) - Static method in class org.apache.commons.io.FileUtils
-
Copies a file to a new location.
- copyFile(File, OutputStream) - Static method in class org.apache.commons.io.FileUtils
-
Copies bytes from a
File
to anOutputStream
. - copyFile(URL, Path, CopyOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Copies a URL to a directory.
- copyFileToDirectory(File, File) - Static method in class org.apache.commons.io.FileUtils
-
Copies a file to a directory preserving the file date.
- copyFileToDirectory(File, File, boolean) - Static method in class org.apache.commons.io.FileUtils
-
Copies a file to a directory optionally preserving the file date.
- copyFileToDirectory(URL, Path, CopyOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Copies a URL to a directory.
- copyFileToDirectory(Path, Path, CopyOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Copies a file to a directory.
- copyInputStreamToFile(InputStream, File) - Static method in class org.apache.commons.io.FileUtils
- copyLarge(InputStream, OutputStream) - Static method in class org.apache.commons.io.IOUtils
-
Copies bytes from a large (over 2GB)
InputStream
to anOutputStream
. - copyLarge(InputStream, OutputStream, byte[]) - Static method in class org.apache.commons.io.IOUtils
-
Copies bytes from a large (over 2GB)
InputStream
to anOutputStream
. - copyLarge(InputStream, OutputStream, long, long) - Static method in class org.apache.commons.io.IOUtils
-
Copies some or all bytes from a large (over 2GB)
InputStream
to anOutputStream
, optionally skipping input bytes. - copyLarge(InputStream, OutputStream, long, long, byte[]) - Static method in class org.apache.commons.io.IOUtils
-
Copies some or all bytes from a large (over 2GB)
InputStream
to anOutputStream
, optionally skipping input bytes. - copyLarge(Reader, Writer) - Static method in class org.apache.commons.io.IOUtils
- copyLarge(Reader, Writer, char[]) - Static method in class org.apache.commons.io.IOUtils
- copyLarge(Reader, Writer, long, long) - Static method in class org.apache.commons.io.IOUtils
-
Copies some or all chars from a large (over 2GB)
InputStream
to anOutputStream
, optionally skipping input chars. - copyLarge(Reader, Writer, long, long, char[]) - Static method in class org.apache.commons.io.IOUtils
-
Copies some or all chars from a large (over 2GB)
InputStream
to anOutputStream
, optionally skipping input chars. - copyToDirectory(File, File) - Static method in class org.apache.commons.io.FileUtils
-
Copies a file or directory to within another directory preserving the file dates.
- copyToDirectory(Iterable<File>, File) - Static method in class org.apache.commons.io.FileUtils
-
Copies a files to a directory preserving each file's date.
- copyToFile(InputStream, File) - Static method in class org.apache.commons.io.FileUtils
-
Copies bytes from an
InputStream
source to aFile
destination. - copyURLToFile(URL, File) - Static method in class org.apache.commons.io.FileUtils
-
Copies bytes from the URL
source
to a filedestination
. - copyURLToFile(URL, File, int, int) - Static method in class org.apache.commons.io.FileUtils
-
Copies bytes from the URL
source
to a filedestination
. - CopyUtils - Class in org.apache.commons.io
-
Deprecated.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).
- CopyUtils() - Constructor for class org.apache.commons.io.CopyUtils
-
Deprecated.TODO Make private in 3.0.
- count - Variable in class org.apache.commons.io.input.UnsynchronizedBufferedInputStream
-
The total number of bytes inside the byte array
buffer
. - count - Variable in class org.apache.commons.io.output.AbstractByteArrayOutputStream
-
The total count of bytes written.
- count() - Method in interface org.apache.commons.io.function.IOStream
-
Like
Stream.count()
. - countDirectory(Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Counts aspects of a directory including subdirectories.
- countDirectoryAsBigInteger(Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Counts aspects of a directory including subdirectories.
- Counters - Class in org.apache.commons.io.file
-
Provides counters for files, directories, and sizes, as a visit proceeds.
- Counters() - Constructor for class org.apache.commons.io.file.Counters
- Counters.Counter - Interface in org.apache.commons.io.file
-
Counts using a number.
- Counters.PathCounters - Interface in org.apache.commons.io.file
-
Counts files, directories, and sizes, as a visit proceeds.
- CountingInputStream - Class in org.apache.commons.io.input
-
Deprecated.Use
BoundedInputStream
(unbounded by default). - CountingInputStream(InputStream) - Constructor for class org.apache.commons.io.input.CountingInputStream
-
Deprecated.Constructs a new CountingInputStream.
- CountingOutputStream - Class in org.apache.commons.io.output
-
A decorating output stream that counts the number of bytes that have passed through the stream so far.
- CountingOutputStream(OutputStream) - Constructor for class org.apache.commons.io.output.CountingOutputStream
-
Constructs a new CountingOutputStream.
- CountingPathVisitor - Class in org.apache.commons.io.file
-
Counts files, directories, and sizes, as a visit proceeds.
- CountingPathVisitor(Counters.PathCounters) - Constructor for class org.apache.commons.io.file.CountingPathVisitor
-
Constructs a new instance.
- CountingPathVisitor(Counters.PathCounters, PathFilter, PathFilter) - Constructor for class org.apache.commons.io.file.CountingPathVisitor
-
Constructs a new instance.
- CountingPathVisitor(Counters.PathCounters, PathFilter, PathFilter, IOBiFunction<Path, IOException, FileVisitResult>) - Constructor for class org.apache.commons.io.file.CountingPathVisitor
-
Constructs a new instance.
- CR - Enum constant in enum org.apache.commons.io.StandardLineSeparator
-
Carriage return.
- CR - Static variable in class org.apache.commons.io.IOUtils
-
CR char '13'.
- create(File) - Method in enum org.apache.commons.io.RandomAccessFileMode
-
Constructs a random access file to read from, and optionally to write to, the file specified by the
File
argument. - create(File, Charset, TailerListener, long, boolean, boolean, int) - Static method in class org.apache.commons.io.input.Tailer
-
Deprecated.
- create(File, TailerListener) - Static method in class org.apache.commons.io.input.Tailer
-
Deprecated.
- create(File, TailerListener, long) - Static method in class org.apache.commons.io.input.Tailer
-
Deprecated.
- create(File, TailerListener, long, boolean) - Static method in class org.apache.commons.io.input.Tailer
-
Deprecated.
- create(File, TailerListener, long, boolean, boolean) - Static method in class org.apache.commons.io.input.Tailer
-
Deprecated.
- create(File, TailerListener, long, boolean, boolean, int) - Static method in class org.apache.commons.io.input.Tailer
-
Deprecated.
- create(File, TailerListener, long, boolean, int) - Static method in class org.apache.commons.io.input.Tailer
-
Deprecated.
- create(String) - Method in enum org.apache.commons.io.RandomAccessFileMode
-
Constructs a random access file to read from, and optionally to write to, the file specified by the
File
argument. - create(Path) - Method in enum org.apache.commons.io.RandomAccessFileMode
-
Constructs a random access file to read from, and optionally to write to, the file specified by the
File
argument. - createDirectories(Path, FileAttribute<?>...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.createDirectories(Path, FileAttribute...)
throwingUncheckedIOException
instead ofIOException
. - createDirectory(Path, FileAttribute<?>...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.createDirectory(Path, FileAttribute...)
throwingUncheckedIOException
instead ofIOException
. - createFile(Path, FileAttribute<?>...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.createFile(Path, FileAttribute...)
throwingUncheckedIOException
instead ofIOException
. - createLink(Path, Path) - Static method in class org.apache.commons.io.file.FilesUncheck
- createParentDirectories(File) - Static method in class org.apache.commons.io.FileUtils
-
Creates all parent directories for a File object, including any necessary but non-existent parent directories.
- createParentDirectories(Path, FileAttribute<?>...) - Static method in class org.apache.commons.io.file.PathUtils
-
Creates the parent directories for the given
path
. - createParentDirectories(Path, LinkOption, FileAttribute<?>...) - Static method in class org.apache.commons.io.file.PathUtils
-
Creates the parent directories for the given
path
. - createSymbolicLink(Path, Path, FileAttribute<?>...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.createSymbolicLink(Path, Path, FileAttribute...)
throwingUncheckedIOException
instead ofIOException
. - createTempDirectory(String, FileAttribute<?>...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.createTempDirectory(String, FileAttribute...)
throwingUncheckedIOException
instead ofIOException
. - createTempDirectory(Path, String, FileAttribute<?>...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.createTempDirectory(Path, String, FileAttribute...)
throwingUncheckedIOException
instead ofIOException
. - createTempFile(String, String, FileAttribute<?>...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.createTempFile(String, String, FileAttribute...)
throwingUncheckedIOException
instead ofIOException
. - createTempFile(Path, String, String, FileAttribute<?>...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.createTempFile(Path, String, String, FileAttribute...)
throwingUncheckedIOException
instead ofIOException
. - CRLF - Enum constant in enum org.apache.commons.io.StandardLineSeparator
-
Carriage return followed by line feed.
- current() - Static method in class org.apache.commons.io.file.PathUtils
-
Gets the current directory.
- current() - Static method in class org.apache.commons.io.FileUtils
-
Gets the current directory.
D
- data(byte[], int, int) - Method in class org.apache.commons.io.input.MessageDigestCalculatingInputStream.MessageDigestMaintainingObserver
-
Deprecated.
- data(byte[], int, int) - Method in class org.apache.commons.io.input.MessageDigestInputStream.MessageDigestMaintainingObserver
- data(byte[], int, int) - Method in class org.apache.commons.io.input.ObservableInputStream.Observer
-
Called to indicate that
InputStream.read(byte[])
, orInputStream.read(byte[], int, int)
have been called, and are about to invoke data. - data(int) - Method in class org.apache.commons.io.input.MessageDigestCalculatingInputStream.MessageDigestMaintainingObserver
-
Deprecated.
- data(int) - Method in class org.apache.commons.io.input.MessageDigestInputStream.MessageDigestMaintainingObserver
- data(int) - Method in class org.apache.commons.io.input.ObservableInputStream.Observer
-
Called to indicate, that
InputStream.read()
has been invoked on theObservableInputStream
, and will return a value. - DEFAULT_BUFFER_SIZE - Static variable in class org.apache.commons.io.IOUtils
-
The default buffer size (8192) to use in copy methods.
- DEFAULT_COMPARATOR - Static variable in class org.apache.commons.io.comparator.DefaultFileComparator
-
Singleton default comparator instance
- DEFAULT_REVERSE - Static variable in class org.apache.commons.io.comparator.DefaultFileComparator
-
Singleton reverse default comparator instance
- DefaultFileComparator - Class in org.apache.commons.io.comparator
-
Compares two files using the default
File.compareTo(File)
method. - DefaultFileComparator() - Constructor for class org.apache.commons.io.comparator.DefaultFileComparator
-
Constructs a new instance.
- DeferredFileOutputStream - Class in org.apache.commons.io.output
-
An output stream which will retain data in memory until a specified threshold is reached, and only then commit it to disk.
- DeferredFileOutputStream(int, int, File) - Constructor for class org.apache.commons.io.output.DeferredFileOutputStream
- DeferredFileOutputStream(int, int, String, String, File) - Constructor for class org.apache.commons.io.output.DeferredFileOutputStream
- DeferredFileOutputStream(int, File) - Constructor for class org.apache.commons.io.output.DeferredFileOutputStream
- DeferredFileOutputStream(int, String, String, File) - Constructor for class org.apache.commons.io.output.DeferredFileOutputStream
- DeferredFileOutputStream.Builder - Class in org.apache.commons.io.output
-
Builds a new
DeferredFileOutputStream
. - DelegateFileFilter - Class in org.apache.commons.io.filefilter
-
This class turns a Java FileFilter or FilenameFilter into an IO FileFilter.
- DelegateFileFilter(FileFilter) - Constructor for class org.apache.commons.io.filefilter.DelegateFileFilter
-
Constructs a delegate file filter around an existing FileFilter.
- DelegateFileFilter(FilenameFilter) - Constructor for class org.apache.commons.io.filefilter.DelegateFileFilter
-
Constructs a delegate file filter around an existing FilenameFilter.
- delete(File) - Method in class org.apache.commons.io.FileDeleteStrategy
-
Deletes the file object, which may be a file or a directory.
- delete(File) - Static method in class org.apache.commons.io.FileUtils
-
Deletes the given File but throws an IOException if it cannot, unlike
File.delete()
which returns a boolean. - delete(Path) - Static method in class org.apache.commons.io.file.FilesUncheck
- delete(Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Deletes a file or directory.
- delete(Path, LinkOption[], DeleteOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Deletes a file or directory.
- delete(Path, DeleteOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Deletes a file or directory.
- deleteDirectory(File) - Static method in class org.apache.commons.io.FileUtils
-
Deletes a directory recursively.
- deleteDirectory(Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Deletes a directory including subdirectories.
- deleteDirectory(Path, LinkOption[], DeleteOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Deletes a directory including subdirectories.
- deleteDirectory(Path, DeleteOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Deletes a directory including subdirectories.
- deleteFile(Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Deletes the given file.
- deleteFile(Path, LinkOption[], DeleteOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Deletes the given file.
- deleteFile(Path, DeleteOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Deletes the given file.
- deleteIfExists(Path) - Static method in class org.apache.commons.io.file.FilesUncheck
- deleteOnExit(Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Delegates to
File.deleteOnExit()
. - DeleteOption - Interface in org.apache.commons.io.file
-
An object that configures how to delete a file.
- deleteQuietly(File) - Method in class org.apache.commons.io.FileDeleteStrategy
-
Deletes the file object, which may be a file or a directory.
- deleteQuietly(File) - Static method in class org.apache.commons.io.FileUtils
-
Deletes a file, never throwing an exception.
- DeletingPathVisitor - Class in org.apache.commons.io.file
-
Deletes files and directories as a visit proceeds.
- DeletingPathVisitor(Counters.PathCounters, String...) - Constructor for class org.apache.commons.io.file.DeletingPathVisitor
-
Constructs a instance that deletes files except for the files and directories explicitly given.
- DeletingPathVisitor(Counters.PathCounters, LinkOption[], DeleteOption[], String...) - Constructor for class org.apache.commons.io.file.DeletingPathVisitor
-
Constructs a instance that deletes files except for the files and directories explicitly given.
- DeletingPathVisitor(Counters.PathCounters, DeleteOption[], String...) - Constructor for class org.apache.commons.io.file.DeletingPathVisitor
-
Constructs a instance that deletes files except for the files and directories explicitly given.
- DemuxInputStream - Class in org.apache.commons.io.input
-
Data written to this stream is forwarded to a stream that has been associated with this thread.
- DemuxInputStream() - Constructor for class org.apache.commons.io.input.DemuxInputStream
- DemuxOutputStream - Class in org.apache.commons.io.output
-
Forwards data to a stream that has been associated with this thread.
- DemuxOutputStream() - Constructor for class org.apache.commons.io.output.DemuxOutputStream
- destroy() - Method in class org.apache.commons.io.monitor.FileAlterationObserver
-
Final processing.
- DIR_SEPARATOR - Static variable in class org.apache.commons.io.IOUtils
-
The system directory separator character.
- DIR_SEPARATOR_UNIX - Static variable in class org.apache.commons.io.IOUtils
-
The UNIX directory separator character ''/''.
- DIR_SEPARATOR_WINDOWS - Static variable in class org.apache.commons.io.IOUtils
-
The Windows directory separator character ''\\''.
- DIRECTORY - Static variable in class org.apache.commons.io.filefilter.DirectoryFileFilter
-
Singleton instance of directory filter.
- DIRECTORY_COMPARATOR - Static variable in class org.apache.commons.io.comparator.DirectoryFileComparator
-
Singleton default comparator instance
- DIRECTORY_REVERSE - Static variable in class org.apache.commons.io.comparator.DirectoryFileComparator
-
Singleton reverse default comparator instance
- directoryAndFileContentEquals(Path, Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Compares the file sets of two Paths to determine if they are equal or not while considering file contents.
- directoryAndFileContentEquals(Path, Path, LinkOption[], OpenOption[], FileVisitOption[]) - Static method in class org.apache.commons.io.file.PathUtils
-
Compares the file sets of two Paths to determine if they are equal or not while considering file contents.
- directoryContains(File, File) - Static method in class org.apache.commons.io.FileUtils
-
Determines whether the
parent
directory contains thechild
element (a file or directory). - directoryContains(String, String) - Static method in class org.apache.commons.io.FilenameUtils
-
Determines whether the
parent
directory contains thechild
(a file or directory). - directoryContentEquals(Path, Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Compares the file sets of two Paths to determine if they are equal or not without considering file contents.
- directoryContentEquals(Path, Path, int, LinkOption[], FileVisitOption[]) - Static method in class org.apache.commons.io.file.PathUtils
-
Compares the file sets of two Paths to determine if they are equal or not without considering file contents.
- DirectoryFileComparator - Class in org.apache.commons.io.comparator
-
Compare two files using the
File.isDirectory()
method. - DirectoryFileComparator() - Constructor for class org.apache.commons.io.comparator.DirectoryFileComparator
- directoryFileFilter() - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that checks if the file is a directory.
- DirectoryFileFilter - Class in org.apache.commons.io.filefilter
-
This filter accepts
File
s that are directories. - DirectoryFileFilter() - Constructor for class org.apache.commons.io.filefilter.DirectoryFileFilter
-
Restrictive constructor.
- DirectoryStreamFilter - Class in org.apache.commons.io.file
-
A
DirectoryStream.Filter
that delegates to aPathFilter
. - DirectoryStreamFilter(PathFilter) - Constructor for class org.apache.commons.io.file.DirectoryStreamFilter
-
Constructs a new instance for the given path filter.
- DirectoryWalker<T> - Class in org.apache.commons.io
-
Deprecated.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...)
orFiles.walkFileTree(java.nio.file.Path, java.util.Set, int, java.nio.file.FileVisitor)
, and friends. - DirectoryWalker() - Constructor for class org.apache.commons.io.DirectoryWalker
-
Deprecated.Constructs an instance with no filtering and unlimited depth.
- DirectoryWalker(FileFilter, int) - Constructor for class org.apache.commons.io.DirectoryWalker
-
Deprecated.Constructs an instance with a filter and limit the depth navigated to.
- DirectoryWalker(IOFileFilter, IOFileFilter, int) - Constructor for class org.apache.commons.io.DirectoryWalker
-
Deprecated.Constructs an instance with a directory and a file filter and an optional limit on the depth navigated to.
- DirectoryWalker.CancelException - Exception in org.apache.commons.io
-
Deprecated.CancelException is thrown in DirectoryWalker to cancel the current processing.
- distinct() - Method in interface org.apache.commons.io.function.IOStream
-
Like
Stream.distinct()
. - doDelete(File) - Method in class org.apache.commons.io.FileDeleteStrategy
-
Actually deletes the file object, which may be a file or a directory.
- dump(byte[], long, OutputStream, int) - Static method in class org.apache.commons.io.HexDump
-
Dumps an array of bytes to an OutputStream.
- dump(byte[], long, Appendable, int, int) - Static method in class org.apache.commons.io.HexDump
-
Dumps an array of bytes to an Appendable.
- dump(byte[], Appendable) - Static method in class org.apache.commons.io.HexDump
-
Dumps an array of bytes to an Appendable.
E
- empty() - Static method in interface org.apache.commons.io.function.IOStream
-
This class' version of
Stream.empty()
. - EMPTY - Static variable in class org.apache.commons.io.filefilter.EmptyFileFilter
-
Singleton instance of empty filter
- EMPTY_BYTE_ARRAY - Static variable in class org.apache.commons.io.IOUtils
-
A singleton empty byte array.
- EMPTY_COPY_OPTIONS - Static variable in class org.apache.commons.io.file.PathUtils
-
Empty
CopyOption
array. - EMPTY_DELETE_OPTION_ARRAY - Static variable in class org.apache.commons.io.file.PathUtils
-
Empty
DeleteOption
array. - EMPTY_FILE_ARRAY - Static variable in class org.apache.commons.io.FileUtils
-
An empty array of type
File
. - EMPTY_FILE_ATTRIBUTE_ARRAY - Static variable in class org.apache.commons.io.file.PathUtils
-
Empty
FileAttribute
array. - EMPTY_FILE_VISIT_OPTION_ARRAY - Static variable in class org.apache.commons.io.file.PathUtils
-
Empty
FileVisitOption
array. - EMPTY_LINK_OPTION_ARRAY - Static variable in class org.apache.commons.io.file.PathUtils
-
Empty
LinkOption
array. - EMPTY_OPEN_OPTION_ARRAY - Static variable in class org.apache.commons.io.file.PathUtils
-
Empty
OpenOption
array. - EMPTY_PATH_ARRAY - Static variable in class org.apache.commons.io.file.PathUtils
-
Empty
Path
array. - EMPTY_STRING_ARRAY - Static variable in interface org.apache.commons.io.filefilter.IOFileFilter
-
An empty String array.
- EMPTY_WRITERS - Variable in class org.apache.commons.io.output.FilterCollectionWriter
-
Empty and immutable collection of writers.
- EmptyFileFilter - Class in org.apache.commons.io.filefilter
-
This filter accepts files or directories that are empty.
- EmptyFileFilter() - Constructor for class org.apache.commons.io.filefilter.EmptyFileFilter
-
Restrictive constructor.
- ENCODING_PATTERN - Static variable in class org.apache.commons.io.input.XmlStreamReader
-
Pattern capturing the encoding of the
'xml'
processing instruction. - END_OF_STREAM - Static variable in class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream
-
The end of stream marker.
- EndianUtils - Class in org.apache.commons.io
-
Helps with reading and writing primitive numeric types (
short
,int
,long
,float
, anddouble
) that are encoded in little endian using two's complement or unsigned representations. - EndianUtils() - Constructor for class org.apache.commons.io.EndianUtils
-
Deprecated.TODO Make private in 3.0.
- endOfFileReached() - Method in class org.apache.commons.io.input.TailerListenerAdapter
-
Called each time the Tailer reaches the end of the file.
- EOF - Static variable in class org.apache.commons.io.IOUtils
-
Represents the end-of-file (or stream) value -1.
- EOL - Static variable in class org.apache.commons.io.HexDump
-
Deprecated.
- EPOCH - Static variable in class org.apache.commons.io.file.attribute.FileTimes
-
Constant for the
1970-01-01T00:00:00Z
epoch
as a time stamp attribute. - equals(Object) - Method in class org.apache.commons.io.ByteOrderMark
-
Indicates if this instance's bytes equals another.
- equals(Object) - Method in class org.apache.commons.io.file.AccumulatorPathVisitor
- equals(Object) - Method in class org.apache.commons.io.file.CleaningPathVisitor
- equals(Object) - Method in class org.apache.commons.io.file.CopyDirectoryVisitor
- equals(Object) - Method in class org.apache.commons.io.file.CountingPathVisitor
- equals(Object) - Method in class org.apache.commons.io.file.DeletingPathVisitor
- equals(String, String) - Static method in class org.apache.commons.io.FilenameUtils
-
Checks whether two file names are exactly equal.
- equals(String, String, boolean, IOCase) - Static method in class org.apache.commons.io.FilenameUtils
-
Checks whether two file names are equal, optionally normalizing and providing control over the case-sensitivity.
- equalsNormalized(String, String) - Static method in class org.apache.commons.io.FilenameUtils
-
Checks whether two file names are equal after both have been normalized.
- equalsNormalizedOnSystem(String, String) - Static method in class org.apache.commons.io.FilenameUtils
-
Checks whether two file names are equal using the case rules of the system after both have been normalized.
- equalsOnSystem(String, String) - Static method in class org.apache.commons.io.FilenameUtils
-
Checks whether two file names are equal using the case rules of the system.
- Erase - Class in org.apache.commons.io.function
-
Erases
IOException
for the compiler but still throws that exception at runtime. - error(IOException) - Method in class org.apache.commons.io.input.ObservableInputStream.Observer
-
Called to indicate that an error occurred on the underlying stream.
- estimateSize() - Method in interface org.apache.commons.io.function.IOSpliterator
- exitWhenFinished() - Static method in class org.apache.commons.io.FileCleaner
-
Deprecated.
- exitWhenFinished() - Method in class org.apache.commons.io.FileCleaningTracker
-
Call this method to cause the file cleaner thread to terminate when there are no more objects being tracked for deletion.
- EXTENSION_COMPARATOR - Static variable in class org.apache.commons.io.comparator.ExtensionFileComparator
-
Case-sensitive extension comparator instance (see
IOCase.SENSITIVE
) - EXTENSION_INSENSITIVE_COMPARATOR - Static variable in class org.apache.commons.io.comparator.ExtensionFileComparator
-
Case-insensitive extension comparator instance (see
IOCase.INSENSITIVE
) - EXTENSION_INSENSITIVE_REVERSE - Static variable in class org.apache.commons.io.comparator.ExtensionFileComparator
-
Reverse case-insensitive extension comparator instance (see
IOCase.INSENSITIVE
) - EXTENSION_REVERSE - Static variable in class org.apache.commons.io.comparator.ExtensionFileComparator
-
Reverse case-sensitive extension comparator instance (see
IOCase.SENSITIVE
) - EXTENSION_SEPARATOR - Static variable in class org.apache.commons.io.FilenameUtils
-
The extension separator character.
- EXTENSION_SEPARATOR_STR - Static variable in class org.apache.commons.io.FilenameUtils
-
The extension separator String.
- EXTENSION_SYSTEM_COMPARATOR - Static variable in class org.apache.commons.io.comparator.ExtensionFileComparator
-
System sensitive extension comparator instance (see
IOCase.SYSTEM
) - EXTENSION_SYSTEM_REVERSE - Static variable in class org.apache.commons.io.comparator.ExtensionFileComparator
-
Reverse system sensitive path comparator instance (see
IOCase.SYSTEM
) - ExtensionFileComparator - Class in org.apache.commons.io.comparator
-
Compare the file name extensions for order (see
FilenameUtils.getExtension(String)
). - ExtensionFileComparator() - Constructor for class org.apache.commons.io.comparator.ExtensionFileComparator
-
Constructs a case-sensitive file extension comparator instance.
- ExtensionFileComparator(IOCase) - Constructor for class org.apache.commons.io.comparator.ExtensionFileComparator
-
Constructs a file extension comparator instance with the specified case-sensitivity.
F
- FALSE - Static variable in class org.apache.commons.io.filefilter.FalseFileFilter
-
Singleton instance of false filter.
- falseFileFilter() - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that always returns false.
- FalseFileFilter - Class in org.apache.commons.io.filefilter
-
A file filter that always returns false.
- FalseFileFilter() - Constructor for class org.apache.commons.io.filefilter.FalseFileFilter
-
Restrictive constructor.
- FILE - Static variable in class org.apache.commons.io.filefilter.FileFileFilter
-
Deprecated.
- FileAlterationListener - Interface in org.apache.commons.io.monitor
-
Receives events of file system modifications.
- FileAlterationListenerAdaptor - Class in org.apache.commons.io.monitor
-
Convenience
FileAlterationListener
implementation that does nothing. - FileAlterationListenerAdaptor() - Constructor for class org.apache.commons.io.monitor.FileAlterationListenerAdaptor
- FileAlterationMonitor - Class in org.apache.commons.io.monitor
-
A runnable that spawns a monitoring thread triggering any registered
FileAlterationObserver
at a specified interval. - FileAlterationMonitor() - Constructor for class org.apache.commons.io.monitor.FileAlterationMonitor
-
Constructs a monitor with a default interval of 10 seconds.
- FileAlterationMonitor(long) - Constructor for class org.apache.commons.io.monitor.FileAlterationMonitor
-
Constructs a monitor with the specified interval.
- FileAlterationMonitor(long, Collection<FileAlterationObserver>) - Constructor for class org.apache.commons.io.monitor.FileAlterationMonitor
-
Constructs a monitor with the specified interval and collection of observers.
- FileAlterationMonitor(long, FileAlterationObserver...) - Constructor for class org.apache.commons.io.monitor.FileAlterationMonitor
-
Constructs a monitor with the specified interval and set of observers.
- FileAlterationObserver - Class in org.apache.commons.io.monitor
-
FileAlterationObserver represents the state of files below a root directory, checking the file system and notifying listeners of create, change or delete events.
- FileAlterationObserver(File) - Constructor for class org.apache.commons.io.monitor.FileAlterationObserver
-
Deprecated.
- FileAlterationObserver(File, FileFilter) - Constructor for class org.apache.commons.io.monitor.FileAlterationObserver
-
Deprecated.
- FileAlterationObserver(File, FileFilter, IOCase) - Constructor for class org.apache.commons.io.monitor.FileAlterationObserver
-
Deprecated.
- FileAlterationObserver(String) - Constructor for class org.apache.commons.io.monitor.FileAlterationObserver
-
Deprecated.
- FileAlterationObserver(String, FileFilter) - Constructor for class org.apache.commons.io.monitor.FileAlterationObserver
-
Deprecated.
- FileAlterationObserver(String, FileFilter, IOCase) - Constructor for class org.apache.commons.io.monitor.FileAlterationObserver
-
Deprecated.
- FileAlterationObserver(FileEntry, FileFilter, IOCase) - Constructor for class org.apache.commons.io.monitor.FileAlterationObserver
-
Constructs an observer for the specified directory, file filter and file comparator.
- FileAlterationObserver.Builder - Class in org.apache.commons.io.monitor
-
Builds instances of
FileAlterationObserver
. - FileChannels - Class in org.apache.commons.io.channels
-
Works with
FileChannel
. - FileCleaner - Class in org.apache.commons.io
-
Deprecated.
- FileCleaner() - Constructor for class org.apache.commons.io.FileCleaner
-
Deprecated.
- FileCleaningTracker - Class in org.apache.commons.io
-
Keeps track of files awaiting deletion, and deletes them when an associated marker object is reclaimed by the garbage collector.
- FileCleaningTracker() - Constructor for class org.apache.commons.io.FileCleaningTracker
- fileContentEquals(Path, Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Compares the file contents of two Paths to determine if they are equal or not.
- fileContentEquals(Path, Path, LinkOption[], OpenOption[]) - Static method in class org.apache.commons.io.file.PathUtils
-
Compares the file contents of two Paths to determine if they are equal or not.
- FileDeleteStrategy - Class in org.apache.commons.io
-
Strategy for deleting files.
- FileDeleteStrategy(String) - Constructor for class org.apache.commons.io.FileDeleteStrategy
-
Restricted constructor.
- FileEntry - Class in org.apache.commons.io.monitor
-
The state of a file or directory, capturing the following
File
attributes at a point in time. - FileEntry(File) - Constructor for class org.apache.commons.io.monitor.FileEntry
-
Constructs a new monitor for a specified
File
. - FileEntry(FileEntry, File) - Constructor for class org.apache.commons.io.monitor.FileEntry
-
Constructs a new monitor for a specified
File
. - FileEqualsFileFilter - Class in org.apache.commons.io.filefilter
-
Accepts only an exact
File
object match. - FileEqualsFileFilter(File) - Constructor for class org.apache.commons.io.filefilter.FileEqualsFileFilter
-
Constructs a new instance for the given
File
. - FileExistsException - Exception in org.apache.commons.io
-
Indicates that a file already exists.
- FileExistsException() - Constructor for exception org.apache.commons.io.FileExistsException
-
Constructs a new instance.
- FileExistsException(File) - Constructor for exception org.apache.commons.io.FileExistsException
-
Constructs an instance with the specified file.
- FileExistsException(String) - Constructor for exception org.apache.commons.io.FileExistsException
-
Constructs an instance with the specified message.
- fileFileFilter() - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that checks if the file is a file (and not a directory).
- FileFileFilter - Class in org.apache.commons.io.filefilter
-
This filter accepts
File
s that are files (not directories). - FileFileFilter() - Constructor for class org.apache.commons.io.filefilter.FileFileFilter
-
Restrictive constructor.
- FileFilterUtils - Class in org.apache.commons.io.filefilter
-
Useful utilities for working with file filters.
- FileFilterUtils() - Constructor for class org.apache.commons.io.filefilter.FileFilterUtils
-
FileFilterUtils is not normally instantiated.
- FilenameUtils - Class in org.apache.commons.io
-
General file name and file path manipulation utilities.
- FilenameUtils() - Constructor for class org.apache.commons.io.FilenameUtils
-
Deprecated.TODO Make private in 3.0.
- fileNotFound() - Method in interface org.apache.commons.io.input.TailerListener
-
This method is called if the tailed file is not found.
- fileNotFound() - Method in class org.apache.commons.io.input.TailerListenerAdapter
-
This method is called if the tailed file is not found.
- FileOrigin(File) - Constructor for class org.apache.commons.io.build.AbstractOrigin.FileOrigin
-
Constructs a new instance for the given origin.
- fileRotated() - Method in interface org.apache.commons.io.input.TailerListener
-
Called if a file rotation is detected.
- fileRotated() - Method in class org.apache.commons.io.input.TailerListenerAdapter
-
Called if a file rotation is detected.
- FilesUncheck - Class in org.apache.commons.io.file
- FileSystem - Enum in org.apache.commons.io
-
Abstracts an OS' file system details, currently supporting the single use case of converting a file name String to a legal file name with
FileSystem.toLegalFileName(String, char)
. - FileSystemProviders - Class in org.apache.commons.io.file.spi
-
Helps to work with
FileSystemProvider
. - FileSystemUtils - Class in org.apache.commons.io
-
Deprecated.As of 2.6 deprecated without replacement. Use equivalent methods in
FileStore
instead,Files.getFileStore(Paths.get("/home")).getUsableSpace()
or iterate overFileSystems.getDefault().getFileStores()
- FileSystemUtils() - Constructor for class org.apache.commons.io.FileSystemUtils
-
Deprecated.TODO Make private in 3.0.
- FileTimes - Class in org.apache.commons.io.file.attribute
-
Helps use
FileTime
and interoperate Date and NTFS times. - FileUtils - Class in org.apache.commons.io
-
General file manipulation utilities.
- FileUtils() - Constructor for class org.apache.commons.io.FileUtils
-
Deprecated.TODO Make private in 3.0.
- FileWriterWithEncoding - Class in org.apache.commons.io.output
-
Writer of files that allows the encoding to be set.
- FileWriterWithEncoding(File, String) - Constructor for class org.apache.commons.io.output.FileWriterWithEncoding
- FileWriterWithEncoding(File, String, boolean) - Constructor for class org.apache.commons.io.output.FileWriterWithEncoding
- FileWriterWithEncoding(File, Charset) - Constructor for class org.apache.commons.io.output.FileWriterWithEncoding
- FileWriterWithEncoding(File, CharsetEncoder) - Constructor for class org.apache.commons.io.output.FileWriterWithEncoding
- FileWriterWithEncoding(File, CharsetEncoder, boolean) - Constructor for class org.apache.commons.io.output.FileWriterWithEncoding
- FileWriterWithEncoding(File, Charset, boolean) - Constructor for class org.apache.commons.io.output.FileWriterWithEncoding
- FileWriterWithEncoding(String, String) - Constructor for class org.apache.commons.io.output.FileWriterWithEncoding
- FileWriterWithEncoding(String, String, boolean) - Constructor for class org.apache.commons.io.output.FileWriterWithEncoding
- FileWriterWithEncoding(String, Charset) - Constructor for class org.apache.commons.io.output.FileWriterWithEncoding
- FileWriterWithEncoding(String, CharsetEncoder) - Constructor for class org.apache.commons.io.output.FileWriterWithEncoding
- FileWriterWithEncoding(String, CharsetEncoder, boolean) - Constructor for class org.apache.commons.io.output.FileWriterWithEncoding
- FileWriterWithEncoding(String, Charset, boolean) - Constructor for class org.apache.commons.io.output.FileWriterWithEncoding
- FileWriterWithEncoding.Builder - Class in org.apache.commons.io.output
-
Builds a new
FileWriterWithEncoding
. - fillBuffer() - Method in class org.apache.commons.io.input.buffer.CircularBufferInputStream
-
Fills the buffer with the contents of the input stream.
- filter(int) - Method in class org.apache.commons.io.input.AbstractCharacterFilterReader
-
Returns true if the given character should be filtered out, false to keep the character.
- filter(PathFilter, Path...) - Static method in class org.apache.commons.io.file.PathUtils
-
Applies an
IOFileFilter
to the providedFile
objects. - filter(IOFileFilter, File...) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Applies an
IOFileFilter
to the providedFile
objects. - filter(IOFileFilter, Iterable<File>) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Applies an
IOFileFilter
to the providedFile
objects. - filter(IOPredicate<? super T>) - Method in interface org.apache.commons.io.function.IOStream
- FilterCollectionWriter - Class in org.apache.commons.io.output
-
Abstract class for writing filtered character streams to a
Collection
of writers. - FilterCollectionWriter(Writer...) - Constructor for class org.apache.commons.io.output.FilterCollectionWriter
-
Constructs a new filtered collection writer.
- FilterCollectionWriter(Collection<Writer>) - Constructor for class org.apache.commons.io.output.FilterCollectionWriter
-
Constructs a new filtered collection writer.
- filterDirectoryContents(File, int, File...) - Method in class org.apache.commons.io.DirectoryWalker
-
Deprecated.Overridable callback method invoked with the contents of each directory.
- filterList(IOFileFilter, File...) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Applies an
IOFileFilter
to the providedFile
objects. - filterList(IOFileFilter, Iterable<File>) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Applies an
IOFileFilter
to the providedFile
objects. - filterSet(IOFileFilter, File...) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Applies an
IOFileFilter
to the providedFile
objects. - filterSet(IOFileFilter, Iterable<File>) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Applies an
IOFileFilter
to the providedFile
objects. - finalize() - Method in class org.apache.commons.io.input.AutoCloseInputStream
-
Ensures that the stream is closed before it gets garbage-collected.
- find(Path, int, BiPredicate<Path, BasicFileAttributes>, FileVisitOption...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.find(Path, int, BiPredicate, FileVisitOption...)
throwingUncheckedIOException
instead ofIOException
. - findAny() - Method in interface org.apache.commons.io.function.IOStream
-
Like
Stream.findAny()
. - findFirst() - Method in interface org.apache.commons.io.function.IOStream
-
Like
Stream.findFirst()
. - finished() - Method in class org.apache.commons.io.input.ObservableInputStream.Observer
-
Called to indicate that EOF has been seen on the underlying stream.
- flatMap(IOFunction<? super T, ? extends IOStream<? extends R>>) - Method in interface org.apache.commons.io.function.IOStream
- flatMapToDouble(IOFunction<? super T, ? extends DoubleStream>) - Method in interface org.apache.commons.io.function.IOStream
-
TODO Package-private for now, needs IODoubleStream?
- flatMapToInt(IOFunction<? super T, ? extends IntStream>) - Method in interface org.apache.commons.io.function.IOStream
-
TODO Package-private for now, needs IOIntStream?
- flatMapToLong(IOFunction<? super T, ? extends LongStream>) - Method in interface org.apache.commons.io.function.IOStream
-
TODO Package-private for now, needs IOLongStream?
- flush() - Method in class org.apache.commons.io.output.AppendableWriter
-
Flushes the stream.
- flush() - Method in class org.apache.commons.io.output.BrokenOutputStream
-
Throws the configured exception.
- flush() - Method in class org.apache.commons.io.output.BrokenWriter
-
Throws the configured exception.
- flush() - Method in class org.apache.commons.io.output.ClosedOutputStream
-
Throws an
IOException
to indicate that the stream is closed. - flush() - Method in class org.apache.commons.io.output.ClosedWriter
-
Throws an
IOException
to indicate that the stream is closed. - flush() - Method in class org.apache.commons.io.output.DemuxOutputStream
-
Flushes stream associated with current thread.
- flush() - Method in class org.apache.commons.io.output.FilterCollectionWriter
-
Flushes the stream.
- flush() - Method in class org.apache.commons.io.output.LockableFileWriter
-
Flushes the stream.
- flush() - Method in class org.apache.commons.io.output.NullWriter
- flush() - Method in class org.apache.commons.io.output.ProxyCollectionWriter
-
Invokes the delegate's
flush()
method. - flush() - Method in class org.apache.commons.io.output.ProxyOutputStream
-
Invokes the delegate's
flush()
method. - flush() - Method in class org.apache.commons.io.output.ProxyWriter
-
Invokes the delegate's
flush()
method. - flush() - Method in class org.apache.commons.io.output.RandomAccessFileOutputStream
- flush() - Method in class org.apache.commons.io.output.StringBuilderWriter
-
Flushing this writer has no effect.
- flush() - Method in class org.apache.commons.io.output.TeeOutputStream
-
Flushes both streams.
- flush() - Method in class org.apache.commons.io.output.ThresholdingOutputStream
-
Flushes this output stream and forces any buffered output bytes to be written out.
- flush() - Method in class org.apache.commons.io.output.UncheckedFilterOutputStream
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - flush() - Method in class org.apache.commons.io.output.UncheckedFilterWriter
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - flush() - Method in class org.apache.commons.io.output.WriterOutputStream
-
Flush the stream.
- flush() - Method in class org.apache.commons.io.output.XmlStreamWriter
-
Flushes the underlying writer.
- forAll(IOConsumer<T>) - Method in interface org.apache.commons.io.function.IOStream
-
Performs an action for each element gathering any exceptions.
- forAll(IOConsumer<T>, Iterable<T>) - Static method in interface org.apache.commons.io.function.IOConsumer
-
Performs an action for each element of the collection gathering any exceptions.
- forAll(IOConsumer<T>, BiFunction<Integer, IOException, IOException>) - Method in interface org.apache.commons.io.function.IOStream
-
Performs an action for each element gathering any exceptions.
- forAll(IOConsumer<T>, Stream<T>) - Static method in interface org.apache.commons.io.function.IOConsumer
-
Performs an action for each element of the collection gathering any exceptions.
- forAll(IOConsumer<T>, T...) - Static method in interface org.apache.commons.io.function.IOConsumer
-
Performs an action for each element of the array, gathering any exceptions.
- FORCE - Static variable in class org.apache.commons.io.FileDeleteStrategy
-
The singleton instance for forced file deletion, which always deletes, even if the file represents a non-empty directory.
- forceDelete(File) - Static method in class org.apache.commons.io.FileUtils
-
Deletes a file or directory.
- forceDeleteOnExit(File) - Static method in class org.apache.commons.io.FileUtils
-
Schedules a file to be deleted when JVM exits.
- forceMkdir(File) - Static method in class org.apache.commons.io.FileUtils
-
Creates all directories for a File object, including any necessary but non-existent parent directories.
- forceMkdirParent(File) - Static method in class org.apache.commons.io.FileUtils
-
Creates all directories for a File object, including any necessary but non-existent parent directories.
- forEach(Iterable<T>, IOConsumer<T>) - Static method in interface org.apache.commons.io.function.IOConsumer
-
Performs an action for each element of the collection, stopping at the first exception.
- forEach(Stream<T>, IOConsumer<T>) - Static method in interface org.apache.commons.io.function.IOConsumer
-
Performs an action for each element of the stream, stopping at the first exception.
- forEach(IOConsumer<? super T>) - Method in interface org.apache.commons.io.function.IOStream
-
Like
Stream.forEach(java.util.function.Consumer)
but throwsIOException
. - forEach(T[], IOConsumer<T>) - Static method in interface org.apache.commons.io.function.IOConsumer
-
Performs an action for each element of this array, stopping at the first exception.
- forEachOrdered(IOConsumer<? super T>) - Method in interface org.apache.commons.io.function.IOStream
- forEachRemaining(IOConsumer<? super E>) - Method in interface org.apache.commons.io.function.IOIterator
- forEachRemaining(IOConsumer<? super T>) - Method in interface org.apache.commons.io.function.IOSpliterator
- forName(String) - Static method in enum org.apache.commons.io.IOCase
-
Looks up an IOCase by name.
- freeSpace(String) - Static method in class org.apache.commons.io.FileSystemUtils
-
Deprecated.Use freeSpaceKb(String) Deprecated from 1.3, may be removed in 2.0
- freeSpaceKb() - Static method in class org.apache.commons.io.FileSystemUtils
-
Deprecated.As of 2.6 deprecated without replacement. Please use
FileStore.getUsableSpace()
. - freeSpaceKb(long) - Static method in class org.apache.commons.io.FileSystemUtils
-
Deprecated.As of 2.6 deprecated without replacement. Please use
FileStore.getUsableSpace()
. - freeSpaceKb(String) - Static method in class org.apache.commons.io.FileSystemUtils
-
Deprecated.As of 2.6 deprecated without replacement. Please use
FileStore.getUsableSpace()
. - freeSpaceKb(String, long) - Static method in class org.apache.commons.io.FileSystemUtils
-
Deprecated.As of 2.6 deprecated without replacement. Please use
FileStore.getUsableSpace()
. - fromUnixTime(long) - Static method in class org.apache.commons.io.file.attribute.FileTimes
-
Converts standard UNIX time (in seconds, UTC/GMT) to
FileTime
.
G
- GENERIC - Enum constant in enum org.apache.commons.io.FileSystem
-
Generic file system.
- get() - Method in class org.apache.commons.io.build.AbstractOrigin
-
Gets the origin.
- get() - Method in interface org.apache.commons.io.file.Counters.Counter
-
Gets the counter as a long.
- get() - Method in class org.apache.commons.io.filefilter.WildcardFileFilter.Builder
- get() - Method in interface org.apache.commons.io.function.IOSupplier
-
Gets a result.
- get() - Method in class org.apache.commons.io.input.AutoCloseInputStream.Builder
-
Builds a new
AutoCloseInputStream
. - get() - Method in class org.apache.commons.io.input.BOMInputStream.Builder
-
Builds a new
BOMInputStream
. - get() - Method in class org.apache.commons.io.input.BoundedInputStream.Builder
-
Builds a new
BoundedInputStream
. - get() - Method in class org.apache.commons.io.input.BufferedFileChannelInputStream.Builder
-
Builds a new
BufferedFileChannelInputStream
. - get() - Method in class org.apache.commons.io.input.CharSequenceInputStream.Builder
-
Builds a new
CharSequenceInputStream
. - get() - Method in class org.apache.commons.io.input.ChecksumInputStream.Builder
-
Builds a new
ChecksumInputStream
. - get() - Method in class org.apache.commons.io.input.MemoryMappedFileInputStream.Builder
-
Builds a new
MemoryMappedFileInputStream
. - get() - Method in class org.apache.commons.io.input.MessageDigestCalculatingInputStream.Builder
-
Deprecated.Builds a new
MessageDigestCalculatingInputStream
. - get() - Method in class org.apache.commons.io.input.MessageDigestInputStream.Builder
-
Builds new
MessageDigestInputStream
. - get() - Method in class org.apache.commons.io.input.ObservableInputStream.Builder
- get() - Method in class org.apache.commons.io.input.QueueInputStream.Builder
-
Builds a new
QueueInputStream
. - get() - Method in class org.apache.commons.io.input.RandomAccessFileInputStream.Builder
-
Builds a new
RandomAccessFileInputStream
. - get() - Method in class org.apache.commons.io.input.ReadAheadInputStream.Builder
-
Builds a new
ReadAheadInputStream
. - get() - Method in class org.apache.commons.io.input.ReaderInputStream.Builder
-
Builds a new
ReaderInputStream
. - get() - Method in class org.apache.commons.io.input.ReversedLinesFileReader.Builder
-
Builds a new
ReversedLinesFileReader
. - get() - Method in class org.apache.commons.io.input.Tailer.Builder
-
Builds a new
Tailer
. - get() - Method in class org.apache.commons.io.input.ThrottledInputStream.Builder
-
Builds a new
ThrottledInputStream
. - get() - Method in class org.apache.commons.io.input.UncheckedBufferedReader.Builder
-
Builds a new
UncheckedBufferedReader
. - get() - Method in class org.apache.commons.io.input.UncheckedFilterInputStream.Builder
-
Builds a new
UncheckedFilterInputStream
. - get() - Method in class org.apache.commons.io.input.UncheckedFilterReader.Builder
-
Builds a new
UncheckedFilterReader
. - get() - Method in class org.apache.commons.io.input.UnsynchronizedBufferedInputStream.Builder
-
Builds a new
UnsynchronizedBufferedInputStream
. - get() - Method in class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream.Builder
-
Builds a new
UnsynchronizedByteArrayInputStream
. - get() - Method in class org.apache.commons.io.input.UnsynchronizedFilterInputStream.Builder
-
Builds a new
UnsynchronizedFilterInputStream
. - get() - Method in class org.apache.commons.io.input.XmlStreamReader.Builder
-
Builds a new
XmlStreamWriter
. - get() - Method in class org.apache.commons.io.monitor.FileAlterationObserver.Builder
-
Gets a new
FileAlterationObserver
instance. - get() - Method in class org.apache.commons.io.output.ChunkedOutputStream.Builder
-
Builds a new
UnsynchronizedByteArrayOutputStream
. - get() - Method in class org.apache.commons.io.output.DeferredFileOutputStream.Builder
-
Builds a new
DeferredFileOutputStream
. - get() - Method in class org.apache.commons.io.output.FileWriterWithEncoding.Builder
-
Builds a new
FileWriterWithEncoding
. - get() - Method in class org.apache.commons.io.output.LockableFileWriter.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.output.RandomAccessFileOutputStream.Builder
- get() - Method in class org.apache.commons.io.output.UncheckedFilterOutputStream.Builder
-
Builds a new
UncheckedFilterOutputStream
. - get() - Method in class org.apache.commons.io.output.UncheckedFilterWriter.Builder
-
Builds a new
UncheckedFilterWriter
. - get() - Method in class org.apache.commons.io.output.UnsynchronizedByteArrayOutputStream.Builder
-
Builds a new
UnsynchronizedByteArrayOutputStream
. - get() - Method in class org.apache.commons.io.output.WriterOutputStream.Builder
-
Builds a new
WriterOutputStream
. - get() - Method in class org.apache.commons.io.output.XmlStreamWriter.Builder
-
Builds a new
XmlStreamWriter
. - get() - Method in class org.apache.commons.io.serialization.ValidatingObjectInputStream.Builder
- get(int) - Method in class org.apache.commons.io.ByteOrderMark
-
Gets the byte at the specified position.
- get(IOSupplier<T>) - Static method in class org.apache.commons.io.function.Uncheck
-
Gets the result from an IO supplier.
- get(IOSupplier<T>, Supplier<String>) - Static method in class org.apache.commons.io.function.Uncheck
-
Gets the result from an IO supplier.
- getAclEntryList(Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Reads the access control list from a file attribute view.
- getAclFileAttributeView(Path, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Shorthand for
Files.getFileAttributeView(path, AclFileAttributeView.class)
. - getAfterRead() - Method in class org.apache.commons.io.input.ProxyInputStream.AbstractBuilder
-
Gets the
ProxyInputStream.afterRead(int)
consumer. - getAppendable() - Method in class org.apache.commons.io.output.AppendableOutputStream
-
Gets the target appendable.
- getAppendable() - Method in class org.apache.commons.io.output.AppendableWriter
-
Gets the target appendable.
- getAsInt() - Method in interface org.apache.commons.io.function.IOIntSupplier
-
Gets a result.
- getAsInt(IOIntSupplier) - Static method in class org.apache.commons.io.function.Uncheck
-
Gets the result from an IO int supplier.
- getAsInt(IOIntSupplier, Supplier<String>) - Static method in class org.apache.commons.io.function.Uncheck
-
Gets the result from an IO int supplier.
- getAsLong() - Method in interface org.apache.commons.io.function.IOLongSupplier
-
Gets a result.
- getAsLong(IOLongSupplier) - Static method in class org.apache.commons.io.function.Uncheck
-
Gets the result from an IO long supplier.
- getAsLong(IOLongSupplier, Supplier<String>) - Static method in class org.apache.commons.io.function.Uncheck
-
Gets the result from an IO long supplier.
- getAttribute(Path, String, LinkOption...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.getAttribute(Path, String, LinkOption...)
throwingUncheckedIOException
instead ofIOException
. - getBaseName(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Gets the base name, minus the full path and extension, from a full file name.
- getBaseName(Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Gets the base name (the part up to and not including the last ".") of the last path segment of a file name.
- getBigInteger() - Method in interface org.apache.commons.io.file.Counters.Counter
-
Gets the counter as a BigInteger.
- getBlockSize() - Method in enum org.apache.commons.io.FileSystem
-
Gets the file allocation block size in bytes.
- getBOM() - Method in class org.apache.commons.io.input.BOMInputStream
-
Gets the BOM (Byte Order Mark).
- getBOMCharsetName() - Method in class org.apache.commons.io.input.BOMInputStream
-
Gets the BOM charset Name -
ByteOrderMark.getCharsetName()
. - getBomEncoding() - Method in exception org.apache.commons.io.input.XmlStreamReaderException
-
Gets the BOM encoding found in the InputStream.
- getBufferSize() - Method in class org.apache.commons.io.build.AbstractStreamBuilder
-
Gets the buffer size, defaults to
IOUtils.DEFAULT_BUFFER_SIZE
(8192). - getBufferSizeDefault() - Method in class org.apache.commons.io.build.AbstractStreamBuilder
-
Gets the buffer size default, defaults to
IOUtils.DEFAULT_BUFFER_SIZE
(8192). - getBuilder() - Method in class org.apache.commons.io.output.StringBuilderWriter
-
Gets the underlying builder.
- getByteArray() - Method in class org.apache.commons.io.build.AbstractOrigin.AbstractRandomAccessFileOrigin
- getByteArray() - Method in class org.apache.commons.io.build.AbstractOrigin.ByteArrayOrigin
- getByteArray() - Method in class org.apache.commons.io.build.AbstractOrigin.CharSequenceOrigin
- getByteArray() - Method in class org.apache.commons.io.build.AbstractOrigin
-
Gets this origin as a byte array, if possible.
- getByteArray() - Method in class org.apache.commons.io.build.AbstractOrigin.InputStreamOrigin
- getByteArray() - Method in class org.apache.commons.io.build.AbstractOrigin.ReaderOrigin
- getByteArray(long, int) - Method in class org.apache.commons.io.build.AbstractOrigin.AbstractRandomAccessFileOrigin
- getByteArray(long, int) - Method in class org.apache.commons.io.build.AbstractOrigin.FileOrigin
- getByteArray(long, int) - Method in class org.apache.commons.io.build.AbstractOrigin
-
Gets a portion of this origin as a byte array, if possible.
- getByteArray(long, int) - Method in class org.apache.commons.io.build.AbstractOrigin.PathOrigin
- getByteCount() - Method in class org.apache.commons.io.input.CountingInputStream
-
Deprecated.Gets number of bytes that have passed through this stream.
- getByteCount() - Method in class org.apache.commons.io.output.CountingOutputStream
-
The number of bytes that have passed through this stream.
- getByteCount() - Method in class org.apache.commons.io.output.ThresholdingOutputStream
-
Gets the number of bytes that have been written to this output stream.
- getByteCounter() - Method in interface org.apache.commons.io.file.Counters.PathCounters
-
Gets the byte counter.
- getBytes() - Method in class org.apache.commons.io.ByteOrderMark
-
Gets a copy of the BOM's bytes.
- getBytes(Charset) - Method in enum org.apache.commons.io.StandardLineSeparator
-
Gets the bytes for this instance encoded using the given Charset.
- getCause() - Method in exception org.apache.commons.io.TaggedIOException
-
Returns the wrapped exception.
- getCause(int) - Method in exception org.apache.commons.io.IOExceptionList
-
Gets the cause exception at the given index.
- getCause(int, Class<T>) - Method in exception org.apache.commons.io.IOExceptionList
-
Gets the cause exception at the given index.
- getCauseList() - Method in exception org.apache.commons.io.IOExceptionList
-
Gets the cause list.
- getCauseList(Class<T>) - Method in exception org.apache.commons.io.IOExceptionList
-
Works around Throwable and Generics, may fail at runtime depending on the argument value.
- getCharSequence() - Method in class org.apache.commons.io.build.AbstractStreamBuilder
-
Gets a CharSequence from the origin with a Charset.
- getCharSequence(Charset) - Method in class org.apache.commons.io.build.AbstractOrigin.AbstractRandomAccessFileOrigin
- getCharSequence(Charset) - Method in class org.apache.commons.io.build.AbstractOrigin.CharSequenceOrigin
-
Gets this origin as a byte array, if possible.
- getCharSequence(Charset) - Method in class org.apache.commons.io.build.AbstractOrigin
-
Gets this origin as a byte array, if possible.
- getCharSequence(Charset) - Method in class org.apache.commons.io.build.AbstractOrigin.ReaderOrigin
-
Gets this origin as a byte array, if possible.
- getCharset() - Method in class org.apache.commons.io.build.AbstractStreamBuilder
-
Gets the Charset, defaults to
Charset.defaultCharset()
. - getCharsetDefault() - Method in class org.apache.commons.io.build.AbstractStreamBuilder
-
Gets the Charset default, defaults to
Charset.defaultCharset()
. - getCharsetName() - Method in class org.apache.commons.io.ByteOrderMark
-
Gets the name of the
Charset
the BOM represents. - getChildren() - Method in class org.apache.commons.io.monitor.FileEntry
-
Gets the directory's files.
- getCloseInstant() - Method in class org.apache.commons.io.input.TimestampedObserver
-
Gets the instant for when this instance was closed.
- getComparator() - Method in interface org.apache.commons.io.function.IOSpliterator
- getContentTypeEncoding() - Method in exception org.apache.commons.io.input.XmlStreamReaderException
-
Gets the encoding in the content-type used to attempt determining the encoding.
- getContentTypeMime() - Method in exception org.apache.commons.io.input.XmlStreamReaderException
-
Gets the MIME type in the content-type used to attempt determining the encoding.
- getCopyOptions() - Method in class org.apache.commons.io.file.CopyDirectoryVisitor
-
Gets the copy options.
- getCount() - Method in class org.apache.commons.io.input.BoundedInputStream
-
Gets the count of bytes read.
- getCount() - Method in class org.apache.commons.io.input.CountingInputStream
-
Deprecated.
- getCount() - Method in class org.apache.commons.io.output.CountingOutputStream
-
Gets the number of bytes that have passed through this stream.
- getCurrent() - Static method in enum org.apache.commons.io.FileSystem
-
Gets the current file system.
- getCurrentNumberOfBytes() - Method in class org.apache.commons.io.input.buffer.CircularByteBuffer
-
Gets the number of bytes, that are currently present in the buffer.
- getData() - Method in class org.apache.commons.io.output.DeferredFileOutputStream
-
Gets the data for this output stream as an array of bytes, assuming that the data has been retained in memory.
- getDefaultEncoding() - Method in class org.apache.commons.io.input.XmlStreamReader
-
Gets the default encoding to use if none is set in HTTP content-type, XML prolog and the rules based on content-type are not adequate.
- getDefaultEncoding() - Method in class org.apache.commons.io.output.XmlStreamWriter
-
Returns the default encoding.
- getDelay() - Method in class org.apache.commons.io.input.Tailer
-
Deprecated.
- getDelayDuration() - Method in class org.apache.commons.io.input.Tailer
-
Gets the delay Duration.
- getDeleteFailures() - Method in class org.apache.commons.io.FileCleaningTracker
-
Gets a copy of the file paths that failed to delete.
- getDepth() - Method in exception org.apache.commons.io.DirectoryWalker.CancelException
-
Deprecated.Returns the depth when the operation was cancelled.
- getDirectory() - Method in class org.apache.commons.io.monitor.FileAlterationObserver
-
Returns the directory being observed.
- getDirectoryCounter() - Method in interface org.apache.commons.io.file.Counters.PathCounters
-
Gets the directory counter.
- getDirList() - Method in class org.apache.commons.io.file.AccumulatorPathVisitor
-
Gets a copy of the list of visited directories.
- getDosFileAttributeView(Path, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Shorthand for
Files.getFileAttributeView(path, DosFileAttributeView.class, options)
. - getEncoding() - Method in class org.apache.commons.io.input.XmlStreamReader
-
Gets the charset encoding of the XmlStreamReader.
- getEncoding() - Method in class org.apache.commons.io.output.XmlStreamWriter
-
Returns the detected encoding.
- getExactSizeIfKnown() - Method in interface org.apache.commons.io.function.IOSpliterator
- getExtension(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Gets the extension of a fileName.
- getExtension(Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Gets the extension of a Path.
- getFile() - Method in class org.apache.commons.io.build.AbstractOrigin.FileOrigin
- getFile() - Method in class org.apache.commons.io.build.AbstractOrigin
-
Gets this origin as a Path, if possible.
- getFile() - Method in class org.apache.commons.io.build.AbstractOrigin.IORandomAccessFileOrigin
- getFile() - Method in class org.apache.commons.io.build.AbstractOrigin.PathOrigin
- getFile() - Method in class org.apache.commons.io.build.AbstractOrigin.URIOrigin
- getFile() - Method in class org.apache.commons.io.build.AbstractStreamBuilder
-
Gets a File from the origin.
- getFile() - Method in exception org.apache.commons.io.DirectoryWalker.CancelException
-
Deprecated.Returns the file when the operation was cancelled.
- getFile() - Method in class org.apache.commons.io.input.Tailer
-
Gets the file.
- getFile() - Method in class org.apache.commons.io.IORandomAccessFile
-
Gets the file passed to
IORandomAccessFile(File, String)
. - getFile() - Method in class org.apache.commons.io.monitor.FileEntry
-
Gets the file being monitored.
- getFile() - Method in class org.apache.commons.io.output.DeferredFileOutputStream
-
Gets either the output File specified in the constructor or the temporary File created or null.
- getFile(File, String...) - Static method in class org.apache.commons.io.FileUtils
-
Constructs a file from the set of name elements.
- getFile(String...) - Static method in class org.apache.commons.io.FileUtils
-
Constructs a file from the set of name elements.
- getFileCounter() - Method in interface org.apache.commons.io.file.Counters.PathCounters
-
Gets the file counter.
- getFileFilter() - Method in class org.apache.commons.io.monitor.FileAlterationObserver
-
Returns the fileFilter.
- getFileFilters() - Method in class org.apache.commons.io.filefilter.AndFileFilter
-
Gets this conditional file filter's list of file filters.
- getFileFilters() - Method in interface org.apache.commons.io.filefilter.ConditionalFileFilter
-
Gets this conditional file filter's list of file filters.
- getFileFilters() - Method in class org.apache.commons.io.filefilter.OrFileFilter
-
Gets this conditional file filter's list of file filters.
- getFileList() - Method in class org.apache.commons.io.file.AccumulatorPathVisitor
-
Gets a copy of the list of visited files.
- getFileName(Path, Function<Path, R>) - Static method in class org.apache.commons.io.file.PathUtils
-
Gets the Path's file name and apply the given function if the file name is non-null.
- getFileNameString(Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Gets the Path's file name as a string.
- getFileStore(Path) - Static method in class org.apache.commons.io.file.FilesUncheck
- getFileSystemProvider(String) - Method in class org.apache.commons.io.file.spi.FileSystemProviders
-
Gets the
FileSystemProvider
for the given scheme. - getFileSystemProvider(URI) - Method in class org.apache.commons.io.file.spi.FileSystemProviders
-
Gets the
FileSystemProvider
for the given URI. - getFileSystemProvider(URL) - Method in class org.apache.commons.io.file.spi.FileSystemProviders
-
Gets the
FileSystemProvider
for the given URL. - getFileSystemProvider(Path) - Static method in class org.apache.commons.io.file.spi.FileSystemProviders
-
Gets the
FileSystemProvider
for the given Path. - getFullPath(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Gets the full path (prefix + path) from a full file name.
- getFullPathNoEndSeparator(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Gets the full path (prefix + path) from a full file name, excluding the final directory separator.
- getIllegalFileNameChars() - Method in enum org.apache.commons.io.FileSystem
-
Gets a cloned copy of the illegal characters for this file system.
- getIllegalFileNameCodePoints() - Method in enum org.apache.commons.io.FileSystem
-
Gets a cloned copy of the illegal code points for this file system.
- getIndex() - Method in exception org.apache.commons.io.IOIndexedException
-
The index of this exception.
- getInputStream() - Method in class org.apache.commons.io.build.AbstractStreamBuilder
-
Gets an InputStream from the origin with OpenOption[].
- getInputStream(OpenOption...) - Method in class org.apache.commons.io.build.AbstractOrigin.AbstractRandomAccessFileOrigin
- getInputStream(OpenOption...) - Method in class org.apache.commons.io.build.AbstractOrigin.ByteArrayOrigin
-
Gets this origin as an InputStream, if possible.
- getInputStream(OpenOption...) - Method in class org.apache.commons.io.build.AbstractOrigin.CharSequenceOrigin
-
Gets this origin as an InputStream, if possible.
- getInputStream(OpenOption...) - Method in class org.apache.commons.io.build.AbstractOrigin
-
Gets this origin as an InputStream, if possible.
- getInputStream(OpenOption...) - Method in class org.apache.commons.io.build.AbstractOrigin.InputStreamOrigin
-
Gets this origin as an InputStream, if possible.
- getInputStream(OpenOption...) - Method in class org.apache.commons.io.build.AbstractOrigin.ReaderOrigin
-
Gets this origin as an InputStream, if possible.
- getInputStream(OpenOption...) - Method in class org.apache.commons.io.build.AbstractOrigin.URIOrigin
- getInstance() - Static method in class org.apache.commons.io.FileCleaner
-
Deprecated.Gets the singleton instance, which is used by the deprecated, static methods.
- getInterval() - Method in class org.apache.commons.io.monitor.FileAlterationMonitor
-
Returns the interval.
- getLastModified() - Method in class org.apache.commons.io.monitor.FileEntry
-
Gets the last modified time from the last time it was checked.
- getLastModifiedFileTime() - Method in class org.apache.commons.io.monitor.FileEntry
-
Gets the last modified time from the last time it was checked.
- getLastModifiedFileTime(File) - Static method in class org.apache.commons.io.file.PathUtils
-
Gets the file's last modified time or null if the file does not exist.
- getLastModifiedFileTime(URI) - Static method in class org.apache.commons.io.file.PathUtils
-
Gets the file's last modified time or null if the file does not exist.
- getLastModifiedFileTime(URL) - Static method in class org.apache.commons.io.file.PathUtils
-
Gets the file's last modified time or null if the file does not exist.
- getLastModifiedFileTime(Path, FileTime, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Gets the file's last modified time or null if the file does not exist.
- getLastModifiedFileTime(Path, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Gets the file's last modified time or null if the file does not exist.
- getLastModifiedTime(Path, LinkOption...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.getLastModifiedTime(Path, LinkOption...)
throwingUncheckedIOException
instead ofIOException
. - getLength() - Method in class org.apache.commons.io.monitor.FileEntry
-
Gets the length.
- getLevel() - Method in class org.apache.commons.io.monitor.FileEntry
-
Gets the level
- getListeners() - Method in class org.apache.commons.io.monitor.FileAlterationObserver
-
Returns the set of registered file system listeners.
- getLong() - Method in interface org.apache.commons.io.file.Counters.Counter
-
Gets the counter as a Long.
- getMaxCount() - Method in class org.apache.commons.io.input.BoundedInputStream
-
Gets the max count of bytes to read.
- getMaxFileNameLength() - Method in enum org.apache.commons.io.FileSystem
-
Gets the maximum length for file names.
- getMaxLength() - Method in class org.apache.commons.io.input.BoundedInputStream
-
Deprecated.
- getMaxPathLength() - Method in enum org.apache.commons.io.FileSystem
-
Gets the maximum length of the path to a file.
- getMessageDigest() - Method in class org.apache.commons.io.input.MessageDigestCalculatingInputStream
-
Deprecated.Gets the
MessageDigest
, which is being used for generating the checksum. - getMessageDigest() - Method in class org.apache.commons.io.input.MessageDigestInputStream
-
Gets the
MessageDigest
, which is being used for generating the checksum, never null. - getMode() - Method in class org.apache.commons.io.IORandomAccessFile
-
Gets the mode passed to
IORandomAccessFile(File, String)
. - getMode() - Method in enum org.apache.commons.io.RandomAccessFileMode
-
Gets the access mode, one of "r", "rw", "rwd", or "rws".
- getName() - Method in enum org.apache.commons.io.IOCase
-
Gets the name of the constant.
- getName() - Method in class org.apache.commons.io.monitor.FileEntry
-
Gets the file name.
- getName(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Gets the name minus the path from a full file name.
- getNameSeparator() - Method in enum org.apache.commons.io.FileSystem
-
Gets the name separator, '\\' on Windows, '/' on Linux.
- getObservers() - Method in class org.apache.commons.io.input.ObservableInputStream
-
Gets a copy of currently registered observers.
- getObservers() - Method in class org.apache.commons.io.monitor.FileAlterationMonitor
-
Returns the set of
FileAlterationObserver
registered with this monitor. - getOpenInstant() - Method in class org.apache.commons.io.input.TimestampedObserver
-
Gets the instant for when this instance was created.
- getOpenOptions() - Method in class org.apache.commons.io.build.AbstractStreamBuilder
-
Gets the OpenOption array.
- getOpenToCloseDuration() - Method in class org.apache.commons.io.input.TimestampedObserver
-
Gets the Duration between creation and close.
- getOpenToNowDuration() - Method in class org.apache.commons.io.input.TimestampedObserver
-
Gets the Duration between creation and now.
- getOrigin() - Method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Gets the origin.
- getOutputStream() - Method in class org.apache.commons.io.build.AbstractStreamBuilder
-
Gets an OutputStream from the origin with OpenOption[].
- getOutputStream() - Method in class org.apache.commons.io.output.ThresholdingOutputStream
-
Gets the underlying output stream, to which the corresponding
OutputStream
methods in this class will ultimately delegate. - getOutputStream(OpenOption...) - Method in class org.apache.commons.io.build.AbstractOrigin.AbstractRandomAccessFileOrigin
- getOutputStream(OpenOption...) - Method in class org.apache.commons.io.build.AbstractOrigin
-
Gets this origin as an OutputStream, if possible.
- getOutputStream(OpenOption...) - Method in class org.apache.commons.io.build.AbstractOrigin.OutputStreamOrigin
-
Gets this origin as an OutputStream, if possible.
- getOutputStream(OpenOption...) - Method in class org.apache.commons.io.build.AbstractOrigin.WriterOrigin
-
Gets this origin as an OutputStream, if possible.
- getOwner(Path, LinkOption...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.getOwner(Path, LinkOption...)
throwingUncheckedIOException
instead ofIOException
. - getParent() - Method in class org.apache.commons.io.monitor.FileEntry
-
Gets the parent entry.
- getPath() - Method in class org.apache.commons.io.build.AbstractOrigin.FileOrigin
- getPath() - Method in class org.apache.commons.io.build.AbstractOrigin
-
Gets this origin as a Path, if possible.
- getPath() - Method in class org.apache.commons.io.build.AbstractOrigin.IORandomAccessFileOrigin
- getPath() - Method in class org.apache.commons.io.build.AbstractOrigin.PathOrigin
- getPath() - Method in class org.apache.commons.io.build.AbstractOrigin.URIOrigin
- getPath() - Method in class org.apache.commons.io.build.AbstractStreamBuilder
-
Gets a Path from the origin.
- getPath() - Method in class org.apache.commons.io.output.DeferredFileOutputStream
-
Gets either the output Path specified in the constructor or the temporary Path created or null.
- getPath(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Gets the path from a full file name, which excludes the prefix and the name.
- getPathCounters() - Method in class org.apache.commons.io.file.CountingPathVisitor
-
Gets the visitation counts.
- getPathFilter() - Method in class org.apache.commons.io.file.DirectoryStreamFilter
-
Gets the path filter.
- getPathNoEndSeparator(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Gets the path (which excludes the prefix) from a full file name, and also excluding the final directory separator.
- getPointer() - Method in interface org.apache.commons.io.input.Tailer.RandomAccessResourceBridge
-
Gets the current offset in this tailable.
- getPosition() - Method in class org.apache.commons.io.input.NullInputStream
-
Gets the current position.
- getPosition() - Method in class org.apache.commons.io.input.NullReader
-
Returns the current position.
- getPosixFileAttributeView(Path, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Shorthand for
Files.getFileAttributeView(path, PosixFileAttributeView.class)
. - getPosixFilePermissions(Path, LinkOption...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.getPosixFilePermissions(Path, LinkOption...)
throwingUncheckedIOException
instead ofIOException
. - getPredicate() - Method in class org.apache.commons.io.serialization.ValidatingObjectInputStream.Builder
-
Gets the predicate.
- getPrefix(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Gets the prefix such as
C:/
or~/
from a full file name, - getPrefixLength(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Returns the length of the file name prefix, such as
C:/
or~/
. - getRandomAccess(String) - Method in interface org.apache.commons.io.input.Tailer.Tailable
-
Creates a random access file stream to read.
- getRandomAccessFile() - Method in class org.apache.commons.io.build.AbstractStreamBuilder
-
Gets a RandomAccessFile from the origin.
- getRandomAccessFile() - Method in class org.apache.commons.io.input.RandomAccessFileInputStream
-
Gets the underlying file.
- getRandomAccessFile(OpenOption...) - Method in class org.apache.commons.io.build.AbstractOrigin.AbstractRandomAccessFileOrigin
- getRandomAccessFile(OpenOption...) - Method in class org.apache.commons.io.build.AbstractOrigin
-
Gets this origin as a RandomAccessFile, if possible.
- getReader() - Method in class org.apache.commons.io.build.AbstractStreamBuilder
-
Gets a Reader from the origin with a Charset.
- getReader(Charset) - Method in class org.apache.commons.io.build.AbstractOrigin.AbstractRandomAccessFileOrigin
- getReader(Charset) - Method in class org.apache.commons.io.build.AbstractOrigin.ByteArrayOrigin
- getReader(Charset) - Method in class org.apache.commons.io.build.AbstractOrigin.CharSequenceOrigin
-
Gets a new Reader on the origin, buffered by default.
- getReader(Charset) - Method in class org.apache.commons.io.build.AbstractOrigin
-
Gets a new Reader on the origin, buffered by default.
- getReader(Charset) - Method in class org.apache.commons.io.build.AbstractOrigin.InputStreamOrigin
- getReader(Charset) - Method in class org.apache.commons.io.build.AbstractOrigin.ReaderOrigin
-
Gets a new Reader on the origin, buffered by default.
- getRemaining() - Method in class org.apache.commons.io.input.BoundedInputStream
-
Gets how many bytes remain to read.
- getRemaining() - Method in class org.apache.commons.io.input.ChecksumInputStream
-
Gets the byte count remaining to read.
- getReservedFileNames() - Method in enum org.apache.commons.io.FileSystem
-
Gets a cloned copy of the reserved file names.
- getRun() - Method in class org.apache.commons.io.input.Tailer
-
Gets whether to keep on running.
- getSize() - Method in class org.apache.commons.io.input.NullInputStream
-
Gets the size this
InputStream
emulates. - getSize() - Method in class org.apache.commons.io.input.NullReader
-
Returns the size this
Reader
emulates. - getSourceDirectory() - Method in class org.apache.commons.io.file.CopyDirectoryVisitor
-
Gets the source directory.
- getSpace() - Method in class org.apache.commons.io.input.buffer.CircularByteBuffer
-
Gets the number of bytes, that can currently be added to the buffer.
- getStream() - Method in class org.apache.commons.io.output.DeferredFileOutputStream
-
Gets the current output stream.
- getStream() - Method in class org.apache.commons.io.output.ThresholdingOutputStream
-
Deprecated.
- getString() - Method in enum org.apache.commons.io.StandardLineSeparator
-
Gets the String value of this instance.
- getTag() - Method in exception org.apache.commons.io.TaggedIOException
-
Returns the serializable tag object.
- getTailable() - Method in class org.apache.commons.io.input.Tailer
-
Gets the Tailable.
- getTargetDirectory() - Method in class org.apache.commons.io.file.CopyDirectoryVisitor
-
Gets the target directory.
- getTempDirectory() - Static method in class org.apache.commons.io.file.PathUtils
-
Gets a
Path
representing the system temporary directory. - getTempDirectory() - Static method in class org.apache.commons.io.FileUtils
-
Returns a
File
representing the system temporary directory. - getTempDirectoryPath() - Static method in class org.apache.commons.io.FileUtils
-
Returns the path to the system temporary directory.
- getThreshold() - Method in class org.apache.commons.io.output.ThresholdingOutputStream
-
Gets the threshold, in bytes, at which an event will be triggered.
- getTrackCount() - Static method in class org.apache.commons.io.FileCleaner
-
Deprecated.
- getTrackCount() - Method in class org.apache.commons.io.FileCleaningTracker
-
Gets the number of files currently being tracked, and therefore awaiting deletion.
- getUnchecked() - Method in interface org.apache.commons.io.function.IOSupplier
-
Gets a result.
- getUserDirectory() - Static method in class org.apache.commons.io.FileUtils
-
Returns a
File
representing the user's home directory. - getUserDirectoryPath() - Static method in class org.apache.commons.io.FileUtils
-
Returns the path to the user's home directory.
- getWriter() - Method in class org.apache.commons.io.build.AbstractStreamBuilder
-
Gets a Writer from the origin with an OpenOption[].
- getWriter(Charset, OpenOption...) - Method in class org.apache.commons.io.build.AbstractOrigin.AbstractRandomAccessFileOrigin
- getWriter(Charset, OpenOption...) - Method in class org.apache.commons.io.build.AbstractOrigin
-
Gets a new Writer on the origin, buffered by default.
- getWriter(Charset, OpenOption...) - Method in class org.apache.commons.io.build.AbstractOrigin.OutputStreamOrigin
-
Gets a new Writer on the origin, buffered by default.
- getWriter(Charset, OpenOption...) - Method in class org.apache.commons.io.build.AbstractOrigin.WriterOrigin
-
Gets a new Writer on the origin, buffered by default.
- getXmlEncoding() - Method in exception org.apache.commons.io.input.XmlStreamReaderException
-
Gets the encoding found in the XML prolog of the input.
- getXmlGuessEncoding() - Method in exception org.apache.commons.io.input.XmlStreamReaderException
-
Gets the encoding guess based on the first bytes of the input.
H
- handle(Exception) - Method in interface org.apache.commons.io.input.TailerListener
-
Handles an Exception.
- handle(Exception) - Method in class org.apache.commons.io.input.TailerListenerAdapter
-
Handles an Exception .
- handle(String) - Method in interface org.apache.commons.io.input.TailerListener
-
Handles a line from a Tailer.
- handle(String) - Method in class org.apache.commons.io.input.TailerListenerAdapter
-
Handles a line from a Tailer.
- handle(Throwable) - Method in class org.apache.commons.io.filefilter.AbstractFileFilter
-
Handles exceptions caught while accepting.
- handleCancelled(File, Collection<T>, DirectoryWalker.CancelException) - Method in class org.apache.commons.io.DirectoryWalker
-
Deprecated.Overridable callback method invoked when the operation is cancelled.
- handleDirectory(File, int, Collection<T>) - Method in class org.apache.commons.io.DirectoryWalker
-
Deprecated.Overridable callback method invoked to determine if a directory should be processed.
- handleDirectoryEnd(File, int, Collection<T>) - Method in class org.apache.commons.io.DirectoryWalker
-
Deprecated.Overridable callback method invoked at the end of processing each directory.
- handleDirectoryStart(File, int, Collection<T>) - Method in class org.apache.commons.io.DirectoryWalker
-
Deprecated.Overridable callback method invoked at the start of processing each directory.
- handleEnd(Collection<T>) - Method in class org.apache.commons.io.DirectoryWalker
-
Deprecated.Overridable callback method invoked at the end of processing.
- handleFile(File, int, Collection<T>) - Method in class org.apache.commons.io.DirectoryWalker
-
Deprecated.Overridable callback method invoked for each (non-directory) file.
- handleIOException(IOException) - Method in class org.apache.commons.io.input.ProxyInputStream
-
Handles any IOExceptions thrown; by default, throws the given exception.
- handleIOException(IOException) - Method in class org.apache.commons.io.input.ProxyReader
-
Handle any IOExceptions thrown.
- handleIOException(IOException) - Method in class org.apache.commons.io.input.TaggedInputStream
-
Tags any IOExceptions thrown, wrapping and re-throwing.
- handleIOException(IOException) - Method in class org.apache.commons.io.input.TaggedReader
-
Tags any IOExceptions thrown, wrapping and re-throwing.
- handleIOException(IOException) - Method in class org.apache.commons.io.output.ProxyCollectionWriter
-
Handle any IOExceptions thrown.
- handleIOException(IOException) - Method in class org.apache.commons.io.output.ProxyOutputStream
-
Handle any IOExceptions thrown.
- handleIOException(IOException) - Method in class org.apache.commons.io.output.ProxyWriter
-
Handles any IOExceptions thrown.
- handleIOException(IOException) - Method in class org.apache.commons.io.output.TaggedOutputStream
-
Tags any IOExceptions thrown, wrapping and re-throwing.
- handleIOException(IOException) - Method in class org.apache.commons.io.output.TaggedWriter
-
Tags any IOExceptions thrown, wrapping and re-throwing.
- handleIsCancelled(File, int, Collection<T>) - Method in class org.apache.commons.io.DirectoryWalker
-
Deprecated.Overridable callback method invoked to determine if the entire walk operation should be immediately cancelled.
- handleRestricted(File, int, Collection<T>) - Method in class org.apache.commons.io.DirectoryWalker
-
Deprecated.Overridable callback method invoked for each restricted directory.
- handleStart(File, Collection<T>) - Method in class org.apache.commons.io.DirectoryWalker
-
Deprecated.Overridable callback method invoked at the start of processing.
- hasBOM() - Method in class org.apache.commons.io.input.BOMInputStream
-
Tests whether the stream contains one of the specified BOMs.
- hasBOM(ByteOrderMark) - Method in class org.apache.commons.io.input.BOMInputStream
-
Tests whether the stream contains the specified BOM.
- hasBytes() - Method in class org.apache.commons.io.input.buffer.CircularByteBuffer
-
Tests whether the buffer is currently holding at least a single byte.
- hasCharacteristics(int) - Method in interface org.apache.commons.io.function.IOSpliterator
- hashCode() - Method in class org.apache.commons.io.ByteOrderMark
-
Computes the hash code for this BOM.
- hashCode() - Method in class org.apache.commons.io.file.AccumulatorPathVisitor
- hashCode() - Method in class org.apache.commons.io.file.CleaningPathVisitor
- hashCode() - Method in class org.apache.commons.io.file.CopyDirectoryVisitor
- hashCode() - Method in class org.apache.commons.io.file.CountingPathVisitor
- hashCode() - Method in class org.apache.commons.io.file.DeletingPathVisitor
- hasNext() - Method in interface org.apache.commons.io.function.IOIterator
-
Like
Iterator.hasNext()
. - hasNext() - Method in class org.apache.commons.io.LineIterator
-
Indicates whether the
Reader
has more lines. - hasNext() - Method in class org.apache.commons.io.StreamIterator
- hasOrigin() - Method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Tests whether the origin is null.
- hasSpace() - Method in class org.apache.commons.io.input.buffer.CircularByteBuffer
-
Tests whether there is currently room for a single byte in the buffer.
- hasSpace(int) - Method in class org.apache.commons.io.input.buffer.CircularByteBuffer
-
Tests whether there is currently room for the given number of bytes in the buffer.
- haveBytes(int) - Method in class org.apache.commons.io.input.buffer.CircularBufferInputStream
-
Fills the buffer from the input stream until the given number of bytes have been added to the buffer.
- HexDump - Class in org.apache.commons.io
-
Dumps data in hexadecimal format.
- HexDump() - Constructor for class org.apache.commons.io.HexDump
-
Instances should NOT be constructed in standard programming.
- HIDDEN - Static variable in class org.apache.commons.io.filefilter.HiddenFileFilter
-
Singleton instance of hidden filter
- HiddenFileFilter - Class in org.apache.commons.io.filefilter
-
This filter accepts
File
s that are hidden. - HiddenFileFilter() - Constructor for class org.apache.commons.io.filefilter.HiddenFileFilter
-
Restrictive constructor.
I
- identity() - Static method in interface org.apache.commons.io.function.IOFunction
-
Returns a
IOFunction
that always returns its input argument. - identity() - Static method in interface org.apache.commons.io.function.IOUnaryOperator
-
Creates a unary operator that always returns its input argument.
- implies(RandomAccessFileMode) - Method in enum org.apache.commons.io.RandomAccessFileMode
-
Tests whether this mode implies the given
other
mode. - increment() - Method in interface org.apache.commons.io.file.Counters.Counter
-
Adds one to this counter.
- indexOfExtension(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Returns the index of the last extension separator character, which is a dot.
- indexOfLastSeparator(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Returns the index of the last directory separator character.
- InfiniteCircularInputStream - Class in org.apache.commons.io.input
-
An
InputStream
that infinitely repeats the provided bytes. - InfiniteCircularInputStream(byte[]) - Constructor for class org.apache.commons.io.input.InfiniteCircularInputStream
-
Constructs an instance from the specified array of bytes.
- init() - Method in class org.apache.commons.io.input.NullInputStream
-
Initializes or re-initializes this instance for reuse.
- init(Tailer) - Method in interface org.apache.commons.io.input.TailerListener
-
The tailer will call this method during construction, giving the listener a method of stopping the tailer.
- init(Tailer) - Method in class org.apache.commons.io.input.TailerListenerAdapter
-
The tailer will call this method during construction, giving the listener a method of stopping the tailer.
- initialize() - Method in class org.apache.commons.io.monitor.FileAlterationObserver
-
Initializes the observer.
- inputStream - Variable in class org.apache.commons.io.input.UnsynchronizedFilterInputStream
-
The source input stream that is filtered.
- InputStreamOrigin(InputStream) - Constructor for class org.apache.commons.io.build.AbstractOrigin.InputStreamOrigin
-
Constructs a new instance for the given origin.
- INSENSITIVE - Enum constant in enum org.apache.commons.io.IOCase
-
The constant for case-insensitive regardless of operating system.
- installed() - Static method in class org.apache.commons.io.file.spi.FileSystemProviders
-
Returns the instance for the installed providers.
- INSTANCE - Static variable in class org.apache.commons.io.file.NoopPathVisitor
-
The singleton instance.
- INSTANCE - Static variable in class org.apache.commons.io.filefilter.DirectoryFileFilter
-
Singleton instance of directory filter.
- INSTANCE - Static variable in class org.apache.commons.io.filefilter.FalseFileFilter
-
Singleton instance of false filter.
- INSTANCE - Static variable in class org.apache.commons.io.filefilter.FileFileFilter
-
Singleton instance of file filter.
- INSTANCE - Static variable in class org.apache.commons.io.filefilter.SymbolicLinkFileFilter
-
Singleton instance of file filter.
- INSTANCE - Static variable in class org.apache.commons.io.filefilter.TrueFileFilter
-
Singleton instance of true filter.
- INSTANCE - Static variable in class org.apache.commons.io.input.BrokenInputStream
-
The singleton instance using a default IOException.
- INSTANCE - Static variable in class org.apache.commons.io.input.BrokenReader
-
A singleton instance using a default IOException.
- INSTANCE - Static variable in class org.apache.commons.io.input.ClosedInputStream
-
The singleton instance.
- INSTANCE - Static variable in class org.apache.commons.io.input.ClosedReader
-
The singleton instance.
- INSTANCE - Static variable in class org.apache.commons.io.input.NullInputStream
-
Deprecated.Not reusable without calling
NullInputStream.init()
to reset state. - INSTANCE - Static variable in class org.apache.commons.io.input.NullReader
-
The singleton instance.
- INSTANCE - Static variable in class org.apache.commons.io.output.BrokenOutputStream
-
The singleton instance using a default IOException.
- INSTANCE - Static variable in class org.apache.commons.io.output.BrokenWriter
-
The singleton instance using a default IOException.
- INSTANCE - Static variable in class org.apache.commons.io.output.ClosedOutputStream
-
The singleton instance.
- INSTANCE - Static variable in class org.apache.commons.io.output.ClosedWriter
-
The singleton instance.
- INSTANCE - Static variable in class org.apache.commons.io.output.NullAppendable
-
A singleton.
- INSTANCE - Static variable in class org.apache.commons.io.output.NullOutputStream
-
The singleton instance.
- INSTANCE - Static variable in class org.apache.commons.io.output.NullPrintStream
-
The singleton instance.
- INSTANCE - Static variable in class org.apache.commons.io.output.NullWriter
-
The singleton instance.
- invalidClassNameFound(String) - Method in class org.apache.commons.io.serialization.ValidatingObjectInputStream
-
Called to throw
InvalidClassException
if an invalid class name is found during deserialization. - io(String) - Method in enum org.apache.commons.io.RandomAccessFileMode
-
Constructs a random access file to read from, and optionally to write to, the file specified by the
File
argument. - IOBaseStream<T,
S extends IOBaseStream<T, S, B>, B extends BaseStream<T, B>> - Interface in org.apache.commons.io.function -
Like
BaseStream
but throwsIOException
. - IOBiConsumer<T,
U> - Interface in org.apache.commons.io.function -
Like
BiConsumer
but throwsIOException
. - IOBiFunction<T,
U, R> - Interface in org.apache.commons.io.function -
Like
BiFunction
but throwsIOException
. - IOBinaryOperator<T> - Interface in org.apache.commons.io.function
-
Like
BinaryOperator
but throwsIOException
. - IOCase - Enum in org.apache.commons.io
-
Enumeration of IO case sensitivity.
- IOComparator<T> - Interface in org.apache.commons.io.function
-
Like
Comparator
but throwsIOException
. - IOConsumer<T> - Interface in org.apache.commons.io.function
-
Like
Consumer
but throwsIOException
. - IOExceptionList - Exception in org.apache.commons.io
-
An IOException based on a list of Throwable causes.
- IOExceptionList(String, List<? extends Throwable>) - Constructor for exception org.apache.commons.io.IOExceptionList
-
Constructs a new exception caused by a list of exceptions.
- IOExceptionList(List<? extends Throwable>) - Constructor for exception org.apache.commons.io.IOExceptionList
-
Constructs a new exception caused by a list of exceptions.
- IOExceptionWithCause - Exception in org.apache.commons.io
-
Deprecated.(since 2.5) use
IOException
instead - IOExceptionWithCause(String, Throwable) - Constructor for exception org.apache.commons.io.IOExceptionWithCause
-
Deprecated.Constructs a new instance with the given message and cause.
- IOExceptionWithCause(Throwable) - Constructor for exception org.apache.commons.io.IOExceptionWithCause
-
Deprecated.Constructs a new instance with the given cause.
- IOFileFilter - Interface in org.apache.commons.io.filefilter
-
An interface which brings the
FileFilter
,FilenameFilter
,PathFilter
, andPathMatcher
interfaces together. - IOFunction<T,
R> - Interface in org.apache.commons.io.function -
Like
Function
but throwsIOException
. - IOIndexedException - Exception in org.apache.commons.io
-
A IOException associated with a source index.
- IOIndexedException(int, Throwable) - Constructor for exception org.apache.commons.io.IOIndexedException
-
Constructs a new exception.
- IOIntConsumer - Interface in org.apache.commons.io.function
-
Like
IntConsumer
but throwsIOException
. - IOIntSupplier - Interface in org.apache.commons.io.function
-
Like
IntSupplier
but throwsIOException
. - IOIterator<E> - Interface in org.apache.commons.io.function
-
Like
Iterator
but throwsIOException
. - IOLongSupplier - Interface in org.apache.commons.io.function
-
Like
LongSupplier
but throwsIOException
. - IOPredicate<T> - Interface in org.apache.commons.io.function
-
Like
Predicate
but throwsIOException
. - IOQuadFunction<T,
U, V, W, R> - Interface in org.apache.commons.io.function -
Represents a function that accepts four arguments and produces a result.
- IORandomAccessFile - Class in org.apache.commons.io
- IORandomAccessFile(File, String) - Constructor for class org.apache.commons.io.IORandomAccessFile
-
Constructs a new instance by calling
RandomAccessFile(File, String)
. - IORandomAccessFile(String, String) - Constructor for class org.apache.commons.io.IORandomAccessFile
-
Constructs a new instance by calling
RandomAccessFile(String, String)
. - IORandomAccessFileOrigin(IORandomAccessFile) - Constructor for class org.apache.commons.io.build.AbstractOrigin.IORandomAccessFileOrigin
-
A
RandomAccessFile
origin. - IORunnable - Interface in org.apache.commons.io.function
-
Like
Runnable
but throwsIOException
. - IOSpliterator<T> - Interface in org.apache.commons.io.function
-
Like
Spliterator
but throwsIOException
. - IOStream<T> - Interface in org.apache.commons.io.function
-
Like
Stream
but throwsIOException
. - IOSupplier<T> - Interface in org.apache.commons.io.function
-
Like
Supplier
but throwsIOException
. - IOTriConsumer<T,
U, V> - Interface in org.apache.commons.io.function -
Like
BiConsumer
but throwsIOException
. - IOTriFunction<T,
U, V, R> - Interface in org.apache.commons.io.function -
Represents a function that accepts three arguments and produces a result.
- IOUnaryOperator<T> - Interface in org.apache.commons.io.function
-
Like
UnaryOperator
but throwsIOException
. - IOUtils - Class in org.apache.commons.io
-
General IO stream manipulation utilities.
- IOUtils() - Constructor for class org.apache.commons.io.IOUtils
-
Deprecated.TODO Make private in 3.0.
- isCasePreserving() - Method in enum org.apache.commons.io.FileSystem
-
Tests whether this file system preserves case.
- isCaseSensitive() - Method in enum org.apache.commons.io.FileSystem
-
Tests whether this file system is case-sensitive.
- isCaseSensitive() - Method in enum org.apache.commons.io.IOCase
-
Does the object represent case-sensitive comparison.
- isCaseSensitive(IOCase) - Static method in enum org.apache.commons.io.IOCase
-
Tests for cases sensitivity in a null-safe manner.
- isCauseOf(Exception) - Method in class org.apache.commons.io.output.TaggedOutputStream
-
Tests if the given exception was caused by this stream.
- isCauseOf(Exception) - Method in class org.apache.commons.io.output.TaggedWriter
-
Tests if the given exception was caused by this writer.
- isCauseOf(Throwable) - Method in class org.apache.commons.io.input.TaggedInputStream
-
Tests if the given exception was caused by this stream.
- isCauseOf(Throwable) - Method in class org.apache.commons.io.input.TaggedReader
-
Tests if the given exception was caused by this reader.
- isClosed() - Method in class org.apache.commons.io.input.AbstractInputStream
-
Tests whether this instance is closed; if
AbstractInputStream.close()
completed successfully. - isClosed() - Method in class org.apache.commons.io.input.TimestampedObserver
-
Tests whether
TimestampedObserver.closed()
has been called. - isClosed() - Method in class org.apache.commons.io.input.UnsynchronizedReader
-
Tests whether this instance is closed; if
UnsynchronizedReader.close()
completed successfully. - isCloseOnClose() - Method in class org.apache.commons.io.input.RandomAccessFileInputStream
-
Tests whether to close the underlying file when this stream is closed.
- isDirectory() - Method in class org.apache.commons.io.monitor.FileEntry
-
Tests whether the file is a directory or not.
- isDirectory(File, LinkOption...) - Static method in class org.apache.commons.io.FileUtils
-
Tests whether the specified
File
is a directory or not. - isDirectory(Path, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Tests whether the given
Path
is a directory or not. - isEmpty(Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Tests whether the given file or directory is empty.
- isEmptyDirectory(File) - Static method in class org.apache.commons.io.FileUtils
-
Tests whether the directory is empty.
- isEmptyDirectory(Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Tests whether the directory is empty.
- isEmptyFile(Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Tests whether the given file is empty.
- isEqual(Object) - Static method in interface org.apache.commons.io.function.IOPredicate
-
Creates a predicate that tests if two arguments are equal using
Objects.equals(Object, Object)
. - isExists() - Method in class org.apache.commons.io.monitor.FileEntry
-
Tests whether the file existed the last time it was checked.
- isExtension(String, String) - Static method in class org.apache.commons.io.FilenameUtils
-
Checks whether the extension of the file name is that specified.
- isExtension(String, String...) - Static method in class org.apache.commons.io.FilenameUtils
-
Checks whether the extension of the file name is one of those specified.
- isExtension(String, Collection<String>) - Static method in class org.apache.commons.io.FilenameUtils
-
Checks whether the extension of the file name is one of those specified.
- isFileNewer(File, long) - Static method in class org.apache.commons.io.FileUtils
-
Tests if the specified
File
is newer than the specified time reference. - isFileNewer(File, File) - Static method in class org.apache.commons.io.FileUtils
- isFileNewer(File, FileTime) - Static method in class org.apache.commons.io.FileUtils
- isFileNewer(File, ChronoLocalDate) - Static method in class org.apache.commons.io.FileUtils
-
Tests if the specified
File
is newer than the specifiedChronoLocalDate
at the end of day. - isFileNewer(File, ChronoLocalDate, LocalTime) - Static method in class org.apache.commons.io.FileUtils
-
Tests if the specified
File
is newer than the specifiedChronoLocalDate
at the specified time. - isFileNewer(File, ChronoLocalDate, OffsetTime) - Static method in class org.apache.commons.io.FileUtils
-
Tests if the specified
File
is newer than the specifiedChronoLocalDate
at the specifiedOffsetTime
. - isFileNewer(File, ChronoLocalDateTime<?>) - Static method in class org.apache.commons.io.FileUtils
-
Tests if the specified
File
is newer than the specifiedChronoLocalDateTime
at the system-default time zone. - isFileNewer(File, ChronoLocalDateTime<?>, ZoneId) - Static method in class org.apache.commons.io.FileUtils
-
Tests if the specified
File
is newer than the specifiedChronoLocalDateTime
at the specifiedZoneId
. - isFileNewer(File, ChronoZonedDateTime<?>) - Static method in class org.apache.commons.io.FileUtils
-
Tests if the specified
File
is newer than the specifiedChronoZonedDateTime
. - isFileNewer(File, Instant) - Static method in class org.apache.commons.io.FileUtils
- isFileNewer(File, OffsetDateTime) - Static method in class org.apache.commons.io.FileUtils
-
Tests if the specified
File
is newer than the specifiedOffsetDateTime
. - isFileNewer(File, Date) - Static method in class org.apache.commons.io.FileUtils
- isFileOlder(File, long) - Static method in class org.apache.commons.io.FileUtils
-
Tests if the specified
File
is older than the specified time reference. - isFileOlder(File, File) - Static method in class org.apache.commons.io.FileUtils
- isFileOlder(File, FileTime) - Static method in class org.apache.commons.io.FileUtils
- isFileOlder(File, ChronoLocalDate) - Static method in class org.apache.commons.io.FileUtils
-
Tests if the specified
File
is older than the specifiedChronoLocalDate
at the end of day. - isFileOlder(File, ChronoLocalDate, LocalTime) - Static method in class org.apache.commons.io.FileUtils
- isFileOlder(File, ChronoLocalDate, OffsetTime) - Static method in class org.apache.commons.io.FileUtils
-
Tests if the specified
File
is older than the specifiedChronoLocalDate
at the specifiedOffsetTime
. - isFileOlder(File, ChronoLocalDateTime<?>) - Static method in class org.apache.commons.io.FileUtils
-
Tests if the specified
File
is older than the specifiedChronoLocalDateTime
at the system-default time zone. - isFileOlder(File, ChronoLocalDateTime<?>, ZoneId) - Static method in class org.apache.commons.io.FileUtils
-
Tests if the specified
File
is older than the specifiedChronoLocalDateTime
at the specifiedZoneId
. - isFileOlder(File, ChronoZonedDateTime<?>) - Static method in class org.apache.commons.io.FileUtils
-
Tests if the specified
File
is older than the specifiedChronoZonedDateTime
. - isFileOlder(File, Instant) - Static method in class org.apache.commons.io.FileUtils
- isFileOlder(File, OffsetDateTime) - Static method in class org.apache.commons.io.FileUtils
-
Tests if the specified
File
is older than the specifiedOffsetDateTime
. - isFileOlder(File, Date) - Static method in class org.apache.commons.io.FileUtils
- isHidden(Path) - Static method in class org.apache.commons.io.file.FilesUncheck
- isInMemory() - Method in class org.apache.commons.io.output.DeferredFileOutputStream
-
Tests whether or not the data for this output stream has been retained in memory.
- isLegalFileName(CharSequence) - Method in enum org.apache.commons.io.FileSystem
-
Tests if a candidate file name (without a path) such as
"filename.ext"
or"filename"
is a potentially legal file name. - isNewer(FileTime) - Method in interface org.apache.commons.io.input.Tailer.Tailable
-
Tests if this tailable is newer than the specified
FileTime
. - isNewer(Path, long, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Tests if the given
Path
is newer than the given time reference. - isNewer(Path, FileTime, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Tests if the given
Path
is newer than the given time reference. - isNewer(Path, Path) - Static method in class org.apache.commons.io.file.PathUtils
- isNewer(Path, ChronoZonedDateTime<?>, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Tests if the given
Path
is newer than the given time reference. - isNewer(Path, Instant, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Tests if the given
Path
is newer than the given time reference. - ISO_8859_1 - Static variable in class org.apache.commons.io.Charsets
-
Deprecated.Use Java 7's
StandardCharsets
- isOlder(Path, long, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Tests if the given
Path
is older than the given time reference. - isOlder(Path, FileTime, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Tests if the given
Path
is older than the given time reference. - isOlder(Path, Path) - Static method in class org.apache.commons.io.file.PathUtils
- isOlder(Path, Instant, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Tests if the given
Path
is older than the given time reference. - isParallel() - Method in interface org.apache.commons.io.function.IOBaseStream
-
Like
BaseStream.isParallel()
. - isPosix(Path, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Tests whether the given path is on a POSIX file system.
- isPropagateClose() - Method in class org.apache.commons.io.input.BoundedInputStream
-
Tests whether the
BoundedInputStream.close()
method should propagate to the underlingInputStream
. - isRegularFile(File, LinkOption...) - Static method in class org.apache.commons.io.FileUtils
-
Tests whether the specified
File
is a regular file or not. - isRegularFile(Path, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Tests whether the given
Path
is a regular file or not. - isReservedFileName(CharSequence) - Method in enum org.apache.commons.io.FileSystem
-
Tests whether the given string is a reserved file name.
- isSameFile(Path, Path) - Static method in class org.apache.commons.io.file.FilesUncheck
- isSymlink(File) - Static method in class org.apache.commons.io.FileUtils
-
Tests whether the specified file is a symbolic link rather than an actual file.
- isTaggedWith(Throwable, Object) - Static method in exception org.apache.commons.io.TaggedIOException
-
Checks whether the given throwable is tagged with the given tag.
- isThresholdExceeded() - Method in class org.apache.commons.io.output.ThresholdingOutputStream
-
Tests whether or not the configured threshold has been exceeded for this output stream.
- isUnixTime(long) - Static method in class org.apache.commons.io.file.attribute.FileTimes
-
Tests whether a given number of seconds (since Epoch) can be safely represented in the standard UNIX time.
- isUnixTime(FileTime) - Static method in class org.apache.commons.io.file.attribute.FileTimes
-
Tests whether a FileTime can be safely represented in the standard UNIX time.
- isValidLine(String) - Method in class org.apache.commons.io.LineIterator
-
Overridable method to validate each line that is returned.
- iterate(T, IOUnaryOperator<T>) - Static method in interface org.apache.commons.io.function.IOStream
-
Like
Stream.iterate(Object, UnaryOperator)
but for IO. - iterateFiles(File, String[], boolean) - Static method in class org.apache.commons.io.FileUtils
-
Iterates over the files in a given directory (and optionally its subdirectories) which match an array of extensions.
- iterateFiles(File, IOFileFilter, IOFileFilter) - Static method in class org.apache.commons.io.FileUtils
-
Iterates over the files in given directory (and optionally its subdirectories).
- iterateFilesAndDirs(File, IOFileFilter, IOFileFilter) - Static method in class org.apache.commons.io.FileUtils
-
Iterates over the files in given directory (and optionally its subdirectories).
- iterator() - Method in interface org.apache.commons.io.function.IOBaseStream
-
Like
BaseStream.iterator()
. - iterator() - Method in exception org.apache.commons.io.IOExceptionList
- iterator(Stream<T>) - Static method in class org.apache.commons.io.StreamIterator
-
Wraps and presents a stream as a closable resource that automatically closes itself when reaching the end of stream.
L
- lastModified(File) - Static method in class org.apache.commons.io.FileUtils
-
Returns the last modification time in milliseconds via
Files.getLastModifiedTime(Path, LinkOption...)
. - LASTMODIFIED_COMPARATOR - Static variable in class org.apache.commons.io.comparator.LastModifiedFileComparator
-
Last modified comparator instance.
- LASTMODIFIED_REVERSE - Static variable in class org.apache.commons.io.comparator.LastModifiedFileComparator
-
Reverse last modified comparator instance.
- LastModifiedFileComparator - Class in org.apache.commons.io.comparator
-
Compare the last modified date/time of two files for order (see
FileUtils.lastModifiedUnchecked(File)
). - LastModifiedFileComparator() - Constructor for class org.apache.commons.io.comparator.LastModifiedFileComparator
- lastModifiedFileTime() - Method in interface org.apache.commons.io.input.Tailer.Tailable
-
Gets the last modification
FileTime
. - lastModifiedFileTime(File) - Static method in class org.apache.commons.io.FileUtils
-
Returns the last modification
FileTime
viaFiles.getLastModifiedTime(Path, LinkOption...)
. - lastModifiedUnchecked(File) - Static method in class org.apache.commons.io.FileUtils
-
Returns the last modification time in milliseconds via
Files.getLastModifiedTime(Path, LinkOption...)
. - length() - Method in class org.apache.commons.io.ByteOrderMark
-
Gets the length of the BOM's bytes.
- length(byte[]) - Static method in class org.apache.commons.io.IOUtils
-
Returns the length of the given array in a null-safe manner.
- length(char[]) - Static method in class org.apache.commons.io.IOUtils
-
Returns the length of the given array in a null-safe manner.
- length(CharSequence) - Static method in class org.apache.commons.io.IOUtils
-
Returns the length of the given CharSequence in a null-safe manner.
- length(Object[]) - Static method in class org.apache.commons.io.IOUtils
-
Returns the length of the given array in a null-safe manner.
- LF - Enum constant in enum org.apache.commons.io.StandardLineSeparator
-
Line feed.
- LF - Static variable in class org.apache.commons.io.IOUtils
-
LF char '10'.
- limit(long) - Method in interface org.apache.commons.io.function.IOStream
-
Like
Stream.limit(long)
. - LINE_SEPARATOR - Static variable in class org.apache.commons.io.IOUtils
-
Deprecated.
- LINE_SEPARATOR_UNIX - Static variable in class org.apache.commons.io.IOUtils
-
The UNIX line separator string.
- LINE_SEPARATOR_WINDOWS - Static variable in class org.apache.commons.io.IOUtils
-
The Windows line separator string.
- lineIterator(File) - Static method in class org.apache.commons.io.FileUtils
-
Returns an Iterator for the lines in a
File
using the default encoding for the VM. - lineIterator(File, String) - Static method in class org.apache.commons.io.FileUtils
-
Returns an Iterator for the lines in a
File
. - lineIterator(InputStream, String) - Static method in class org.apache.commons.io.IOUtils
-
Returns an Iterator for the lines in an
InputStream
, using the character encoding specified (or default encoding if null). - lineIterator(InputStream, Charset) - Static method in class org.apache.commons.io.IOUtils
-
Returns an Iterator for the lines in an
InputStream
, using the character encoding specified (or default encoding if null). - lineIterator(Reader) - Static method in class org.apache.commons.io.IOUtils
-
Returns an Iterator for the lines in a
Reader
. - LineIterator - Class in org.apache.commons.io
-
An Iterator over the lines in a
Reader
. - LineIterator(Reader) - Constructor for class org.apache.commons.io.LineIterator
-
Constructs an iterator of the lines for a
Reader
. - lines(Path) - Static method in class org.apache.commons.io.file.FilesUncheck
- lines(Path, Charset) - Static method in class org.apache.commons.io.file.FilesUncheck
- LINUX - Enum constant in enum org.apache.commons.io.FileSystem
-
Linux file system.
- list(Path) - Static method in class org.apache.commons.io.file.FilesUncheck
- listFiles(File, String[], boolean) - Static method in class org.apache.commons.io.FileUtils
-
Lists files within a given directory (and optionally its subdirectories) which match an array of extensions.
- listFiles(File, IOFileFilter, IOFileFilter) - Static method in class org.apache.commons.io.FileUtils
-
Finds files within a given directory (and optionally its subdirectories).
- listFilesAndDirs(File, IOFileFilter, IOFileFilter) - Static method in class org.apache.commons.io.FileUtils
-
Finds files within a given directory (and optionally its subdirectories).
- LockableFileWriter - Class in org.apache.commons.io.output
-
FileWriter that will create and honor lock files to allow simple cross thread file lock handling.
- LockableFileWriter(File) - Constructor for class org.apache.commons.io.output.LockableFileWriter
-
Deprecated.
- LockableFileWriter(File, boolean) - Constructor for class org.apache.commons.io.output.LockableFileWriter
-
Deprecated.
- LockableFileWriter(File, boolean, String) - Constructor for class org.apache.commons.io.output.LockableFileWriter
-
Deprecated.
- LockableFileWriter(File, String) - Constructor for class org.apache.commons.io.output.LockableFileWriter
-
Deprecated.
- LockableFileWriter(File, String, boolean, String) - Constructor for class org.apache.commons.io.output.LockableFileWriter
-
Deprecated.
- LockableFileWriter(File, Charset) - Constructor for class org.apache.commons.io.output.LockableFileWriter
-
Deprecated.
- LockableFileWriter(File, Charset, boolean, String) - Constructor for class org.apache.commons.io.output.LockableFileWriter
-
Deprecated.
- LockableFileWriter(String) - Constructor for class org.apache.commons.io.output.LockableFileWriter
-
Deprecated.
- LockableFileWriter(String, boolean) - Constructor for class org.apache.commons.io.output.LockableFileWriter
-
Deprecated.
- LockableFileWriter(String, boolean, String) - Constructor for class org.apache.commons.io.output.LockableFileWriter
-
Deprecated.
- LockableFileWriter.Builder - Class in org.apache.commons.io.output
-
Builds a new
LockableFileWriter
. - longCounter() - Static method in class org.apache.commons.io.file.Counters
-
Returns a new long Counter.
- longPathCounters() - Static method in class org.apache.commons.io.file.Counters
-
Returns a new BigInteger PathCounters.
M
- MAC_OSX - Enum constant in enum org.apache.commons.io.FileSystem
-
MacOS file system.
- magicNumberFileFilter(byte[]) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that accepts files that begin with the provided magic number.
- magicNumberFileFilter(byte[], long) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that accepts files that contains the provided magic number at a specified offset within the file.
- magicNumberFileFilter(String) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that accepts files that begin with the provided magic number.
- magicNumberFileFilter(String, long) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that accepts files that contains the provided magic number at a specified offset within the file.
- MagicNumberFileFilter - Class in org.apache.commons.io.filefilter
-
File filter for matching files containing a "magic number".
- MagicNumberFileFilter(byte[]) - Constructor for class org.apache.commons.io.filefilter.MagicNumberFileFilter
-
Constructs a new MagicNumberFileFilter and associates it with the magic number to test for in files.
- MagicNumberFileFilter(byte[], long) - Constructor for class org.apache.commons.io.filefilter.MagicNumberFileFilter
-
Constructs a new MagicNumberFileFilter and associates it with the magic number to test for in files and the byte offset location in the file to to look for that magic number.
- MagicNumberFileFilter(String) - Constructor for class org.apache.commons.io.filefilter.MagicNumberFileFilter
-
Constructs a new MagicNumberFileFilter and associates it with the magic number to test for in files.
- MagicNumberFileFilter(String, long) - Constructor for class org.apache.commons.io.filefilter.MagicNumberFileFilter
-
Constructs a new MagicNumberFileFilter and associates it with the magic number to test for in files and the byte offset location in the file to to look for that magic number.
- makeCVSAware(IOFileFilter) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Decorates a filter to make it ignore CVS directories.
- makeDirectoryOnly(IOFileFilter) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Decorates a filter so that it only applies to directories and not to files.
- makeFileOnly(IOFileFilter) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Decorates a filter so that it only applies to files and not to directories.
- makeSVNAware(IOFileFilter) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Decorates a filter to make it ignore SVN directories.
- map(IOFunction<? super T, ? extends R>) - Method in interface org.apache.commons.io.function.IOStream
- mapToDouble(ToDoubleFunction<? super T>) - Method in interface org.apache.commons.io.function.IOStream
-
TODO Package-private for now, needs IOToDoubleFunction?
- mapToInt(ToIntFunction<? super T>) - Method in interface org.apache.commons.io.function.IOStream
-
TODO Package-private for now, needs IOToIntFunction?
- mapToLong(ToLongFunction<? super T>) - Method in interface org.apache.commons.io.function.IOStream
-
TODO Package-private for now, needs IOToLongFunction?
- mark(int) - Method in class org.apache.commons.io.input.BOMInputStream
-
Invokes the delegate's
mark(int)
method. - mark(int) - Method in class org.apache.commons.io.input.BoundedInputStream
-
Invokes the delegate's
InputStream.mark(int)
method. - mark(int) - Method in class org.apache.commons.io.input.BoundedReader
-
marks the target stream
- mark(int) - Method in class org.apache.commons.io.input.BrokenReader
-
Throws the configured exception.
- mark(int) - Method in class org.apache.commons.io.input.CharSequenceInputStream
- mark(int) - Method in class org.apache.commons.io.input.CharSequenceReader
-
Mark the current position.
- mark(int) - Method in class org.apache.commons.io.input.MarkShieldInputStream
- mark(int) - Method in class org.apache.commons.io.input.NullInputStream
-
Marks the current position.
- mark(int) - Method in class org.apache.commons.io.input.NullReader
-
Marks the current position.
- mark(int) - Method in class org.apache.commons.io.input.ProxyInputStream
-
Invokes the delegate's
InputStream.mark(int)
method. - mark(int) - Method in class org.apache.commons.io.input.ProxyReader
-
Invokes the delegate's
mark(int)
method. - mark(int) - Method in class org.apache.commons.io.input.UncheckedBufferedReader
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - mark(int) - Method in class org.apache.commons.io.input.UncheckedFilterReader
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - mark(int) - Method in class org.apache.commons.io.input.UnixLineEndingInputStream
- mark(int) - Method in class org.apache.commons.io.input.UnsynchronizedBufferedInputStream
-
Sets a mark position in this stream.
- mark(int) - Method in class org.apache.commons.io.input.UnsynchronizedBufferedReader
-
Sets a mark position in this reader.
- mark(int) - Method in class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream
- mark(int) - Method in class org.apache.commons.io.input.UnsynchronizedFilterInputStream
-
Sets a mark position in this stream.
- mark(int) - Method in class org.apache.commons.io.input.WindowsLineEndingInputStream
- markLimit - Variable in class org.apache.commons.io.input.UnsynchronizedBufferedInputStream
-
The current limit, which when passed, invalidates the current mark.
- markPos - Variable in class org.apache.commons.io.input.UnsynchronizedBufferedInputStream
-
The currently marked position. -1 indicates no mark has been set or the mark has been invalidated.
- MarkShieldInputStream - Class in org.apache.commons.io.input
-
This is an alternative to
ByteArrayInputStream
which removes the synchronization overhead for non-concurrent access; as such this class is not thread-safe. - MarkShieldInputStream(InputStream) - Constructor for class org.apache.commons.io.input.MarkShieldInputStream
-
Constructs a proxy that shields the given input stream from being marked or rest.
- markSupported() - Method in class org.apache.commons.io.input.BoundedInputStream
-
Invokes the delegate's
InputStream.markSupported()
method. - markSupported() - Method in class org.apache.commons.io.input.CharSequenceInputStream
- markSupported() - Method in class org.apache.commons.io.input.CharSequenceReader
-
Mark is supported (returns true).
- markSupported() - Method in class org.apache.commons.io.input.MarkShieldInputStream
- markSupported() - Method in class org.apache.commons.io.input.NullInputStream
-
Tests whether mark is supported.
- markSupported() - Method in class org.apache.commons.io.input.NullReader
-
Indicates whether mark is supported.
- markSupported() - Method in class org.apache.commons.io.input.ProxyInputStream
-
Invokes the delegate's
InputStream.markSupported()
method. - markSupported() - Method in class org.apache.commons.io.input.ProxyReader
-
Invokes the delegate's
markSupported()
method. - markSupported() - Method in class org.apache.commons.io.input.UnsynchronizedBufferedInputStream
-
Indicates whether
BufferedInputStream
supports themark()
andreset()
methods. - markSupported() - Method in class org.apache.commons.io.input.UnsynchronizedBufferedReader
-
Tests whether this reader supports the
UnsynchronizedBufferedReader.mark(int)
andUnsynchronizedBufferedReader.reset()
methods. - markSupported() - Method in class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream
- markSupported() - Method in class org.apache.commons.io.input.UnsynchronizedFilterInputStream
-
Indicates whether this stream supports
mark()
andreset()
. - matches(String) - Method in interface org.apache.commons.io.serialization.ClassNameMatcher
-
Returns
true
if the supplied class name matches this object's condition. - matches(Path) - Method in interface org.apache.commons.io.filefilter.IOFileFilter
-
Tests if a Path should be accepted by this filter.
- matches(Path) - Method in class org.apache.commons.io.filefilter.PathMatcherFileFilter
- max(IOComparator<? super T>) - Method in interface org.apache.commons.io.function.IOStream
- maxBy(IOComparator<? super T>) - Static method in interface org.apache.commons.io.function.IOBinaryOperator
-
Creates a
IOBinaryOperator
which returns the greater of two elements according to the specifiedComparator
. - MemoryMappedFileInputStream - Class in org.apache.commons.io.input
-
An
InputStream
that utilizes memory mapped files to improve performance. - MemoryMappedFileInputStream.Builder - Class in org.apache.commons.io.input
-
Builds a new
MemoryMappedFileInputStream
. - MessageDigestCalculatingInputStream - Class in org.apache.commons.io.input
-
Deprecated.
- MessageDigestCalculatingInputStream(InputStream) - Constructor for class org.apache.commons.io.input.MessageDigestCalculatingInputStream
- MessageDigestCalculatingInputStream(InputStream, String) - Constructor for class org.apache.commons.io.input.MessageDigestCalculatingInputStream
- MessageDigestCalculatingInputStream(InputStream, MessageDigest) - Constructor for class org.apache.commons.io.input.MessageDigestCalculatingInputStream
- MessageDigestCalculatingInputStream.Builder - Class in org.apache.commons.io.input
-
Deprecated.Builds a new
MessageDigestCalculatingInputStream
. - MessageDigestCalculatingInputStream.MessageDigestMaintainingObserver - Class in org.apache.commons.io.input
-
Deprecated.Maintains the message digest.
- MessageDigestInputStream - Class in org.apache.commons.io.input
-
This class is an example for using an
ObservableInputStream
. - MessageDigestInputStream.Builder - Class in org.apache.commons.io.input
-
Builds new
MessageDigestInputStream
. - MessageDigestInputStream.MessageDigestMaintainingObserver - Class in org.apache.commons.io.input
-
Maintains the message digest.
- MessageDigestMaintainingObserver(MessageDigest) - Constructor for class org.apache.commons.io.input.MessageDigestCalculatingInputStream.MessageDigestMaintainingObserver
-
Deprecated.Constructs an MessageDigestMaintainingObserver for the given MessageDigest.
- MessageDigestMaintainingObserver(MessageDigest) - Constructor for class org.apache.commons.io.input.MessageDigestInputStream.MessageDigestMaintainingObserver
-
Constructs an MessageDigestMaintainingObserver for the given MessageDigest.
- min(IOComparator<? super T>) - Method in interface org.apache.commons.io.function.IOStream
- minBy(IOComparator<? super T>) - Static method in interface org.apache.commons.io.function.IOBinaryOperator
-
Creates a
IOBinaryOperator
which returns the lesser of two elements according to the specifiedComparator
. - minusMillis(FileTime, long) - Static method in class org.apache.commons.io.file.attribute.FileTimes
-
Subtracts milliseconds from a source FileTime.
- minusNanos(FileTime, long) - Static method in class org.apache.commons.io.file.attribute.FileTimes
-
Subtracts nanoseconds from a source FileTime.
- minusSeconds(FileTime, long) - Static method in class org.apache.commons.io.file.attribute.FileTimes
-
Subtracts seconds from a source FileTime.
- move(Path, Path, CopyOption...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.move(Path, Path, CopyOption...)
throwingUncheckedIOException
instead ofIOException
. - moveDirectory(File, File) - Static method in class org.apache.commons.io.FileUtils
-
Moves a directory.
- moveDirectoryToDirectory(File, File, boolean) - Static method in class org.apache.commons.io.FileUtils
-
Moves a directory to another directory.
- moveFile(File, File) - Static method in class org.apache.commons.io.FileUtils
-
Moves a file preserving attributes.
- moveFile(File, File, CopyOption...) - Static method in class org.apache.commons.io.FileUtils
-
Moves a file.
- moveFileToDirectory(File, File, boolean) - Static method in class org.apache.commons.io.FileUtils
-
Moves a file into a directory.
- moveToDirectory(File, File, boolean) - Static method in class org.apache.commons.io.FileUtils
-
Moves a file or directory into a destination directory.
N
- NAME_COMPARATOR - Static variable in class org.apache.commons.io.comparator.NameFileComparator
-
Case-sensitive name comparator instance (see
IOCase.SENSITIVE
) - NAME_INSENSITIVE_COMPARATOR - Static variable in class org.apache.commons.io.comparator.NameFileComparator
-
Case-insensitive name comparator instance (see
IOCase.INSENSITIVE
) - NAME_INSENSITIVE_REVERSE - Static variable in class org.apache.commons.io.comparator.NameFileComparator
-
Reverse case-insensitive name comparator instance (see
IOCase.INSENSITIVE
) - NAME_REVERSE - Static variable in class org.apache.commons.io.comparator.NameFileComparator
-
Reverse case-sensitive name comparator instance (see
IOCase.SENSITIVE
) - NAME_SYSTEM_COMPARATOR - Static variable in class org.apache.commons.io.comparator.NameFileComparator
-
System sensitive name comparator instance (see
IOCase.SYSTEM
) - NAME_SYSTEM_REVERSE - Static variable in class org.apache.commons.io.comparator.NameFileComparator
-
Reverse system sensitive name comparator instance (see
IOCase.SYSTEM
) - NameFileComparator - Class in org.apache.commons.io.comparator
-
Compare the names of two files for order (see
File.getName()
). - NameFileComparator() - Constructor for class org.apache.commons.io.comparator.NameFileComparator
-
Constructs a case-sensitive file name comparator instance.
- NameFileComparator(IOCase) - Constructor for class org.apache.commons.io.comparator.NameFileComparator
-
Constructs a file name comparator instance with the specified case-sensitivity.
- nameFileFilter(String) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that returns true if the file name matches the specified text.
- nameFileFilter(String, IOCase) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that returns true if the file name matches the specified text.
- NameFileFilter - Class in org.apache.commons.io.filefilter
-
Filters file names for a certain name.
- NameFileFilter(String) - Constructor for class org.apache.commons.io.filefilter.NameFileFilter
-
Constructs a new case-sensitive name file filter for a single name.
- NameFileFilter(String...) - Constructor for class org.apache.commons.io.filefilter.NameFileFilter
-
Constructs a new case-sensitive name file filter for an array of names.
- NameFileFilter(String[], IOCase) - Constructor for class org.apache.commons.io.filefilter.NameFileFilter
-
Constructs a new name file filter for an array of names specifying case-sensitivity.
- NameFileFilter(String, IOCase) - Constructor for class org.apache.commons.io.filefilter.NameFileFilter
-
Constructs a new name file filter specifying case-sensitivity.
- NameFileFilter(List<String>) - Constructor for class org.apache.commons.io.filefilter.NameFileFilter
-
Constructs a new case-sensitive name file filter for a list of names.
- NameFileFilter(List<String>, IOCase) - Constructor for class org.apache.commons.io.filefilter.NameFileFilter
-
Constructs a new name file filter for a list of names specifying case-sensitivity.
- needNewBuffer(int) - Method in class org.apache.commons.io.output.AbstractByteArrayOutputStream
-
Makes a new buffer available either by allocating a new one or re-cycling an existing one.
- negate() - Method in class org.apache.commons.io.filefilter.FalseFileFilter
- negate() - Method in interface org.apache.commons.io.filefilter.IOFileFilter
-
Constructs a new "not" filter with this filter.
- negate() - Method in class org.apache.commons.io.filefilter.TrueFileFilter
- negate() - Method in interface org.apache.commons.io.function.IOPredicate
-
Creates a predicate that represents the logical negation of this predicate.
- newBufferedReader(Path) - Static method in class org.apache.commons.io.file.FilesUncheck
- newBufferedReader(Path, Charset) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.newBufferedReader(Path, Charset)
throwingUncheckedIOException
instead ofIOException
. - newBufferedWriter(Path, Charset, OpenOption...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.newBufferedWriter(Path, Charset, OpenOption...)
throwingUncheckedIOException
instead ofIOException
. - newBufferedWriter(Path, OpenOption...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.newBufferedWriter(Path, OpenOption...)
throwingUncheckedIOException
instead ofIOException
. - newByteArrayOrigin(byte[]) - Static method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Constructs a new byte array origin for a byte array.
- newByteChannel(Path, OpenOption...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.newByteChannel(Path, OpenOption...)
throwingUncheckedIOException
instead ofIOException
. - newByteChannel(Path, Set<? extends OpenOption>, FileAttribute<?>...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.newByteChannel(Path, Set, FileAttribute...)
throwingUncheckedIOException
instead ofIOException
. - newCharSequenceOrigin(CharSequence) - Static method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Constructs a new CharSequence origin for a CharSequence.
- newChildInstance(File) - Method in class org.apache.commons.io.monitor.FileEntry
-
Constructs a new child instance.
- newDirectoryStream(Path) - Static method in class org.apache.commons.io.file.FilesUncheck
- newDirectoryStream(Path, String) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.newDirectoryStream(Path, String)
throwingUncheckedIOException
instead ofIOException
. - newDirectoryStream(Path, DirectoryStream.Filter<? super Path>) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.newDirectoryStream(Path, java.nio.file.DirectoryStream.Filter)
throwingUncheckedIOException
instead ofIOException
. - newDirectoryStream(Path, PathFilter) - Static method in class org.apache.commons.io.file.PathUtils
-
Creates a new DirectoryStream for Paths rooted at the given directory.
- newFileOrigin(File) - Static method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Constructs a new file origin for a file.
- newFileOrigin(String) - Static method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Constructs a new file origin for a file path.
- newInputStream(Path, OpenOption...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.newInputStream(Path, OpenOption...)
throwingUncheckedIOException
instead ofIOException
. - newInputStreamOrigin(InputStream) - Static method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Constructs a new input stream origin for a file.
- newOutputStream(File, boolean) - Static method in class org.apache.commons.io.FileUtils
-
Creates a new OutputStream by opening or creating a file, returning an output stream that may be used to write bytes to the file.
- newOutputStream(Path, boolean) - Static method in class org.apache.commons.io.file.PathUtils
-
Creates a new OutputStream by opening or creating a file, returning an output stream that may be used to write bytes to the file.
- newOutputStream(Path, OpenOption...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.newOutputStream(Path, OpenOption...)
throwingUncheckedIOException
instead ofIOException
. - newOutputStreamOrigin(OutputStream) - Static method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Constructs a new output stream origin for a file.
- newPathOrigin(String) - Static method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Constructs a new path name origin for a path name.
- newPathOrigin(Path) - Static method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Constructs a new path origin for a file.
- newQueueInputStream() - Method in class org.apache.commons.io.output.QueueOutputStream
-
Constructs a new QueueInputStream instance connected to this.
- newQueueOutputStream() - Method in class org.apache.commons.io.input.QueueInputStream
-
Constructs a new QueueOutputStream instance connected to this.
- newRandomAccessFileOrigin(RandomAccessFile) - Static method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Constructs a new RandomAccessFile origin for a RandomAccessFile.
- newRandomAccessFileOrigin(IORandomAccessFile) - Static method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Constructs a new RandomAccessFile origin for a RandomAccessFile.
- newReaderOrigin(Reader) - Static method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Constructs a new reader origin for a reader.
- newURIOrigin(URI) - Static method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Constructs a new reader origin for a URI.
- newWriterOrigin(Writer) - Static method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Constructs a new writer origin for a file.
- next() - Method in interface org.apache.commons.io.function.IOIterator
-
Like
Iterator.next()
. - next() - Method in class org.apache.commons.io.LineIterator
-
Returns the next line in the wrapped
Reader
. - next() - Method in class org.apache.commons.io.StreamIterator
- nextLine() - Method in class org.apache.commons.io.LineIterator
-
Deprecated.Use
LineIterator.next()
. - NOFOLLOW_LINK_OPTION_ARRAY - Static variable in class org.apache.commons.io.file.PathUtils
-
Deprecated.
- noFollowLinkOptionArray() - Static method in class org.apache.commons.io.file.PathUtils
-
Copy of the
LinkOption
array forLinkOption.NOFOLLOW_LINKS
. - noneMatch(IOPredicate<? super T>) - Method in interface org.apache.commons.io.function.IOStream
- noop() - Static method in interface org.apache.commons.io.function.IOBiConsumer
-
Returns the no-op singleton.
- noop() - Static method in interface org.apache.commons.io.function.IOConsumer
-
Returns the constant no-op consumer.
- noop() - Static method in interface org.apache.commons.io.function.IORunnable
-
Returns the constant no-op runnable.
- noop() - Static method in interface org.apache.commons.io.function.IOTriConsumer
-
Returns the no-op singleton.
- NOOP - Static variable in interface org.apache.commons.io.function.IOIntConsumer
-
The constant no-op consumer.
- NOOP_IO_CONSUMER - Static variable in interface org.apache.commons.io.function.IOConsumer
-
Consider private.
- noopCounter() - Static method in class org.apache.commons.io.file.Counters
-
Returns the no-op Counter.
- noopPathCounters() - Static method in class org.apache.commons.io.file.Counters
-
Returns the no-op PathCounters.
- NoopPathVisitor - Class in org.apache.commons.io.file
-
A noop path visitor.
- NoopPathVisitor() - Constructor for class org.apache.commons.io.file.NoopPathVisitor
-
Constructs a new instance.
- NoopPathVisitor(IOBiFunction<Path, IOException, FileVisitResult>) - Constructor for class org.apache.commons.io.file.NoopPathVisitor
-
Constructs a new instance.
- NORMAL - Static variable in class org.apache.commons.io.FileDeleteStrategy
-
The singleton instance for normal file deletion, which does not permit the deletion of directories that are not empty.
- normalize(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Normalizes a path, removing double and single dot path steps.
- normalize(String, boolean) - Static method in class org.apache.commons.io.FilenameUtils
-
Normalizes a path, removing double and single dot path steps.
- normalizeNoEndSeparator(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Normalizes a path, removing double and single dot path steps, and removing any final directory separator.
- normalizeNoEndSeparator(String, boolean) - Static method in class org.apache.commons.io.FilenameUtils
-
Normalizes a path, removing double and single dot path steps, and removing any final directory separator.
- normalizeSeparators(String) - Method in enum org.apache.commons.io.FileSystem
-
Converts all separators to the Windows separator of backslash.
- NOT_EMPTY - Static variable in class org.apache.commons.io.filefilter.EmptyFileFilter
-
Singleton instance of not-empty filter
- noteClosed() - Method in class org.apache.commons.io.input.ObservableInputStream
-
Notifies the observers by invoking
ObservableInputStream.Observer.finished()
. - noteDataByte(int) - Method in class org.apache.commons.io.input.ObservableInputStream
-
Notifies the observers by invoking
ObservableInputStream.Observer.data(int)
with the given arguments. - noteDataBytes(byte[], int, int) - Method in class org.apache.commons.io.input.ObservableInputStream
-
Notifies the observers by invoking
ObservableInputStream.Observer.data(byte[],int,int)
with the given arguments. - noteError(IOException) - Method in class org.apache.commons.io.input.ObservableInputStream
-
Notifies the observers by invoking
ObservableInputStream.Observer.error(IOException)
with the given argument. - noteFinished() - Method in class org.apache.commons.io.input.ObservableInputStream
-
Notifies the observers by invoking
ObservableInputStream.Observer.finished()
. - notFileFilter(IOFileFilter) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that NOTs the specified filter.
- NotFileFilter - Class in org.apache.commons.io.filefilter
-
This filter produces a logical NOT of the filters specified.
- NotFileFilter(IOFileFilter) - Constructor for class org.apache.commons.io.filefilter.NotFileFilter
-
Constructs a new file filter that NOTs the result of another filter.
- now() - Static method in class org.apache.commons.io.file.attribute.FileTimes
-
Obtains the current instant FileTime from the system clock.
- ntfsTimeToDate(long) - Static method in class org.apache.commons.io.file.attribute.FileTimes
-
Converts NTFS time (100 nanosecond units since 1 January 1601) to Java time.
- ntfsTimeToFileTime(long) - Static method in class org.apache.commons.io.file.attribute.FileTimes
-
Converts NTFS time (100-nanosecond units since 1 January 1601) to a FileTime.
- NULL_OUTPUT_STREAM - Static variable in class org.apache.commons.io.output.NullOutputStream
-
Deprecated.
- NULL_PRINT_STREAM - Static variable in class org.apache.commons.io.output.NullPrintStream
-
Deprecated.
- NULL_WRITER - Static variable in class org.apache.commons.io.output.NullWriter
-
Deprecated.Use
NullWriter.INSTANCE
. - NullAppendable - Class in org.apache.commons.io.output
-
Appends all data to the famous /dev/null.
- NullInputStream - Class in org.apache.commons.io.input
-
A light weight
InputStream
that emulates a stream of a specified size. - NullInputStream() - Constructor for class org.apache.commons.io.input.NullInputStream
-
Constructs an
InputStream
that emulates a size 0 stream which supports marking and does not throw EOFException. - NullInputStream(long) - Constructor for class org.apache.commons.io.input.NullInputStream
-
Constructs an
InputStream
that emulates a specified size which supports marking and does not throw EOFException. - NullInputStream(long, boolean, boolean) - Constructor for class org.apache.commons.io.input.NullInputStream
-
Constructs an
InputStream
that emulates a specified size with option settings. - NullOutputStream - Class in org.apache.commons.io.output
-
Never writes data.
- NullOutputStream() - Constructor for class org.apache.commons.io.output.NullOutputStream
-
Deprecated.
- NullPrintStream - Class in org.apache.commons.io.output
-
Never prints data.
- NullPrintStream() - Constructor for class org.apache.commons.io.output.NullPrintStream
-
Deprecated.
- NullReader - Class in org.apache.commons.io.input
-
A functional, light weight
Reader
that emulates a reader of a specified size. - NullReader() - Constructor for class org.apache.commons.io.input.NullReader
-
Constructs a
Reader
that emulates a size 0 reader which supports marking and does not throw EOFException. - NullReader(long) - Constructor for class org.apache.commons.io.input.NullReader
-
Constructs a
Reader
that emulates a specified size which supports marking and does not throw EOFException. - NullReader(long, boolean, boolean) - Constructor for class org.apache.commons.io.input.NullReader
-
Constructs a
Reader
that emulates a specified size with option settings. - NullWriter - Class in org.apache.commons.io.output
-
Never writes data.
- NullWriter() - Constructor for class org.apache.commons.io.output.NullWriter
-
Deprecated.Use
NullWriter.INSTANCE
.
O
- ObjectStreamClassPredicate - Class in org.apache.commons.io.serialization
-
A predicate (boolean-valued function) of one argument to accept and reject classes.
- ObjectStreamClassPredicate() - Constructor for class org.apache.commons.io.serialization.ObjectStreamClassPredicate
-
Constructs a new instance.
- ObservableInputStream - Class in org.apache.commons.io.input
-
The
ObservableInputStream
allows, that an InputStream may be consumed by other receivers, apart from the thread, which is reading it. - ObservableInputStream(InputStream) - Constructor for class org.apache.commons.io.input.ObservableInputStream
-
Constructs a new ObservableInputStream for the given InputStream.
- ObservableInputStream(InputStream, ObservableInputStream.Observer...) - Constructor for class org.apache.commons.io.input.ObservableInputStream
-
Constructs a new ObservableInputStream for the given InputStream.
- ObservableInputStream.AbstractBuilder<T extends ObservableInputStream.AbstractBuilder<T>> - Class in org.apache.commons.io.input
-
For subclassing builders from
BoundedInputStream
subclassses. - ObservableInputStream.Builder - Class in org.apache.commons.io.input
-
Builds instances of
ObservableInputStream
. - ObservableInputStream.Observer - Class in org.apache.commons.io.input
-
Abstracts observer callback for
ObservableInputStream
s. - Observer() - Constructor for class org.apache.commons.io.input.ObservableInputStream.Observer
- of(Iterable<T>) - Static method in interface org.apache.commons.io.function.IOStream
-
Null-safe version of
StreamSupport.stream(java.util.Spliterator, boolean)
. - of(T) - Static method in interface org.apache.commons.io.function.IOStream
-
Returns a sequential
IOStreamImpl
containing a single element. - of(T...) - Static method in interface org.apache.commons.io.function.IOStream
-
Null-safe version of
Stream.of(Object[])
for an IO stream. - on(Appendable) - Static method in interface org.apache.commons.io.output.UncheckedAppendable
-
Constructs a new instance on the given Appendable.
- onClose(IORunnable) - Method in interface org.apache.commons.io.function.IOBaseStream
- onDirectoryChange(File) - Method in interface org.apache.commons.io.monitor.FileAlterationListener
-
Directory changed Event.
- onDirectoryChange(File) - Method in class org.apache.commons.io.monitor.FileAlterationListenerAdaptor
-
Directory changed Event.
- onDirectoryCreate(File) - Method in interface org.apache.commons.io.monitor.FileAlterationListener
-
Directory created Event.
- onDirectoryCreate(File) - Method in class org.apache.commons.io.monitor.FileAlterationListenerAdaptor
-
Directory created Event.
- onDirectoryDelete(File) - Method in interface org.apache.commons.io.monitor.FileAlterationListener
-
Directory deleted Event.
- onDirectoryDelete(File) - Method in class org.apache.commons.io.monitor.FileAlterationListenerAdaptor
-
Directory deleted Event.
- ONE_EB - Static variable in class org.apache.commons.io.FileUtils
-
The number of bytes in an exabyte.
- ONE_EB_BI - Static variable in class org.apache.commons.io.FileUtils
-
The number of bytes in an exabyte.
- ONE_GB - Static variable in class org.apache.commons.io.FileUtils
-
The number of bytes in a gigabyte.
- ONE_GB_BI - Static variable in class org.apache.commons.io.FileUtils
-
The number of bytes in a gigabyte.
- ONE_KB - Static variable in class org.apache.commons.io.FileUtils
-
The number of bytes in a kilobyte.
- ONE_KB_BI - Static variable in class org.apache.commons.io.FileUtils
-
The number of bytes in a kilobyte.
- ONE_MB - Static variable in class org.apache.commons.io.FileUtils
-
The number of bytes in a megabyte.
- ONE_MB_BI - Static variable in class org.apache.commons.io.FileUtils
-
The number of bytes in a megabyte.
- ONE_PB - Static variable in class org.apache.commons.io.FileUtils
-
The number of bytes in a petabyte.
- ONE_PB_BI - Static variable in class org.apache.commons.io.FileUtils
-
The number of bytes in a petabyte.
- ONE_TB - Static variable in class org.apache.commons.io.FileUtils
-
The number of bytes in a terabyte.
- ONE_TB_BI - Static variable in class org.apache.commons.io.FileUtils
-
The number of bytes in a terabyte.
- ONE_YB - Static variable in class org.apache.commons.io.FileUtils
-
The number of bytes in a yottabyte.
- ONE_ZB - Static variable in class org.apache.commons.io.FileUtils
-
The number of bytes in a zettabyte.
- onFileChange(File) - Method in interface org.apache.commons.io.monitor.FileAlterationListener
-
File changed Event.
- onFileChange(File) - Method in class org.apache.commons.io.monitor.FileAlterationListenerAdaptor
-
File changed Event.
- onFileCreate(File) - Method in interface org.apache.commons.io.monitor.FileAlterationListener
-
File created Event.
- onFileCreate(File) - Method in class org.apache.commons.io.monitor.FileAlterationListenerAdaptor
-
File created Event.
- onFileDelete(File) - Method in interface org.apache.commons.io.monitor.FileAlterationListener
-
File deleted Event.
- onFileDelete(File) - Method in class org.apache.commons.io.monitor.FileAlterationListenerAdaptor
-
File deleted Event.
- onMaxLength(long, long) - Method in class org.apache.commons.io.input.BoundedInputStream
-
A caller has caused a request that would cross the
maxLength
boundary. - onStart(FileAlterationObserver) - Method in interface org.apache.commons.io.monitor.FileAlterationListener
-
File system observer started checking event.
- onStart(FileAlterationObserver) - Method in class org.apache.commons.io.monitor.FileAlterationListenerAdaptor
-
File system observer started checking event.
- onStop(FileAlterationObserver) - Method in interface org.apache.commons.io.monitor.FileAlterationListener
-
File system observer finished checking event.
- onStop(FileAlterationObserver) - Method in class org.apache.commons.io.monitor.FileAlterationListenerAdaptor
-
File system observer finished checking event.
- openInputStream(File) - Static method in class org.apache.commons.io.FileUtils
-
Opens a
FileInputStream
for the specified file, providing better error messages than simply callingnew FileInputStream(file)
. - openOutputStream(File) - Static method in class org.apache.commons.io.FileUtils
-
Opens a
FileOutputStream
for the specified file, checking and creating the parent directory if it does not exist. - openOutputStream(File, boolean) - Static method in class org.apache.commons.io.FileUtils
-
Opens a
FileOutputStream
for the specified file, checking and creating the parent directory if it does not exist. - or(IOFileFilter) - Method in class org.apache.commons.io.filefilter.FalseFileFilter
- or(IOFileFilter) - Method in interface org.apache.commons.io.filefilter.IOFileFilter
-
Constructs a new "or" filter with this filter.
- or(IOFileFilter) - Method in class org.apache.commons.io.filefilter.TrueFileFilter
- or(IOFileFilter...) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that ORs the specified filters.
- or(IOPredicate<? super T>) - Method in interface org.apache.commons.io.function.IOPredicate
-
Creates a composed predicate that represents a short-circuiting logical OR of this predicate and another.
- orFileFilter(IOFileFilter, IOFileFilter) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Deprecated.
- OrFileFilter - Class in org.apache.commons.io.filefilter
-
A
FileFilter
providing conditional OR logic across a list of file filters. - OrFileFilter() - Constructor for class org.apache.commons.io.filefilter.OrFileFilter
-
Constructs a new instance of
OrFileFilter
. - OrFileFilter(List<IOFileFilter>) - Constructor for class org.apache.commons.io.filefilter.OrFileFilter
-
Constructs a new instance of
OrFileFilter
with the specified filters. - OrFileFilter(IOFileFilter...) - Constructor for class org.apache.commons.io.filefilter.OrFileFilter
-
Constructs a new instance for the give filters.
- OrFileFilter(IOFileFilter, IOFileFilter) - Constructor for class org.apache.commons.io.filefilter.OrFileFilter
-
Constructs a new file filter that ORs the result of other filters.
- org.apache.commons.io - package org.apache.commons.io
-
Provides classes for working with streams, readers, writers and files.
- org.apache.commons.io.build - package org.apache.commons.io.build
-
Provides classes to implement IO builders.
- org.apache.commons.io.channels - package org.apache.commons.io.channels
-
Provides classes to work with
java.nio.channels
. - org.apache.commons.io.charset - package org.apache.commons.io.charset
-
Provides classes to work with code from
java.nio.charset
. - org.apache.commons.io.comparator - package org.apache.commons.io.comparator
- org.apache.commons.io.file - package org.apache.commons.io.file
-
Provides extensions in the realm of
java.nio.file
. - org.apache.commons.io.file.attribute - package org.apache.commons.io.file.attribute
-
Provides help using
java.nio.file.attribute
types. - org.apache.commons.io.file.spi - package org.apache.commons.io.file.spi
-
Provides extensions in the realm of
java.nio.file.spi
. - org.apache.commons.io.filefilter - package org.apache.commons.io.filefilter
- org.apache.commons.io.function - package org.apache.commons.io.function
-
Provides IO-only related functional interfaces for lambda expressions and method references.
- org.apache.commons.io.input - package org.apache.commons.io.input
-
Provides implementations of input classes, such as
InputStream
andReader
. - org.apache.commons.io.input.buffer - package org.apache.commons.io.input.buffer
-
Provides implementations of buffered input classes, such as
CircularBufferInputStream
andPeekableInputStream
. - org.apache.commons.io.monitor - package org.apache.commons.io.monitor
-
Provides a component for monitoring file system events (directory and file create, update and delete events).
- org.apache.commons.io.output - package org.apache.commons.io.output
-
Provides implementations of output classes, such as
OutputStream
andWriter
. - org.apache.commons.io.serialization - package org.apache.commons.io.serialization
-
Provides a framework for controlling the deserialization of classes.
- OutputStreamOrigin(OutputStream) - Constructor for class org.apache.commons.io.build.AbstractOrigin.OutputStreamOrigin
-
Constructs a new instance for the given origin.
- OVERRIDE_READ_ONLY - Enum constant in enum org.apache.commons.io.file.StandardDeleteOption
-
Overrides the read-only attribute to allow deletion, on POSIX, this means Write and Execute on the parent.
- overrideReadOnly(DeleteOption[]) - Static method in enum org.apache.commons.io.file.StandardDeleteOption
-
Returns true if the given options contain
StandardDeleteOption.OVERRIDE_READ_ONLY
.
P
- parallel() - Method in interface org.apache.commons.io.function.IOBaseStream
-
Like
BaseStream.parallel()
. - parseByteOrder(String) - Static method in class org.apache.commons.io.ByteOrderParser
-
Parses the String argument as a
ByteOrder
. - PATH_COMPARATOR - Static variable in class org.apache.commons.io.comparator.PathFileComparator
-
Case-sensitive path comparator instance (see
IOCase.SENSITIVE
) - PATH_INSENSITIVE_COMPARATOR - Static variable in class org.apache.commons.io.comparator.PathFileComparator
-
Case-insensitive path comparator instance (see
IOCase.INSENSITIVE
) - PATH_INSENSITIVE_REVERSE - Static variable in class org.apache.commons.io.comparator.PathFileComparator
-
Reverse case-insensitive path comparator instance (see
IOCase.INSENSITIVE
) - PATH_REVERSE - Static variable in class org.apache.commons.io.comparator.PathFileComparator
-
Reverse case-sensitive path comparator instance (see
IOCase.SENSITIVE
) - PATH_SYSTEM_COMPARATOR - Static variable in class org.apache.commons.io.comparator.PathFileComparator
-
System sensitive path comparator instance (see
IOCase.SYSTEM
) - PATH_SYSTEM_REVERSE - Static variable in class org.apache.commons.io.comparator.PathFileComparator
-
Reverse system sensitive path comparator instance (see
IOCase.SYSTEM
) - PathEqualsFileFilter - Class in org.apache.commons.io.filefilter
-
Accepts only an exact
Path
object match. - PathEqualsFileFilter(Path) - Constructor for class org.apache.commons.io.filefilter.PathEqualsFileFilter
-
Constructs a new instance for the given
Path
. - PathFileComparator - Class in org.apache.commons.io.comparator
-
Compare the path of two files for order (see
File.getPath()
). - PathFileComparator() - Constructor for class org.apache.commons.io.comparator.PathFileComparator
-
Constructs a case-sensitive file path comparator instance.
- PathFileComparator(IOCase) - Constructor for class org.apache.commons.io.comparator.PathFileComparator
-
Constructs a file path comparator instance with the specified case-sensitivity.
- PathFilter - Interface in org.apache.commons.io.file
-
A filter for
Path
s. - PathMatcherFileFilter - Class in org.apache.commons.io.filefilter
-
Delegates matching to a
PathMatcher
. - PathMatcherFileFilter(PathMatcher) - Constructor for class org.apache.commons.io.filefilter.PathMatcherFileFilter
-
Constructs a new instance to perform matching with a PathMatcher.
- PathOrigin(Path) - Constructor for class org.apache.commons.io.build.AbstractOrigin.PathOrigin
-
Constructs a new instance for the given origin.
- PathUtils - Class in org.apache.commons.io.file
-
NIO Path utilities.
- PathVisitor - Interface in org.apache.commons.io.file
-
A
FileVisitor
typed to aPath
. - PathVisitorFileFilter - Class in org.apache.commons.io.filefilter
-
A file filter backed by a path visitor.
- PathVisitorFileFilter(PathVisitor) - Constructor for class org.apache.commons.io.filefilter.PathVisitorFileFilter
-
Constructs a new instance that will forward calls to the given visitor.
- peek() - Method in class org.apache.commons.io.input.UnsynchronizedBufferedReader
-
Returns the next character in the current reader without consuming it.
- peek(byte[]) - Method in class org.apache.commons.io.input.buffer.PeekableInputStream
-
Returns whether the next bytes in the buffer are as given by
sourceBuffer
. - peek(byte[], int, int) - Method in class org.apache.commons.io.input.buffer.CircularByteBuffer
-
Returns, whether the next bytes in the buffer are exactly those, given by
sourceBuffer
,offset
, andlength
. - peek(byte[], int, int) - Method in class org.apache.commons.io.input.buffer.PeekableInputStream
-
Returns whether the next bytes in the buffer are as given by
sourceBuffer
, {code offset}, andlength
. - peek(char[]) - Method in class org.apache.commons.io.input.UnsynchronizedBufferedReader
-
Populates the buffer with the next
buf.length
characters in the current reader without consuming them. - peek(IOConsumer<? super T>) - Method in interface org.apache.commons.io.function.IOStream
- PeekableInputStream - Class in org.apache.commons.io.input.buffer
-
Implements a buffered input stream, which allows to peek into the buffers first bytes.
- PeekableInputStream(InputStream) - Constructor for class org.apache.commons.io.input.buffer.PeekableInputStream
-
Constructs a new instance, which filters the given input stream, and uses a reasonable default buffer size (
IOUtils.DEFAULT_BUFFER_SIZE
). - PeekableInputStream(InputStream, int) - Constructor for class org.apache.commons.io.input.buffer.PeekableInputStream
-
Constructs a new instance, which filters the given input stream, and uses the given buffer size.
- plusMillis(FileTime, long) - Static method in class org.apache.commons.io.file.attribute.FileTimes
-
Adds milliseconds to a source FileTime.
- plusNanos(FileTime, long) - Static method in class org.apache.commons.io.file.attribute.FileTimes
-
Adds nanoseconds from a source FileTime.
- plusSeconds(FileTime, long) - Static method in class org.apache.commons.io.file.attribute.FileTimes
-
Adds seconds to a source FileTime.
- pos - Variable in class org.apache.commons.io.input.UnsynchronizedBufferedInputStream
-
The current position within the byte array
buffer
. - postVisitDirectory(Path, IOException) - Method in class org.apache.commons.io.file.CountingPathVisitor
- postVisitDirectory(Path, IOException) - Method in class org.apache.commons.io.file.DeletingPathVisitor
- postVisitDirectory(Path, IOException) - Method in class org.apache.commons.io.filefilter.AbstractFileFilter
- prefixFileFilter(String) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that returns true if the file name starts with the specified text.
- prefixFileFilter(String, IOCase) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that returns true if the file name starts with the specified text.
- PrefixFileFilter - Class in org.apache.commons.io.filefilter
-
Filters file names for a certain prefix.
- PrefixFileFilter(String) - Constructor for class org.apache.commons.io.filefilter.PrefixFileFilter
-
Constructs a new Prefix file filter for a single prefix.
- PrefixFileFilter(String...) - Constructor for class org.apache.commons.io.filefilter.PrefixFileFilter
-
Constructs a new Prefix file filter for any of an array of prefixes.
- PrefixFileFilter(String[], IOCase) - Constructor for class org.apache.commons.io.filefilter.PrefixFileFilter
-
Constructs a new Prefix file filter for any of an array of prefixes specifying case-sensitivity.
- PrefixFileFilter(String, IOCase) - Constructor for class org.apache.commons.io.filefilter.PrefixFileFilter
-
Constructs a new Prefix file filter for a single prefix specifying case-sensitivity.
- PrefixFileFilter(List<String>) - Constructor for class org.apache.commons.io.filefilter.PrefixFileFilter
-
Constructs a new Prefix file filter for a list of prefixes.
- PrefixFileFilter(List<String>, IOCase) - Constructor for class org.apache.commons.io.filefilter.PrefixFileFilter
-
Constructs a new Prefix file filter for a list of prefixes specifying case-sensitivity.
- preVisitDirectory(Path, BasicFileAttributes) - Method in class org.apache.commons.io.file.CleaningPathVisitor
- preVisitDirectory(Path, BasicFileAttributes) - Method in class org.apache.commons.io.file.CopyDirectoryVisitor
- preVisitDirectory(Path, BasicFileAttributes) - Method in class org.apache.commons.io.file.CountingPathVisitor
- preVisitDirectory(Path, BasicFileAttributes) - Method in class org.apache.commons.io.file.DeletingPathVisitor
- preVisitDirectory(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.AbstractFileFilter
- probeContentType(Path) - Static method in class org.apache.commons.io.file.FilesUncheck
- processByte() - Method in class org.apache.commons.io.input.NullInputStream
-
Returns a byte value for the
read()
method. - processBytes(byte[], int, int) - Method in class org.apache.commons.io.input.NullInputStream
-
Processes the bytes for the
read(byte[], offset, length)
method. - processChar() - Method in class org.apache.commons.io.input.NullReader
-
Returns a character value for the
read()
method. - processChars(char[], int, int) - Method in class org.apache.commons.io.input.NullReader
-
Process the characters for the
read(char[], offset, length)
method. - ProxyCollectionWriter - Class in org.apache.commons.io.output
-
A Proxy stream collection which acts as expected, that is it passes the method calls on to the proxied streams and doesn't change which methods are being called.
- ProxyCollectionWriter(Writer...) - Constructor for class org.apache.commons.io.output.ProxyCollectionWriter
-
Constructs a new proxy collection writer.
- ProxyCollectionWriter(Collection<Writer>) - Constructor for class org.apache.commons.io.output.ProxyCollectionWriter
-
Constructs a new proxy collection writer.
- ProxyInputStream - Class in org.apache.commons.io.input
-
A proxy stream which acts as a
FilterInputStream
, by passing all method calls on to the proxied stream, not changing which methods are called. - ProxyInputStream(InputStream) - Constructor for class org.apache.commons.io.input.ProxyInputStream
-
Constructs a new ProxyInputStream.
- ProxyInputStream(InputStream, ProxyInputStream.AbstractBuilder<?, ?>) - Constructor for class org.apache.commons.io.input.ProxyInputStream
-
Constructs a new ProxyInputStream.
- ProxyInputStream(ProxyInputStream.AbstractBuilder<?, ?>) - Constructor for class org.apache.commons.io.input.ProxyInputStream
-
Constructs a new ProxyInputStream.
- ProxyInputStream.AbstractBuilder<T,
B extends AbstractStreamBuilder<T, B>> - Class in org.apache.commons.io.input -
Abstracts builder properties for subclasses.
- ProxyOutputStream - Class in org.apache.commons.io.output
-
A Proxy stream which acts as expected, that is it passes the method calls on to the proxied stream and doesn't change which methods are being called.
- ProxyOutputStream(OutputStream) - Constructor for class org.apache.commons.io.output.ProxyOutputStream
-
Constructs a new ProxyOutputStream.
- ProxyReader - Class in org.apache.commons.io.input
-
A Proxy stream which acts as expected, that is it passes the method calls on to the proxied stream and doesn't change which methods are being called.
- ProxyReader(Reader) - Constructor for class org.apache.commons.io.input.ProxyReader
-
Constructs a new ProxyReader.
- ProxyWriter - Class in org.apache.commons.io.output
-
A Proxy stream which acts as expected, that is it passes the method calls on to the proxied stream and doesn't change which methods are being called.
- ProxyWriter(Writer) - Constructor for class org.apache.commons.io.output.ProxyWriter
-
Constructs a new ProxyWriter.
Q
- QueueInputStream - Class in org.apache.commons.io.input
-
Simple alternative to JDK
PipedInputStream
; queue input stream provides what's written in queue output stream. - QueueInputStream() - Constructor for class org.apache.commons.io.input.QueueInputStream
-
Constructs a new instance with no limit to its internal queue size and zero timeout.
- QueueInputStream(BlockingQueue<Integer>) - Constructor for class org.apache.commons.io.input.QueueInputStream
-
Deprecated.
- QueueInputStream.Builder - Class in org.apache.commons.io.input
-
Builds a new
QueueInputStream
. - QueueOutputStream - Class in org.apache.commons.io.output
-
Simple alternative to JDK
PipedOutputStream
; queue input stream provides what's written in queue output stream. - QueueOutputStream() - Constructor for class org.apache.commons.io.output.QueueOutputStream
-
Constructs a new instance with no limit to internal buffer size.
- QueueOutputStream(BlockingQueue<Integer>) - Constructor for class org.apache.commons.io.output.QueueOutputStream
-
Constructs a new instance with given buffer.
R
- RandomAccessFileInputStream - Class in org.apache.commons.io.input
-
Streams data from a
RandomAccessFile
starting at its current position. - RandomAccessFileInputStream(RandomAccessFile) - Constructor for class org.apache.commons.io.input.RandomAccessFileInputStream
- RandomAccessFileInputStream(RandomAccessFile, boolean) - Constructor for class org.apache.commons.io.input.RandomAccessFileInputStream
- RandomAccessFileInputStream.Builder - Class in org.apache.commons.io.input
-
Builds a new
RandomAccessFileInputStream
. - RandomAccessFileMode - Enum in org.apache.commons.io
-
Enumerates access modes for
RandomAccessFile
with factory methods. - RandomAccessFileOrigin(RandomAccessFile) - Constructor for class org.apache.commons.io.build.AbstractOrigin.RandomAccessFileOrigin
-
A
RandomAccessFile
origin. - RandomAccessFileOutputStream - Class in org.apache.commons.io.output
-
An
OutputStream
that writes to aRandomAccessFile
. - RandomAccessFileOutputStream.Builder - Class in org.apache.commons.io.output
-
Builds a new
RandomAccessFileOutputStream
. - RandomAccessFiles - Class in org.apache.commons.io
-
Works with
RandomAccessFile
. - RandomAccessFiles() - Constructor for class org.apache.commons.io.RandomAccessFiles
-
Deprecated.TODO Make private in 3.0.
- read() - Method in class org.apache.commons.io.input.AbstractCharacterFilterReader
- read() - Method in class org.apache.commons.io.input.BOMInputStream
-
Invokes the delegate's
read()
method, detecting and optionally skipping BOM. - read() - Method in class org.apache.commons.io.input.BoundedInputStream
-
Invokes the delegate's
InputStream.read()
method if the current position is less than the limit. - read() - Method in class org.apache.commons.io.input.BoundedReader
-
Reads a single character
- read() - Method in class org.apache.commons.io.input.BrokenInputStream
-
Throws the configured exception.
- read() - Method in class org.apache.commons.io.input.buffer.CircularBufferInputStream
- read() - Method in class org.apache.commons.io.input.buffer.CircularByteBuffer
-
Returns the next byte from the buffer, removing it at the same time, so that following invocations won't return it again.
- read() - Method in class org.apache.commons.io.input.BufferedFileChannelInputStream
- read() - Method in class org.apache.commons.io.input.CharSequenceInputStream
- read() - Method in class org.apache.commons.io.input.CharSequenceReader
-
Read a single character.
- read() - Method in class org.apache.commons.io.input.CircularInputStream
- read() - Method in class org.apache.commons.io.input.ClosedInputStream
-
Returns -1 to indicate that the stream is closed.
- read() - Method in class org.apache.commons.io.input.DemuxInputStream
-
Reads byte from stream associated with current thread.
- read() - Method in class org.apache.commons.io.input.MemoryMappedFileInputStream
- read() - Method in class org.apache.commons.io.input.NullInputStream
-
Reads a byte.
- read() - Method in class org.apache.commons.io.input.NullReader
-
Reads a character.
- read() - Method in class org.apache.commons.io.input.ObservableInputStream
- read() - Method in class org.apache.commons.io.input.ProxyInputStream
-
Invokes the delegate's
InputStream.read()
method unless the stream is closed. - read() - Method in class org.apache.commons.io.input.ProxyReader
-
Invokes the delegate's
read()
method. - read() - Method in class org.apache.commons.io.input.QueueInputStream
-
Reads and returns a single byte.
- read() - Method in class org.apache.commons.io.input.RandomAccessFileInputStream
- read() - Method in class org.apache.commons.io.input.ReadAheadInputStream
- read() - Method in class org.apache.commons.io.input.ReaderInputStream
-
Reads a single byte.
- read() - Method in class org.apache.commons.io.input.SequenceReader
- read() - Method in class org.apache.commons.io.input.TeeInputStream
-
Reads a single byte from the proxied input stream and writes it to the associated output stream.
- read() - Method in class org.apache.commons.io.input.TeeReader
-
Reads a single character from the proxied reader and writes it to the associated writer.
- read() - Method in class org.apache.commons.io.input.UncheckedBufferedReader
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - read() - Method in class org.apache.commons.io.input.UncheckedFilterInputStream
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - read() - Method in class org.apache.commons.io.input.UncheckedFilterReader
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - read() - Method in class org.apache.commons.io.input.UnixLineEndingInputStream
- read() - Method in class org.apache.commons.io.input.UnsynchronizedBufferedInputStream
-
Reads a single byte from this stream and returns it as an integer in the range from 0 to 255.
- read() - Method in class org.apache.commons.io.input.UnsynchronizedBufferedReader
-
Reads a single character from this reader and returns it with the two higher-order bytes set to 0.
- read() - Method in class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream
- read() - Method in class org.apache.commons.io.input.UnsynchronizedFilterInputStream
-
Reads a single byte from the filtered stream and returns it as an integer in the range from 0 to 255.
- read() - Method in class org.apache.commons.io.input.WindowsLineEndingInputStream
- read(byte[]) - Method in class org.apache.commons.io.input.BOMInputStream
-
Invokes the delegate's
read(byte[])
method, detecting and optionally skipping BOM. - read(byte[]) - Method in class org.apache.commons.io.input.BoundedInputStream
-
Invokes the delegate's
InputStream.read(byte[])
method. - read(byte[]) - Method in class org.apache.commons.io.input.CharSequenceInputStream
- read(byte[]) - Method in class org.apache.commons.io.input.NullInputStream
-
Reads some bytes into the specified array.
- read(byte[]) - Method in class org.apache.commons.io.input.ObservableInputStream
- read(byte[]) - Method in class org.apache.commons.io.input.ProxyInputStream
-
Invokes the delegate's
InputStream.read(byte[])
method. - read(byte[]) - Method in class org.apache.commons.io.input.RandomAccessFileInputStream
- read(byte[]) - Method in class org.apache.commons.io.input.ReaderInputStream
-
Reads the specified number of bytes into an array.
- read(byte[]) - Method in interface org.apache.commons.io.input.Tailer.RandomAccessResourceBridge
-
Reads up to
b.length
bytes of data from this tailable into an array of bytes. - read(byte[]) - Method in class org.apache.commons.io.input.TeeInputStream
-
Reads bytes from the proxied input stream and writes the read bytes to the associated output stream.
- read(byte[]) - Method in class org.apache.commons.io.input.UncheckedFilterInputStream
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - read(byte[]) - Method in class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream
- read(byte[]) - Method in class org.apache.commons.io.input.UnsynchronizedFilterInputStream
-
Reads bytes from this stream and stores them in the byte array
buffer
. - read(byte[], int, int) - Method in class org.apache.commons.io.input.BOMInputStream
-
Invokes the delegate's
read(byte[], int, int)
method, detecting and optionally skipping BOM. - read(byte[], int, int) - Method in class org.apache.commons.io.input.BoundedInputStream
-
Invokes the delegate's
InputStream.read(byte[], int, int)
method. - read(byte[], int, int) - Method in class org.apache.commons.io.input.buffer.CircularBufferInputStream
- read(byte[], int, int) - Method in class org.apache.commons.io.input.buffer.CircularByteBuffer
-
Returns the given number of bytes from the buffer by storing them in the given byte array at the given offset.
- read(byte[], int, int) - Method in class org.apache.commons.io.input.BufferedFileChannelInputStream
- read(byte[], int, int) - Method in class org.apache.commons.io.input.CharSequenceInputStream
- read(byte[], int, int) - Method in class org.apache.commons.io.input.ClosedInputStream
-
Returns -1 to indicate that the stream is closed.
- read(byte[], int, int) - Method in class org.apache.commons.io.input.MemoryMappedFileInputStream
- read(byte[], int, int) - Method in class org.apache.commons.io.input.NullInputStream
-
Reads the specified number bytes into an array.
- read(byte[], int, int) - Method in class org.apache.commons.io.input.ObservableInputStream
- read(byte[], int, int) - Method in class org.apache.commons.io.input.ProxyInputStream
-
Invokes the delegate's
InputStream.read(byte[], int, int)
method. - read(byte[], int, int) - Method in class org.apache.commons.io.input.RandomAccessFileInputStream
- read(byte[], int, int) - Method in class org.apache.commons.io.input.ReadAheadInputStream
- read(byte[], int, int) - Method in class org.apache.commons.io.input.ReaderInputStream
-
Reads the specified number of bytes into an array.
- read(byte[], int, int) - Method in class org.apache.commons.io.input.TeeInputStream
-
Reads bytes from the proxied input stream and writes the read bytes to the associated output stream.
- read(byte[], int, int) - Method in class org.apache.commons.io.input.UncheckedFilterInputStream
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - read(byte[], int, int) - Method in class org.apache.commons.io.input.UnsynchronizedBufferedInputStream
-
Reads at most
length
bytes from this stream and stores them in byte arraybuffer
starting at offsetoffset
. - read(byte[], int, int) - Method in class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream
- read(byte[], int, int) - Method in class org.apache.commons.io.input.UnsynchronizedFilterInputStream
-
Reads at most
count
bytes from this stream and stores them in the byte arraybuffer
starting atoffset
. - read(char[]) - Method in class org.apache.commons.io.input.NullReader
-
Reads some characters into the specified array.
- read(char[]) - Method in class org.apache.commons.io.input.ProxyReader
-
Invokes the delegate's
read(char[])
method. - read(char[]) - Method in class org.apache.commons.io.input.TeeReader
-
Reads characters from the proxied reader and writes the read characters to the associated writer.
- read(char[]) - Method in class org.apache.commons.io.input.UncheckedBufferedReader
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - read(char[]) - Method in class org.apache.commons.io.input.UncheckedFilterReader
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - read(char[], int, int) - Method in class org.apache.commons.io.input.AbstractCharacterFilterReader
- read(char[], int, int) - Method in class org.apache.commons.io.input.BoundedReader
-
Reads into an array
- read(char[], int, int) - Method in class org.apache.commons.io.input.BrokenReader
-
Throws the configured exception.
- read(char[], int, int) - Method in class org.apache.commons.io.input.CharSequenceReader
-
Read the specified number of characters into the array.
- read(char[], int, int) - Method in class org.apache.commons.io.input.ClosedReader
-
Returns -1 to indicate that the stream is closed.
- read(char[], int, int) - Method in class org.apache.commons.io.input.NullReader
-
Reads the specified number characters into an array.
- read(char[], int, int) - Method in class org.apache.commons.io.input.ProxyReader
-
Invokes the delegate's
read(char[], int, int)
method. - read(char[], int, int) - Method in class org.apache.commons.io.input.SequenceReader
- read(char[], int, int) - Method in class org.apache.commons.io.input.TeeReader
-
Reads characters from the proxied reader and writes the read characters to the associated writer.
- read(char[], int, int) - Method in class org.apache.commons.io.input.UncheckedBufferedReader
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - read(char[], int, int) - Method in class org.apache.commons.io.input.UncheckedFilterReader
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - read(char[], int, int) - Method in class org.apache.commons.io.input.UnsynchronizedBufferedReader
-
Reads at most
length
characters from this reader and stores them atoffset
in the character arraybuffer
. - read(char[], int, int) - Method in class org.apache.commons.io.input.XmlStreamReader
-
Reads the underlying reader's
read(char[], int, int)
method. - read(InputStream, byte[]) - Static method in class org.apache.commons.io.IOUtils
-
Reads bytes from an input stream.
- read(InputStream, byte[], int, int) - Static method in class org.apache.commons.io.IOUtils
-
Reads bytes from an input stream.
- read(RandomAccessFile, long, int) - Static method in class org.apache.commons.io.RandomAccessFiles
-
Reads a byte array starting at "position" for "length" bytes.
- read(Reader, char[]) - Static method in class org.apache.commons.io.IOUtils
-
Reads characters from an input character stream.
- read(Reader, char[], int, int) - Static method in class org.apache.commons.io.IOUtils
-
Reads characters from an input character stream.
- read(ReadableByteChannel, ByteBuffer) - Static method in class org.apache.commons.io.IOUtils
-
Reads bytes from a ReadableByteChannel.
- read(CharBuffer) - Method in class org.apache.commons.io.input.ProxyReader
-
Invokes the delegate's
read(CharBuffer)
method. - read(CharBuffer) - Method in class org.apache.commons.io.input.TeeReader
-
Reads characters from the proxied reader and writes the read characters to the associated writer.
- read(CharBuffer) - Method in class org.apache.commons.io.input.UncheckedBufferedReader
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - read(CharBuffer) - Method in class org.apache.commons.io.input.UncheckedFilterReader
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - READ_ONLY - Enum constant in enum org.apache.commons.io.RandomAccessFileMode
-
Defines mode "r" to open a
RandomAccessFile
for reading only. - READ_ONLY - Static variable in class org.apache.commons.io.filefilter.CanReadFileFilter
-
Singleton instance of read-only filter
- READ_WRITE - Enum constant in enum org.apache.commons.io.RandomAccessFileMode
-
Defines mode "rw" to open a
RandomAccessFile
for reading and writing. - READ_WRITE_SYNC_ALL - Enum constant in enum org.apache.commons.io.RandomAccessFileMode
-
Defines mode "rws" to open a
RandomAccessFile
for reading and writing, as with "rw", and also require that every update to the file's content or metadata be written synchronously to the underlying storage device. - READ_WRITE_SYNC_CONTENT - Enum constant in enum org.apache.commons.io.RandomAccessFileMode
-
Defines mode "rwd" to open a
RandomAccessFile
for reading and writing, as with "rw", and also require that every update to the file's content be written synchronously to the underlying storage device. - ReadAheadInputStream - Class in org.apache.commons.io.input
-
Implements
InputStream
to asynchronously read ahead from an underlying input stream when a specified amount of data has been read from the current buffer. - ReadAheadInputStream(InputStream, int) - Constructor for class org.apache.commons.io.input.ReadAheadInputStream
-
Deprecated.
- ReadAheadInputStream(InputStream, int, ExecutorService) - Constructor for class org.apache.commons.io.input.ReadAheadInputStream
-
Deprecated.
- ReadAheadInputStream.Builder - Class in org.apache.commons.io.input
-
Builds a new
ReadAheadInputStream
. - readAllBytes(Path) - Static method in class org.apache.commons.io.file.FilesUncheck
- readAllLines(Path) - Static method in class org.apache.commons.io.file.FilesUncheck
- readAllLines(Path, Charset) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.readAllLines(Path, Charset)
throwingUncheckedIOException
instead ofIOException
. - readAttributes(Path, Class<A>, LinkOption...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.readAttributes(Path, Class, LinkOption...)
throwingUncheckedIOException
instead ofIOException
. - readAttributes(Path, Class<A>, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Reads the BasicFileAttributes from the given path.
- readAttributes(Path, String, LinkOption...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.readAttributes(Path, String, LinkOption...)
throwingUncheckedIOException
instead ofIOException
. - readBasicFileAttributes(Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Reads the BasicFileAttributes from the given path.
- readBasicFileAttributes(Path, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Reads the BasicFileAttributes from the given path.
- readBasicFileAttributesUnchecked(Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Deprecated.
- readBoolean() - Method in class org.apache.commons.io.input.SwappedDataInputStream
-
Return
SwappedDataInputStream.readByte()
! - readByte() - Method in class org.apache.commons.io.input.SwappedDataInputStream
-
Invokes the delegate's
read()
method. - readChar() - Method in class org.apache.commons.io.input.SwappedDataInputStream
-
Reads a 2 byte, unsigned, little endian UTF-16 code point.
- readDosFileAttributes(Path, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Reads the DosFileAttributes from the given path.
- readDouble() - Method in class org.apache.commons.io.input.SwappedDataInputStream
-
Reads an 8 byte, two's complement, little-endian long.
- ReaderInputStream - Class in org.apache.commons.io.input
-
InputStream
implementation that reads a character stream from aReader
and transforms it to a byte stream using a specified charset encoding. - ReaderInputStream(Reader) - Constructor for class org.apache.commons.io.input.ReaderInputStream
-
Deprecated.Use
ReaderInputStream.builder()
instead - ReaderInputStream(Reader, String) - Constructor for class org.apache.commons.io.input.ReaderInputStream
-
Deprecated.Use
ReaderInputStream.builder()
instead - ReaderInputStream(Reader, String, int) - Constructor for class org.apache.commons.io.input.ReaderInputStream
-
Deprecated.Use
ReaderInputStream.builder()
instead - ReaderInputStream(Reader, Charset) - Constructor for class org.apache.commons.io.input.ReaderInputStream
-
Deprecated.Use
ReaderInputStream.builder()
instead, will be protected for subclasses. - ReaderInputStream(Reader, CharsetEncoder) - Constructor for class org.apache.commons.io.input.ReaderInputStream
-
Deprecated.Use
ReaderInputStream.builder()
instead - ReaderInputStream(Reader, CharsetEncoder, int) - Constructor for class org.apache.commons.io.input.ReaderInputStream
-
Deprecated.Use
ReaderInputStream.builder()
instead - ReaderInputStream(Reader, Charset, int) - Constructor for class org.apache.commons.io.input.ReaderInputStream
-
Deprecated.Use
ReaderInputStream.builder()
instead - ReaderInputStream.Builder - Class in org.apache.commons.io.input
-
Builds a new
ReaderInputStream
. - ReaderOrigin(Reader) - Constructor for class org.apache.commons.io.build.AbstractOrigin.ReaderOrigin
-
Constructs a new instance for the given origin.
- readFileToByteArray(File) - Static method in class org.apache.commons.io.FileUtils
-
Reads the contents of a file into a byte array.
- readFileToString(File) - Static method in class org.apache.commons.io.FileUtils
-
Deprecated.Use
FileUtils.readFileToString(File, Charset)
instead (and specify the appropriate encoding) - readFileToString(File, String) - Static method in class org.apache.commons.io.FileUtils
-
Reads the contents of a file into a String.
- readFileToString(File, Charset) - Static method in class org.apache.commons.io.FileUtils
-
Reads the contents of a file into a String.
- readFloat() - Method in class org.apache.commons.io.input.SwappedDataInputStream
-
Reads a 4 byte, IEEE 754, little-endian float.
- readFully(byte[]) - Method in class org.apache.commons.io.input.SwappedDataInputStream
-
Invokes the delegate's
read(byte[] data, int, int)
method. - readFully(byte[], int, int) - Method in class org.apache.commons.io.input.SwappedDataInputStream
-
Invokes the delegate's
read(byte[] data, int, int)
method. - readFully(InputStream, byte[]) - Static method in class org.apache.commons.io.IOUtils
-
Reads the requested number of bytes or fail if there are not enough left.
- readFully(InputStream, byte[], int, int) - Static method in class org.apache.commons.io.IOUtils
-
Reads the requested number of bytes or fail if there are not enough left.
- readFully(InputStream, int) - Static method in class org.apache.commons.io.IOUtils
-
Reads the requested number of bytes or fail if there are not enough left.
- readFully(Reader, char[]) - Static method in class org.apache.commons.io.IOUtils
-
Reads the requested number of characters or fail if there are not enough left.
- readFully(Reader, char[], int, int) - Static method in class org.apache.commons.io.IOUtils
-
Reads the requested number of characters or fail if there are not enough left.
- readFully(ReadableByteChannel, ByteBuffer) - Static method in class org.apache.commons.io.IOUtils
-
Reads the requested number of bytes or fail if there are not enough left.
- readInt() - Method in class org.apache.commons.io.input.SwappedDataInputStream
-
Reads a 4 byte, two's complement little-endian integer.
- readLine() - Method in class org.apache.commons.io.input.ReversedLinesFileReader
-
Returns the lines of the file from bottom to top.
- readLine() - Method in class org.apache.commons.io.input.SwappedDataInputStream
-
Not currently supported - throws
UnsupportedOperationException
. - readLine() - Method in class org.apache.commons.io.input.UncheckedBufferedReader
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - readLine() - Method in class org.apache.commons.io.input.UnsynchronizedBufferedReader
-
Returns the next line of text available from this reader.
- readLines(int) - Method in class org.apache.commons.io.input.ReversedLinesFileReader
-
Returns
lineCount
lines of the file from bottom to top. - readLines(File) - Static method in class org.apache.commons.io.FileUtils
-
Deprecated.Use
FileUtils.readLines(File, Charset)
instead (and specify the appropriate encoding) - readLines(File, String) - Static method in class org.apache.commons.io.FileUtils
-
Reads the contents of a file line by line to a List of Strings.
- readLines(File, Charset) - Static method in class org.apache.commons.io.FileUtils
-
Reads the contents of a file line by line to a List of Strings.
- readLines(InputStream) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.
FileFilterUtils.and(IOFileFilter...)