Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- 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> - 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.
- AbstractFileComparator - Class in org.apache.commons.io.comparator
-
Abstract file
Comparator
which provides sorting for file arrays and lists. - AbstractFileComparator() - Constructor for class org.apache.commons.io.comparator.AbstractFileComparator
- 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.
- 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.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.OutputStreamOrigin - Class in org.apache.commons.io.build
-
An
OutputStream
origin. - AbstractOrigin.PathOrigin - Class in org.apache.commons.io.build
-
A
Path
origin. - AbstractOrigin.ReaderOrigin - Class in org.apache.commons.io.build
-
An
Reader
origin. - AbstractOrigin.URIOrigin - Class in org.apache.commons.io.build
-
A
URI
origin. - AbstractOrigin.WriterOrigin - Class in org.apache.commons.io.build
-
An
Writer
origin. - 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
- AbstractPathCounters(Counters.Counter, Counters.Counter, Counters.Counter) - Constructor for class org.apache.commons.io.file.Counters.AbstractPathCounters
-
Constructs a new instance.
- 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> - Class in org.apache.commons.io.build -
Abstracts supplying an instance of
T
. - AbstractSupplier() - Constructor for class org.apache.commons.io.build.AbstractSupplier
- accept(long) - Method in class org.apache.commons.io.filefilter.SizeFileFilter
- 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
-
Checks to see if the 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.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
-
Checks to see if the 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.ValidatingObjectInputStream
-
Accept the specified classes for deserialization, unless they are otherwise rejected.
- accept(String) - Method in class org.apache.commons.io.filefilter.PrefixFileFilter
- accept(String) - Method in class org.apache.commons.io.filefilter.SuffixFileFilter
- accept(String) - Method in class org.apache.commons.io.filefilter.WildcardFileFilter
- accept(String...) - Method in class org.apache.commons.io.serialization.ValidatingObjectInputStream
-
Accept the wildcard specified classes for deserialization, unless they are otherwise rejected.
- accept(Path) - Method in class org.apache.commons.io.file.CleaningPathVisitor
-
Returns true to process the given path, false if not.
- accept(Path) - Method in class org.apache.commons.io.file.DeletingPathVisitor
-
Returns true to process the given path, false if not.
- 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 the 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 the 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 the 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 file.
- 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(Pattern) - Method in class org.apache.commons.io.serialization.ValidatingObjectInputStream
-
Accept 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.Erase
-
Delegates to the given
IOBiConsumer
but erases itsIOException
for the compiler, while still throwing the exception at runtime. - 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.Erase
-
Delegates to the given
IOConsumer
but erases itsIOException
for the compiler, while still throwing the exception at runtime. - accept(IOConsumer<T>, T) - 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.ValidatingObjectInputStream
-
Accept 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.
- acceptBaseName(String) - Method in class org.apache.commons.io.filefilter.NameFileFilter
- acceptLarger - Variable in class org.apache.commons.io.filefilter.SizeFileFilter
-
Whether the files accepted will be larger or smaller.
- acceptMatchers - Variable in class org.apache.commons.io.serialization.ValidatingObjectInputStream
- acceptOlder - Variable in class org.apache.commons.io.filefilter.AgeFileFilter
-
Whether the files accepted will be older or newer.
- accumulate(Path, int, FileVisitOption[]) - Static method in class org.apache.commons.io.file.PathUtils
-
Accumulates file tree information in a
AccumulatorPathVisitor
. - 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.
- activeBuffer - Variable in class org.apache.commons.io.input.ReadAheadInputStream
- adapt(Iterator<E>) - Static method in interface org.apache.commons.io.function.IOIterator
-
Adapts the given Iterator as an IOIterator.
- adapt(Iterator<E>) - Static method in class org.apache.commons.io.function.IOIteratorAdapter
- adapt(Spliterator<E>) - Static method in interface org.apache.commons.io.function.IOSpliterator
-
Adapts the given Spliterator as an IOSpliterator.
- adapt(Spliterator<E>) - Static method in class org.apache.commons.io.function.IOSpliteratorAdapter
- adapt(Stream<T>) - Static method in interface org.apache.commons.io.function.IOStream
-
Constructs a new IOStream for the given Stream.
- adapt(Stream<T>) - Static method in class org.apache.commons.io.function.IOStreamAdapter
- 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 class org.apache.commons.io.file.Counters.BigIntegerCounter
- add(long) - Method in interface org.apache.commons.io.file.Counters.Counter
-
Adds the given number to this counter.
- add(long) - Method in class org.apache.commons.io.file.Counters.LongCounter
- add(long) - Method in class org.apache.commons.io.file.Counters.NoopCounter
- add(List<Path>, Path) - Method in class org.apache.commons.io.file.AccumulatorPathVisitor
- 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.
- addRequestProperty(String, String) - Method in class org.apache.commons.io.CloseableURLConnection
- addTracker(String, Object, FileDeleteStrategy) - Method in class org.apache.commons.io.FileCleaningTracker
-
Adds a tracker to the list of trackers.
- 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.CountingInputStream
-
Adds the number of read bytes to the count.
- afterRead(int) - Method in class org.apache.commons.io.input.ProxyInputStream
-
Invoked 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
-
Creates 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(int) - Constructor for class org.apache.commons.io.filefilter.AndFileFilter
-
Constructs a new instance with the given initial capacity.
- AndFileFilter(ArrayList<IOFileFilter>) - Constructor for class org.apache.commons.io.filefilter.AndFileFilter
-
Constructs a new instance with the given initial list.
- 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(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 - Variable in class org.apache.commons.io.output.FileWriterWithEncoding.Builder
- append - Variable in class org.apache.commons.io.output.LockableFileWriter.Builder
- 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.UncheckedAppendableImpl
- 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.UncheckedAppendableImpl
- 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.UncheckedAppendableImpl
- append(CharSequence, int, int) - Method in class org.apache.commons.io.output.UncheckedFilterWriter
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - append(Object[], StringBuilder) - Method in class org.apache.commons.io.filefilter.AbstractFileFilter
- append(List<?>, StringBuilder) - Method in class org.apache.commons.io.filefilter.AbstractFileFilter
- appendable - Variable in class org.apache.commons.io.output.AppendableOutputStream
- appendable - Variable in class org.apache.commons.io.output.AppendableWriter
- appendable - Variable in class org.apache.commons.io.output.UncheckedAppendableImpl
- AppendableOutputStream<T> - 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> - 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(IOBiFunction<? super T, ? super U, ? extends R>, T, U) - Static method in class org.apache.commons.io.function.Erase
-
Delegates to the given
IOBiFunction
but erases itsIOException
for the compiler, while still throwing the exception at runtime. - 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<? super T, ? extends R>, T) - Static method in class org.apache.commons.io.function.Erase
-
Delegates to the given
IOFunction
but erases itsIOException
for the compiler, while still throwing the exception at runtime. - 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
- 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
- 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.IOSupplier
- asThis() - Method in class org.apache.commons.io.build.AbstractSupplier
-
Returns this instance typed as the proper subclass type.
- asUnaryOperator() - Method in interface org.apache.commons.io.function.IOUnaryOperator
- asyncReadComplete - Variable in class org.apache.commons.io.input.ReadAheadInputStream
- atEos - Variable in class org.apache.commons.io.input.UnixLineEndingInputStream
- atEos - Variable in class org.apache.commons.io.input.WindowsLineEndingInputStream
- atSlashCr - Variable in class org.apache.commons.io.input.UnixLineEndingInputStream
- atSlashCr - Variable in class org.apache.commons.io.input.WindowsLineEndingInputStream
- atSlashLf - Variable in class org.apache.commons.io.input.UnixLineEndingInputStream
- atSlashLf - Variable in class org.apache.commons.io.input.WindowsLineEndingInputStream
- 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
- 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
-
Return an estimate of the number of bytes remaining in the byte stream.
- available() - Method in class org.apache.commons.io.input.MemoryMappedFileInputStream
- available() - Method in class org.apache.commons.io.input.NullInputStream
-
Return the number of bytes that can be read.
- available() - Method in class org.apache.commons.io.input.ProxyInputStream
-
Invokes the delegate's
available()
method. - available() - Method in class org.apache.commons.io.input.RandomAccessFileInputStream
-
Returns 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.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
-
Returns the number of bytes that can be read (or skipped over) from this input stream.
- avoidNewlineSplitBufferSize - Variable in class org.apache.commons.io.input.ReversedLinesFileReader
B
- BASE_16 - Static variable in class org.apache.commons.io.FilenameUtils
- Basic Usage - Search tag in class org.apache.commons.io.monitor.FileAlterationObserver
- Section
- bBuf - Variable in class org.apache.commons.io.input.CharSequenceInputStream
- bBufMark - Variable in class org.apache.commons.io.input.CharSequenceInputStream
- 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.
- 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.
- BigIntegerCounter() - Constructor for class org.apache.commons.io.file.Counters.BigIntegerCounter
- bigIntegerPathCounters() - Static method in class org.apache.commons.io.file.Counters
-
Returns a new BigInteger PathCounters.
- BigIntegerPathCounters() - Constructor for class org.apache.commons.io.file.Counters.BigIntegerPathCounters
-
Constructs a new initialized instance.
- 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.
- blockingQueue - Variable in class org.apache.commons.io.input.QueueInputStream
- blockingQueue - Variable in class org.apache.commons.io.input.QueueInputStream.Builder
- blockingQueue - Variable in class org.apache.commons.io.output.QueueOutputStream
- blockSize - Variable in enum org.apache.commons.io.FileSystem
- blockSize - Variable in class org.apache.commons.io.input.ReversedLinesFileReader
- bomEncoding - Variable in exception class org.apache.commons.io.input.XmlStreamReaderException
- 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
instance. - boms - Variable in class org.apache.commons.io.input.BOMInputStream
-
BOMs are sorted from longest to shortest.
- BOMS - Static variable in class org.apache.commons.io.input.XmlStreamReader
- BoundedInputStream - Class in org.apache.commons.io.input
-
Reads bytes up to a maximum length, if its count goes above that, it stops.
- BoundedInputStream(InputStream) - Constructor for class org.apache.commons.io.input.BoundedInputStream
-
Constructs a new
BoundedInputStream
that wraps the given input stream and is unlimited. - BoundedInputStream(InputStream, long) - Constructor for class org.apache.commons.io.input.BoundedInputStream
-
Constructs a new
BoundedInputStream
that wraps the given input stream and limits it to a certain size. - 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.input.TeeInputStream
-
The output stream that will receive a copy of all bytes read from the proxied input stream.
- branch - Variable in class org.apache.commons.io.input.TeeReader
-
The writer that will receive a copy of all characters read from the proxied 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
IOException
from all theInputStream
methods where the exception is declared. - BrokenInputStream() - Constructor for class org.apache.commons.io.input.BrokenInputStream
-
Creates a new stream that always throws an
IOException
. - BrokenInputStream(IOException) - Constructor for class org.apache.commons.io.input.BrokenInputStream
-
Creates a new stream that always throws the given exception.
- BrokenInputStream(Supplier<IOException>) - Constructor for class org.apache.commons.io.input.BrokenInputStream
-
Creates a new stream that always throws an
IOException
. - BrokenOutputStream - Class in org.apache.commons.io.output
-
Broken output stream.
- BrokenOutputStream() - Constructor for class org.apache.commons.io.output.BrokenOutputStream
-
Creates a new stream that always throws an
IOException
. - BrokenOutputStream(IOException) - Constructor for class org.apache.commons.io.output.BrokenOutputStream
-
Creates a new stream that always throws the given exception.
- BrokenOutputStream(Supplier<IOException>) - Constructor for class org.apache.commons.io.output.BrokenOutputStream
-
Creates a new stream that always throws an
IOException
. - BrokenReader - Class in org.apache.commons.io.input
-
Always throws an
IOException
from all theReader
methods where the exception is declared. - BrokenReader() - Constructor for class org.apache.commons.io.input.BrokenReader
-
Creates a new reader that always throws an
IOException
. - BrokenReader(IOException) - Constructor for class org.apache.commons.io.input.BrokenReader
-
Creates a new reader that always throws the given exception.
- BrokenReader(Supplier<IOException>) - Constructor for class org.apache.commons.io.input.BrokenReader
-
Creates a new reader that always throws an
IOException
- BrokenWriter - Class in org.apache.commons.io.output
-
Always throws an
IOException
from allWriter
methods. - BrokenWriter() - Constructor for class org.apache.commons.io.output.BrokenWriter
-
Creates a new writer that always throws an
IOException
. - BrokenWriter(IOException) - Constructor for class org.apache.commons.io.output.BrokenWriter
-
Creates a new writer that always throws the given exception.
- BrokenWriter(Supplier<IOException>) - Constructor for class org.apache.commons.io.output.BrokenWriter
-
Creates a new writer that always throws an
IOException
. - buffer - Variable in class org.apache.commons.io.input.buffer.CircularBufferInputStream
-
Internal buffer.
- buffer - Variable in class org.apache.commons.io.input.buffer.CircularByteBuffer
- buffer - Variable in class org.apache.commons.io.input.MemoryMappedFileInputStream
- 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. - BUFFER_SIZE - Static variable in class org.apache.commons.io.output.WriterOutputStream
- BUFFER_SIZE - Static variable in class org.apache.commons.io.output.XmlStreamWriter
- 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
instance. - bufferedReader - Variable in class org.apache.commons.io.LineIterator
-
The reader that is being read.
- buffers - Variable in class org.apache.commons.io.output.AbstractByteArrayOutputStream
-
The list of buffers, which grows and never reduces.
- bufferSize - Variable in class org.apache.commons.io.build.AbstractStreamBuilder
-
The buffer size, defaults to
IOUtils.DEFAULT_BUFFER_SIZE
(8192). - bufferSize - Variable in class org.apache.commons.io.input.buffer.CircularBufferInputStream
-
Internal buffer size.
- bufferSize - Variable in class org.apache.commons.io.input.MemoryMappedFileInputStream
- bufferSizeDefault - Variable in class org.apache.commons.io.build.AbstractStreamBuilder
-
The buffer size, defaults to
IOUtils.DEFAULT_BUFFER_SIZE
(8192). - builder - Variable in class org.apache.commons.io.output.StringBuilderWriter
- 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.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.MemoryMappedFileInputStream
-
Constructs a new
MemoryMappedFileInputStream.Builder
. - builder() - Static method in class org.apache.commons.io.input.MessageDigestCalculatingInputStream
-
Constructs a new
MessageDigestCalculatingInputStream.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.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.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.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() - 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.BufferedFileChannelInputStream.Builder
- Builder() - Constructor for class org.apache.commons.io.input.CharSequenceInputStream.Builder
- Builder() - Constructor for class org.apache.commons.io.input.MemoryMappedFileInputStream.Builder
- Builder() - Constructor for class org.apache.commons.io.input.MessageDigestCalculatingInputStream.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
- Builder() - Constructor for class org.apache.commons.io.input.Tailer.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
- Builder() - Constructor for class org.apache.commons.io.output.FileWriterWithEncoding.Builder
- Builder() - Constructor for class org.apache.commons.io.output.LockableFileWriter.Builder
- 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
- Builder() - Constructor for class org.apache.commons.io.output.XmlStreamWriter.Builder
- BYTE_ARRAY_1 - Static variable in class org.apache.commons.io.input.ReadAheadInputStream
- 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
-
Creates a new byte array output stream.
- ByteArrayOutputStream(int) - Constructor for class org.apache.commons.io.output.ByteArrayOutputStream
-
Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.
- byteBuffer - Variable in class org.apache.commons.io.input.BufferedFileChannelInputStream
- ByteBufferCleaner - Class in org.apache.commons.io.input
-
Cleans a direct
ByteBuffer
. - ByteBufferCleaner() - Constructor for class org.apache.commons.io.input.ByteBufferCleaner
- ByteBufferCleaner.Cleaner - Interface in org.apache.commons.io.input
- ByteBufferCleaner.Java8Cleaner - Class in org.apache.commons.io.input
- ByteBufferCleaner.Java9Cleaner - Class in org.apache.commons.io.input
- byteCount - Variable in class org.apache.commons.io.input.CircularInputStream
- byteCounter - Variable in class org.apache.commons.io.file.Counters.AbstractPathCounters
- 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.
- byteDecrement - Variable in class org.apache.commons.io.input.ReversedLinesFileReader
- byteOffset - Variable in class org.apache.commons.io.filefilter.MagicNumberFileFilter
-
The offset (in bytes) within the files that the magic number's bytes should appear.
- byteOrderMark - Variable in class org.apache.commons.io.input.BOMInputStream
- 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.
- ByteOrderMarkLengthComparator - Static variable in class org.apache.commons.io.input.BOMInputStream
-
Compares ByteOrderMark objects in descending length order.
- byteOrderMarks - Variable in class org.apache.commons.io.input.BOMInputStream.Builder
- ByteOrderParser - Class in org.apache.commons.io
-
Converts Strings to
ByteOrder
instances. - ByteOrderParser() - Constructor for class org.apache.commons.io.ByteOrderParser
-
ByteOrderUtils is a static utility class, so prevent construction with a private constructor.
- bytes - Variable in class org.apache.commons.io.ByteOrderMark
C
- 1. Create a TailerListener implementation - Search tag in class org.apache.commons.io.input.Tailer
- Section
- 3. Cancellation - Search tag in class org.apache.commons.io.DirectoryWalker
- Section
- cachedLine - Variable in class org.apache.commons.io.LineIterator
-
The current line.
- calculateHttpEncoding(String, String, String, String, boolean) - Method in class org.apache.commons.io.input.XmlStreamReader
-
Calculates the HTTP encoding.
- calculateRawEncoding(String, String, String) - Method in class org.apache.commons.io.input.XmlStreamReader
-
Calculate the raw encoding.
- 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 class 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 class 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.
- casePreserving - Variable in enum org.apache.commons.io.FileSystem
- caseSensitive - Variable in enum org.apache.commons.io.FileSystem
- causeList - Variable in exception class org.apache.commons.io.IOExceptionList
- cBuf - Variable in class org.apache.commons.io.input.CharSequenceInputStream
- cBufMark - Variable in class org.apache.commons.io.input.CharSequenceInputStream
- channel - Variable in class org.apache.commons.io.input.MemoryMappedFileInputStream
- channel - Variable in class org.apache.commons.io.input.ReversedLinesFileReader
- 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
- characteristics() - Method in class org.apache.commons.io.function.UncheckedIOSpliterator
- 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.
- charArray() - Static method in class org.apache.commons.io.IOUtils
-
Returns a new char array of size
IOUtils.DEFAULT_BUFFER_SIZE
. - charArray(int) - Static method in class org.apache.commons.io.IOUtils
-
Returns a new char array of the given size.
- charSequence - Variable in class org.apache.commons.io.input.CharSequenceReader
- CharSequenceInputStream - Class in org.apache.commons.io.input
-
Implements an
InputStream
to read from String, StringBuffer, StringBuilder or CharBuffer. - CharSequenceInputStream(CharSequence, int, CharsetEncoder) - Constructor for class org.apache.commons.io.input.CharSequenceInputStream
- 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
instance. - 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.
- charset - Variable in class org.apache.commons.io.build.AbstractStreamBuilder
-
The Charset, defaults to
Charset.defaultCharset()
. - charset - Variable in class org.apache.commons.io.input.ReversedLinesFileReader
- charset - Variable in class org.apache.commons.io.input.Tailer
-
The character set that will be used to read the file.
- charset - Variable in class org.apache.commons.io.output.XmlStreamWriter
- CHARSET_PATTERN - Static variable in class org.apache.commons.io.input.XmlStreamReader
- charsetDecoder - Variable in class org.apache.commons.io.output.WriterOutputStream.Builder
- CharsetDecoders - Class in org.apache.commons.io.charset
-
Works with
CharsetDecoder
. - CharsetDecoders() - Constructor for class org.apache.commons.io.charset.CharsetDecoders
-
No instances.
- charsetDefault - Variable in class org.apache.commons.io.build.AbstractStreamBuilder
-
The Charset, defaults to
Charset.defaultCharset()
. - charsetEncoder - Variable in class org.apache.commons.io.input.CharSequenceInputStream.Builder
- charsetEncoder - Variable in class org.apache.commons.io.input.CharSequenceInputStream
- charsetEncoder - Variable in class org.apache.commons.io.input.ReaderInputStream.Builder
- charsetEncoder - Variable in class org.apache.commons.io.input.ReaderInputStream
- charsetEncoder - Variable in class org.apache.commons.io.output.FileWriterWithEncoding.Builder
- CharsetEncoders - Class in org.apache.commons.io.charset
-
Works with
CharsetEncoder
. - CharsetEncoders() - Constructor for class org.apache.commons.io.charset.CharsetEncoders
-
No instances.
- charsetName - Variable in class org.apache.commons.io.ByteOrderMark
- 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
- charsRead - Variable in class org.apache.commons.io.input.BoundedReader
- checkAndNotify() - Method in class org.apache.commons.io.monitor.FileAlterationObserver
-
Checks whether the file and its children have been created, modified or deleted.
- checkAndNotify(FileEntry, FileEntry[], File[]) - Method in class org.apache.commons.io.monitor.FileAlterationObserver
-
Compares two file lists for files which have been created, modified or deleted.
- checkBufferSize(int) - Static method in class org.apache.commons.io.output.DeferredFileOutputStream
- 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 class 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.
- checkIbmJdkWithBrokenUTF16(Charset) - Static method in class org.apache.commons.io.output.WriterOutputStream
-
Checks if the JDK in use properly supports the given charset.
- 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.
- checkMinBufferSize(CharsetEncoder, int) - Static method in class org.apache.commons.io.input.ReaderInputStream
- checkOrigin() - Method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Checks whether the origin is null.
- checkReadException() - Method in class org.apache.commons.io.input.ReadAheadInputStream
- 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.
- 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.
- children - Variable in class org.apache.commons.io.monitor.FileEntry
- 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
instance. - 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
-
Creates 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
-
Creates a new writer that uses the specified chunk size.
- chunkSize - Variable in class org.apache.commons.io.output.ChunkedOutputStream
-
The maximum chunk size to us when writing data arrays
- chunkSize - Variable in class org.apache.commons.io.output.ChunkedWriter
-
The maximum chunk size to us when writing data arrays
- 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
-
Creates 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
-
Creates 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
-
Creates 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
-
Creates 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
-
Creates an instance from the specified array of bytes.
- classesSet - Variable in class org.apache.commons.io.serialization.FullClassNameMatcher
- classLoader - Variable in class org.apache.commons.io.input.ClassLoaderObjectInputStream
-
The class loader to use.
- 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.
- clean(ByteBuffer) - Method in class org.apache.commons.io.input.BufferedFileChannelInputStream
-
Attempts to clean up a ByteBuffer if it is direct or memory-mapped.
- clean(ByteBuffer) - Static method in class org.apache.commons.io.input.ByteBufferCleaner
-
Releases memory held by the given
ByteBuffer
. - clean(ByteBuffer) - Method in interface org.apache.commons.io.input.ByteBufferCleaner.Cleaner
- clean(ByteBuffer) - Method in class org.apache.commons.io.input.ByteBufferCleaner.Java8Cleaner
- clean(ByteBuffer) - Method in class org.apache.commons.io.input.ByteBufferCleaner.Java9Cleaner
- cleanBuffer() - Method in class org.apache.commons.io.input.MemoryMappedFileInputStream
- cleanDirectBuffer(ByteBuffer) - Method in class org.apache.commons.io.input.BufferedFileChannelInputStream
-
In Java 8, the type of
sun.nio.ch.DirectBuffer.cleaner()
wassun.misc.Cleaner
, and it was possible to access the methodsun.misc.Cleaner.clean()
to invoke it. - 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 including subdirectories without deleting directories.
- cleanDirectory(Path, DeleteOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Cleans a directory including subdirectories without deleting directories.
- cleanDirectoryOnExit(File) - Static method in class org.apache.commons.io.FileUtils
-
Cleans a directory without deleting it.
- cleanerMethod - Variable in class org.apache.commons.io.input.ByteBufferCleaner.Java8Cleaner
- 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 visitor 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 new visitor that deletes files except for the files and directories explicitly given.
- cleanMethod - Variable in class org.apache.commons.io.input.ByteBufferCleaner.Java8Cleaner
- clear() - Method in class org.apache.commons.io.input.buffer.CircularByteBuffer
-
Removes all bytes from the buffer.
- clear() - Static method in class org.apache.commons.io.IO
-
Clears any state, throughout Apache Commons IO.
- clear() - Static method in class org.apache.commons.io.IOUtils
-
Clears any state.
- close() - Method in class org.apache.commons.io.CloseableURLConnection
- close() - Method in interface org.apache.commons.io.function.IOBaseStream
-
Like
BaseStream.close()
. - close() - Method in class org.apache.commons.io.function.UncheckedIOBaseStream
- 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.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
-
Close this input stream - resets the internal state to the initial values.
- 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
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.Tailer.RandomAccessFileBridge
- 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.UnsynchronizedFilterInputStream
-
Closes this stream.
- 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.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.
- CloseableURLConnection - Class in org.apache.commons.io
-
Delegates to a URLConnection while implementing AutoCloseable.
- CloseableURLConnection(URLConnection) - Constructor for class org.apache.commons.io.CloseableURLConnection
- closeBranch - Variable in class org.apache.commons.io.input.TeeInputStream
-
Flag for closing the associated output stream when this stream is closed.
- closeBranch - Variable in class org.apache.commons.io.input.TeeReader
-
Flag for closing the associated writer when this reader is closed.
- closed - Variable in class org.apache.commons.io.input.MemoryMappedFileInputStream
- closed - Variable in class org.apache.commons.io.output.DeferredFileOutputStream
-
True when close() has been called successfully.
- 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 the 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
- closeInstant - Variable in class org.apache.commons.io.input.TimestampedObserver
- closeOnClose - Variable in class org.apache.commons.io.input.RandomAccessFileInputStream.Builder
- closeOnClose - Variable in class org.apache.commons.io.input.RandomAccessFileInputStream
- closeQ(Closeable) - Static method in class org.apache.commons.io.IOUtils
-
Avoids the need to type cast.
- 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. - closeUnderlyingInputStreamIfNecessary() - Method in class org.apache.commons.io.input.ReadAheadInputStream
- collect(Collector<? super T, A, R>) - Method in interface org.apache.commons.io.function.IOStream
-
TODO Package-private for now, needs IOCollector? Adding this method now and an IO version later is an issue because call sites would have to type-cast to pick one.
- collect(IOSupplier<R>, IOBiConsumer<R, ? super T>, IOBiConsumer<R, R>) - Method in interface org.apache.commons.io.function.IOStream
- comparator - Variable in class org.apache.commons.io.monitor.FileAlterationObserver
- 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.ReverseFileComparator
-
Compares using the delegate Comparator, reversing the result.
- compare(File, File) - Method in class org.apache.commons.io.comparator.SizeFileComparator
-
Compares the length of two files.
- compare(IOComparator<? super T>, T, T) - Static method in class org.apache.commons.io.function.Erase
-
Delegates to the given
IOComparator
but erases itsIOException
for the compiler, while still throwing the exception at runtime. - 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
. - compareLastModifiedTimeTo(Path, FileTime, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Compares the given
Path
's last modified time to the given file time. - compareTo(FileTime) - Method in class org.apache.commons.io.monitor.SerializableFileTime
- compile(String, int) - Static method in class org.apache.commons.io.filefilter.RegexFileFilter
-
Compiles the given pattern source.
- 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. - Composite Comparator - Search tag in package org.apache.commons.io.comparator
- Section
- 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.
- connect() - Method in class org.apache.commons.io.CloseableURLConnection
- Constants - Class in org.apache.commons.io.function
-
Defines package-private constants.
- Constants() - Constructor for class org.apache.commons.io.function.Constants
- 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(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(Iterator<?>, Iterator<?>) - Static method in class org.apache.commons.io.IOUtils
- contentEquals(Stream<?>, Stream<?>) - Static method in class org.apache.commons.io.IOUtils
- contentEqualsIgnoreEOL(BufferedReader, BufferedReader) - Static method in class org.apache.commons.io.IOUtils
- 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.
- contentTypeEncoding - Variable in exception class org.apache.commons.io.input.XmlStreamReaderException
- contentTypeMime - Variable in exception class org.apache.commons.io.input.XmlStreamReaderException
- convertFileCollectionToFileArray(Collection<File>) - Static method in class org.apache.commons.io.FileUtils
-
Converts a Collection containing java.io.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.2.5 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.2.5 use
CopyUtils.copy(InputStream, Writer, String)
instead - copy(InputStream, Writer) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.2.5 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.2.5 use
CopyUtils.copy(Reader, OutputStream, String)
instead - copy(Reader, OutputStream) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.2.5 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.2.5 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 new visitor 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 new visitor 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 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. - copyOptions - Variable in class org.apache.commons.io.file.CopyDirectoryVisitor
- 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.Instances should NOT be constructed in standard programming.
- count - Variable in class org.apache.commons.io.input.BoundedInputStream
-
The count of bytes read.
- count - Variable in class org.apache.commons.io.input.CountingInputStream
-
The count of bytes that have passed.
- count - Variable in class org.apache.commons.io.input.UnsynchronizedBufferedInputStream
-
The total number of bytes inside the byte array
buf
. - count - Variable in class org.apache.commons.io.output.AbstractByteArrayOutputStream
-
The total count of bytes written.
- count - Variable in class org.apache.commons.io.output.CountingOutputStream
-
The count of bytes that have passed.
- 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.AbstractPathCounters - Class in org.apache.commons.io.file
-
Counts files, directories, and sizes, as a visit proceeds.
- Counters.BigIntegerCounter - Class in org.apache.commons.io.file
-
Counts using a
BigInteger
number. - Counters.BigIntegerPathCounters - Class in org.apache.commons.io.file
-
Counts files, directories, and sizes, as a visit proceeds, using BigInteger numbers.
- Counters.Counter - Interface in org.apache.commons.io.file
-
Counts using a number.
- Counters.LongCounter - Class in org.apache.commons.io.file
-
Counts using a
long
number. - Counters.LongPathCounters - Class in org.apache.commons.io.file
-
Counts files, directories, and sizes, as a visit proceeds, using long numbers.
- Counters.NoopCounter - Class in org.apache.commons.io.file
-
Counts nothing.
- Counters.NoopPathCounters - Class in org.apache.commons.io.file
-
Counts nothing.
- 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
-
A decorating input stream that counts the number of bytes that have passed through the stream so far.
- CountingInputStream(InputStream) - Constructor for class org.apache.commons.io.input.CountingInputStream
-
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.
- create(File) - Method in enum org.apache.commons.io.RandomAccessFileMode
-
Creates a random access file stream 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(Object) - Static method in class org.apache.commons.io.UncheckedIOExceptions
-
Creates a new UncheckedIOException for the given detail message.
- create(String) - Method in enum org.apache.commons.io.RandomAccessFileMode
-
Creates a random access file stream 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
-
Creates a random access file stream 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
. - createFileEntry(FileEntry, File) - Method in class org.apache.commons.io.monitor.FileAlterationObserver
-
Creates a new file entry for the specified file.
- createLeftOver() - Method in class org.apache.commons.io.input.ReversedLinesFileReader.FilePart
-
Creates the buffer containing any leftover bytes.
- createLink(Path, Path) - Static method in class org.apache.commons.io.file.FilesUncheck
- createLock() - Method in class org.apache.commons.io.output.LockableFileWriter
-
Creates the lock file.
- createParentDirectories(File) - Static method in class org.apache.commons.io.FileUtils
-
Creates all parent directories for a File object, including any necessary but nonexistent 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 enum org.apache.commons.io.FileSystem
-
Gets the current file system.
- current() - Static method in class org.apache.commons.io.FileUtils
-
Gets the current directory.
- CURRENT - Static variable in enum org.apache.commons.io.FileSystem
-
The current FileSystem.
- currentBuffer - Variable in class org.apache.commons.io.output.AbstractByteArrayOutputStream
-
The current buffer.
- currentBufferIndex - Variable in class org.apache.commons.io.output.AbstractByteArrayOutputStream
-
The index of the current buffer.
- currentFilePart - Variable in class org.apache.commons.io.input.ReversedLinesFileReader
- currentLastBytePos - Variable in class org.apache.commons.io.input.ReversedLinesFileReader.FilePart
- currentNumberOfBytes - Variable in class org.apache.commons.io.input.buffer.CircularByteBuffer
- currentOutputStream - Variable in class org.apache.commons.io.output.DeferredFileOutputStream
-
The output stream to which data will be written at any given time.
- Custom Implementations - Search tag in class org.apache.commons.io.monitor.FileEntry
- Section
- cutoffInstant - Variable in class org.apache.commons.io.filefilter.AgeFileFilter
-
The cutoff time threshold measured in milliseconds since the epoch (00:00:00 GMT, January 1, 1970).
- CVS_FILTER - Static variable in class org.apache.commons.io.filefilter.FileFilterUtils
D
- data - Variable in class org.apache.commons.io.input.ReversedLinesFileReader.FilePart
- data - Variable in class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream
-
The underlying data buffer.
- data(byte[], int, int) - Method in class org.apache.commons.io.input.MessageDigestCalculatingInputStream.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
- 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. - decoder - Variable in class org.apache.commons.io.output.WriterOutputStream
- decoderIn - Variable in class org.apache.commons.io.output.WriterOutputStream
-
ByteBuffer used as input for the decoder.
- decoderOut - Variable in class org.apache.commons.io.output.WriterOutputStream
-
CharBuffer used as output for the decoder.
- decodeUrl(String) - Static method in class org.apache.commons.io.FileUtils
-
Decodes the specified URL as per RFC 3986, i.e.
- DEFAULT - Static variable in class org.apache.commons.io.input.BOMInputStream.Builder
- DEFAULT_ALGORITHM - Static variable in class org.apache.commons.io.input.MessageDigestCalculatingInputStream
-
The default message digest algorithm.
- DEFAULT_BLOCK_SIZE - Static variable in class org.apache.commons.io.input.ReversedLinesFileReader
- DEFAULT_BUFFER_SIZE - Static variable in class org.apache.commons.io.input.MemoryMappedFileInputStream
-
Default size of the sliding memory mapped buffer.
- DEFAULT_BUFFER_SIZE - Static variable in class org.apache.commons.io.IOUtils
-
The default buffer size (8192) to use in copy methods.
- DEFAULT_CHARSET - Static variable in class org.apache.commons.io.input.Tailer
- DEFAULT_CHUNK_SIZE - Static variable in class org.apache.commons.io.output.ChunkedWriter
-
The default chunk size to use, i.e.
- DEFAULT_COMPARATOR - Static variable in class org.apache.commons.io.comparator.DefaultFileComparator
-
Singleton default comparator instance
- DEFAULT_DELAY_DURATION - Static variable in class org.apache.commons.io.input.Tailer.Builder
- DEFAULT_DELAY_MILLIS - Static variable in class org.apache.commons.io.input.Tailer
- DEFAULT_OPEN_OPTIONS - Static variable in class org.apache.commons.io.build.AbstractStreamBuilder
- DEFAULT_REVERSE - Static variable in class org.apache.commons.io.comparator.DefaultFileComparator
-
Singleton reverse default comparator instance
- DEFAULT_SIZE - Static variable in class org.apache.commons.io.output.AbstractByteArrayOutputStream
- defaultCharset - Variable in class org.apache.commons.io.output.XmlStreamWriter
- defaultDirFilter() - Static method in class org.apache.commons.io.file.CountingPathVisitor
- defaultEncoding - Variable in class org.apache.commons.io.input.XmlStreamReader
- 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
- defaultFileFilter() - Static method in class org.apache.commons.io.file.CountingPathVisitor
- 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, File, String, String, File, int) - Constructor for class org.apache.commons.io.output.DeferredFileOutputStream
-
Constructs an instance of this class which will trigger an event at the specified threshold, and save data either to a file beyond that point.
- 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
instance. - delayDuration - Variable in class org.apache.commons.io.input.Tailer.Builder
- delayDuration - Variable in class org.apache.commons.io.input.Tailer
-
The amount of time to wait for the file to be updated.
- delegate - Variable in class org.apache.commons.io.comparator.ReverseFileComparator
- delegate - Variable in class org.apache.commons.io.function.IOBaseStreamAdapter
-
The underlying base stream.
- delegate - Variable in class org.apache.commons.io.function.IOIteratorAdapter
- delegate - Variable in class org.apache.commons.io.function.IOSpliteratorAdapter
- delegate - Variable in class org.apache.commons.io.function.UncheckedIOBaseStream
- delegate - Variable in class org.apache.commons.io.function.UncheckedIOIterator
- delegate - Variable in class org.apache.commons.io.function.UncheckedIOSpliterator
- 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.
- delegates - Variable in class org.apache.commons.io.comparator.CompositeFileComparator
- delete() - Method in class org.apache.commons.io.FileCleaningTracker.Tracker
-
Deletes the file associated with this tracker instance.
- 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.
- deleteDirectoryOnExit(File) - Static method in class org.apache.commons.io.FileUtils
-
Schedules a directory recursively for deletion on JVM exit.
- deleteFailures - Variable in class org.apache.commons.io.FileCleaningTracker
-
Collection of File paths that failed to delete.
- 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.
- deleteStrategy - Variable in class org.apache.commons.io.FileCleaningTracker.Tracker
-
The strategy for deleting files.
- 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 new visitor 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 new visitor 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 new visitor 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
- Deprecating Serialization - Search tag in class org.apache.commons.io.ByteOrderMark
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.comparator.CompositeFileComparator
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.comparator.DefaultFileComparator
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.comparator.DirectoryFileComparator
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.comparator.ExtensionFileComparator
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.comparator.LastModifiedFileComparator
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.comparator.NameFileComparator
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.comparator.PathFileComparator
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.comparator.ReverseFileComparator
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.comparator.SizeFileComparator
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.filefilter.AgeFileFilter
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.filefilter.AndFileFilter
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.filefilter.CanExecuteFileFilter
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.filefilter.CanReadFileFilter
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.filefilter.CanWriteFileFilter
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.filefilter.DelegateFileFilter
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.filefilter.DirectoryFileFilter
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.filefilter.EmptyFileFilter
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.filefilter.FalseFileFilter
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.filefilter.FileFileFilter
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.filefilter.HiddenFileFilter
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.filefilter.MagicNumberFileFilter
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.filefilter.MagicNumberFileFilter
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.filefilter.NameFileFilter
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.filefilter.NotFileFilter
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.filefilter.OrFileFilter
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.filefilter.PrefixFileFilter
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.filefilter.RegexFileFilter
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.filefilter.SizeFileFilter
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.filefilter.SuffixFileFilter
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.filefilter.SymbolicLinkFileFilter
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.filefilter.TrueFileFilter
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.filefilter.WildcardFileFilter
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.filefilter.WildcardFilter
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.input.CharSequenceReader
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.input.TaggedInputStream
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.input.TaggedReader
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.monitor.FileAlterationObserver
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.monitor.FileEntry
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.monitor.SerializableFileTime
- Section
- Deprecating Serialization - Search tag in class org.apache.commons.io.output.StringBuilderWriter
- Section
- depth - Variable in exception class org.apache.commons.io.DirectoryWalker.CancelException
-
Deprecated.The file depth when the exception was thrown.
- depthLimit - Variable in class org.apache.commons.io.DirectoryWalker
-
Deprecated.The limit on the directory depth to walk.
- destroy() - Method in class org.apache.commons.io.monitor.FileAlterationObserver
-
Final processing.
- detectEncoding(char[], int, int) - Method in class org.apache.commons.io.output.XmlStreamWriter
-
Detects the encoding.
- DF - Static variable in class org.apache.commons.io.FileSystemUtils
-
Deprecated.The path to df
- 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 - Variable in class org.apache.commons.io.monitor.FileEntry
- directory - Variable in class org.apache.commons.io.output.DeferredFileOutputStream.Builder
- directory - Variable in class org.apache.commons.io.output.DeferredFileOutputStream
-
The directory to use for temporary files.
- 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
element (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.
- directoryCounter - Variable in class org.apache.commons.io.file.Counters.AbstractPathCounters
- 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 Class in org.apache.commons.io
-
Deprecated.CancelException is thrown in DirectoryWalker to cancel the current processing.
- dirFilter - Variable in class org.apache.commons.io.file.CountingPathVisitor
- dirList - Variable in class org.apache.commons.io.file.AccumulatorPathVisitor
- distinct() - Method in interface org.apache.commons.io.function.IOStream
-
Like
Stream.distinct()
. - doCopyDirectory(File, File, FileFilter, List<String>, boolean, CopyOption...) - Static method in class org.apache.commons.io.FileUtils
-
Internal copy directory method.
- doCreate(FileEntry) - Method in class org.apache.commons.io.monitor.FileAlterationObserver
-
Fires directory/file created events to the registered listeners.
- doDelete(File) - Method in class org.apache.commons.io.FileDeleteStrategy
-
Actually deletes the file object, which may be a file or a directory.
- doDelete(File) - Method in class org.apache.commons.io.FileDeleteStrategy.ForceFileDeleteStrategy
-
Deletes the file object.
- doDelete(FileEntry) - Method in class org.apache.commons.io.monitor.FileAlterationObserver
-
Fires directory/file delete events to the registered listeners.
- doEndOfFile() - Method in class org.apache.commons.io.input.NullInputStream
-
Handle End of File.
- doEndOfFile() - Method in class org.apache.commons.io.input.NullReader
-
Handles End of File.
- doGetFullPath(String, boolean) - Static method in class org.apache.commons.io.FilenameUtils
-
Does the work of getting the path.
- doGetPath(String, int) - Static method in class org.apache.commons.io.FilenameUtils
-
Does the work of getting the path.
- doLenientDetection(String, XmlStreamReaderException) - Method in class org.apache.commons.io.input.XmlStreamReader
-
Does lenient detection.
- doListFiles(File, FileEntry) - Method in class org.apache.commons.io.monitor.FileAlterationObserver
-
Lists the files
- doMatch(FileEntry, File) - Method in class org.apache.commons.io.monitor.FileAlterationObserver
-
Fires directory/file change events to the registered listeners.
- doNormalize(String, char, boolean) - Static method in class org.apache.commons.io.FilenameUtils
-
Internal method to perform the normalization.
- doRawStream(BOMInputStream, BOMInputStream, boolean) - Method in class org.apache.commons.io.input.XmlStreamReader
-
Process the raw stream.
- 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.
- dump(StringBuilder, byte) - Static method in class org.apache.commons.io.HexDump
-
Dumps a byte value into a StringBuilder.
- dump(StringBuilder, long) - Static method in class org.apache.commons.io.HexDump
-
Dumps a long value into a StringBuilder.
E
- 1. Example Implementation - Search tag in class org.apache.commons.io.DirectoryWalker
- Section
- 3.1 External / Multi-threaded - Search tag in class org.apache.commons.io.DirectoryWalker
- Section
- EBCDIC - Static variable in class org.apache.commons.io.input.XmlStreamReader
- 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_ARRAY - Static variable in class org.apache.commons.io.monitor.FileAlterationMonitor
- EMPTY_BUFFER - Static variable in class org.apache.commons.io.input.MemoryMappedFileInputStream
- EMPTY_BYTE_ARRAY - Static variable in class org.apache.commons.io.IOUtils
-
A singleton empty byte array.
- EMPTY_COMPARATOR_ARRAY - Static variable in class org.apache.commons.io.comparator.CompositeFileComparator
- 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_ENTRY_ARRAY - Static variable in class org.apache.commons.io.monitor.FileEntry
- 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 - Static variable in class org.apache.commons.io.FilenameUtils
- EMPTY_STRING - Static variable in class org.apache.commons.io.input.ReversedLinesFileReader
- EMPTY_STRING_ARRAY - Static variable in class org.apache.commons.io.file.CountingPathVisitor
- EMPTY_STRING_ARRAY - Static variable in interface org.apache.commons.io.filefilter.IOFileFilter
-
An empty String array.
- EMPTY_STRING_ARRAY - Static variable in class org.apache.commons.io.FilenameUtils
- EMPTY_WRITERS - Variable in class org.apache.commons.io.output.FilterCollectionWriter
-
Empty and immutable collection of writers.
- emptyArray() - Method in class org.apache.commons.io.comparator.CompositeFileComparator
- 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.
- encoderIn - Variable in class org.apache.commons.io.input.ReaderInputStream
-
CharBuffer used as input for the decoder.
- encoderOut - Variable in class org.apache.commons.io.input.ReaderInputStream
-
ByteBuffer used as output for the decoder.
- encoding - Variable in class org.apache.commons.io.input.XmlStreamReader
- ENCODING_PATTERN - Static variable in class org.apache.commons.io.input.XmlStreamReader
-
Pattern capturing the encoding of the "xml" processing instruction.
- end - Variable in class org.apache.commons.io.input.CharSequenceReader
-
The end index in the character sequence, exclusive.
- end - Variable in class org.apache.commons.io.input.Tailer.Builder
- end() - Method in class org.apache.commons.io.input.CharSequenceReader
-
Returns the index in the character sequence to end reading at, taking into account its length.
- 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 different endian systems.
- EndianUtils() - Constructor for class org.apache.commons.io.EndianUtils
-
Instances should NOT be constructed in standard programming.
- endOfFileReached() - Method in class org.apache.commons.io.input.TailerListenerAdapter
-
Called each time the Tailer reaches the end of the file.
- endOffset - Variable in class org.apache.commons.io.input.buffer.CircularByteBuffer
- endOfInput - Variable in class org.apache.commons.io.input.ReaderInputStream
- endOfStream - Variable in class org.apache.commons.io.input.ReadAheadInputStream
- ensureOpen() - Method in class org.apache.commons.io.input.MemoryMappedFileInputStream
- eod - Variable in class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream
-
End Of Data.
- eof - Variable in class org.apache.commons.io.input.buffer.CircularBufferInputStream
-
Whether we've seen the input stream EOF.
- eof - Variable in class org.apache.commons.io.input.NullInputStream
- eof - Variable in class org.apache.commons.io.input.NullReader
- EOF - Static variable in class org.apache.commons.io.IOUtils
-
Represents the end-of-file (or stream).
- 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. - EPOCH - Static variable in class org.apache.commons.io.monitor.SerializableFileTime
- equals - Variable in class org.apache.commons.io.file.PathUtils.RelativeSortedPaths
- 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.CloseableURLConnection
- 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.Counters.AbstractPathCounters
- equals(Object) - Method in class org.apache.commons.io.file.Counters.BigIntegerCounter
- equals(Object) - Method in class org.apache.commons.io.file.Counters.LongCounter
- equals(Object) - Method in class org.apache.commons.io.file.CountingPathVisitor
- equals(Object) - Method in class org.apache.commons.io.file.DeletingPathVisitor
- equals(Object) - Method in class org.apache.commons.io.monitor.SerializableFileTime
- equals(String, String) - Static method in class org.apache.commons.io.FilenameUtils
-
Checks whether two fileNames are equal exactly.
- equals(String, String, boolean, IOCase) - Static method in class org.apache.commons.io.FilenameUtils
-
Checks whether two fileNames 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 fileNames are equal after both have been normalized.
- equalsNormalizedOnSystem(String, String) - Static method in class org.apache.commons.io.FilenameUtils
-
Checks whether two fileNames are equal after both have been normalized and using the case rules of the system.
- equalsOnSystem(String, String) - Static method in class org.apache.commons.io.FilenameUtils
-
Checks whether two fileNames 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. - Erase() - Constructor for class org.apache.commons.io.function.Erase
-
No instances.
- 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
- estimateSize() - Method in class org.apache.commons.io.function.UncheckedIOSpliterator
- Example - Search tag in class org.apache.commons.io.file.AccumulatorPathVisitor
- Section
- Example 1 - Detecting and excluding a UTF-8 BOM - Search tag in class org.apache.commons.io.input.BOMInputStream
- Section
- Example 2 - Detecting a UTF-8 BOM without excluding it - Search tag in class org.apache.commons.io.input.BOMInputStream
- Section
- Example 3 - Detecting Multiple BOMs - Search tag in class org.apache.commons.io.input.BOMInputStream
- Section
- exceptionSupplier - Variable in class org.apache.commons.io.input.BrokenInputStream
-
A supplier for the exception that is thrown by all methods of this class.
- exceptionSupplier - Variable in class org.apache.commons.io.input.BrokenReader
-
A supplier for the exception that is thrown by all methods of this class.
- exceptionSupplier - Variable in class org.apache.commons.io.output.BrokenOutputStream
-
A supplier for the exception that is thrown by all methods of this class.
- exceptionSupplier - Variable in class org.apache.commons.io.output.BrokenWriter
-
A supplier for the exception that is thrown by all methods of this class.
- executorService - Variable in class org.apache.commons.io.input.ReadAheadInputStream.Builder
- executorService - Variable in class org.apache.commons.io.input.ReadAheadInputStream
- executorService - Variable in class org.apache.commons.io.input.Tailer.Builder
- exists - Variable in class org.apache.commons.io.monitor.FileEntry
- exists(Path, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
- exitWhenFinished - Variable in class org.apache.commons.io.FileCleaningTracker
-
Whether to terminate the thread when the tracking is complete.
- 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
- 2. Filter Example - Search tag in class org.apache.commons.io.DirectoryWalker
- Section
- 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.
- fbIndex - Variable in class org.apache.commons.io.input.BOMInputStream
- fbLength - Variable in class org.apache.commons.io.input.BOMInputStream
- file - Variable in exception class org.apache.commons.io.DirectoryWalker.CancelException
-
Deprecated.The file being processed when the exception was thrown.
- file - Variable in class org.apache.commons.io.filefilter.FileEqualsFileFilter
- file - Variable in class org.apache.commons.io.monitor.FileEntry
- 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
-
Constructs an observer for the specified directory.
- FileAlterationObserver(File, FileFilter) - Constructor for class org.apache.commons.io.monitor.FileAlterationObserver
-
Constructs an observer for the specified directory and file filter.
- FileAlterationObserver(File, FileFilter, IOCase) - Constructor for class org.apache.commons.io.monitor.FileAlterationObserver
-
Constructs an observer for the specified directory, file filter and file comparator.
- FileAlterationObserver(String) - Constructor for class org.apache.commons.io.monitor.FileAlterationObserver
-
Constructs an observer for the specified directory.
- FileAlterationObserver(String, FileFilter) - Constructor for class org.apache.commons.io.monitor.FileAlterationObserver
-
Constructs an observer for the specified directory and file filter.
- FileAlterationObserver(String, FileFilter, IOCase) - Constructor for class org.apache.commons.io.monitor.FileAlterationObserver
-
Constructs an observer for the specified directory, file filter and file comparator.
- 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.
- fileChannel - Variable in class org.apache.commons.io.input.BufferedFileChannelInputStream
- 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
- FileCleaningTracker.Reaper - Class in org.apache.commons.io
-
The reaper thread.
- FileCleaningTracker.Tracker - Class in org.apache.commons.io
-
Inner class which acts as the reference for a file pending deletion.
- 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.
- fileCounter - Variable in class org.apache.commons.io.file.Counters.AbstractPathCounters
- FileDeleteStrategy - Class in org.apache.commons.io
-
Strategy for deleting files.
- FileDeleteStrategy(String) - Constructor for class org.apache.commons.io.FileDeleteStrategy
-
Restricted constructor.
- FileDeleteStrategy.ForceFileDeleteStrategy - Class in org.apache.commons.io
-
Force file deletion strategy.
- FileEntry - Search tag in class org.apache.commons.io.monitor.FileAlterationObserver
- Section
- 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 Class in org.apache.commons.io
-
Indicates that a file already exists.
- FileExistsException() - Constructor for exception class org.apache.commons.io.FileExistsException
-
Default Constructor.
- FileExistsException(File) - Constructor for exception class org.apache.commons.io.FileExistsException
-
Constructs an instance with the specified file.
- FileExistsException(String) - Constructor for exception class 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.
- fileFilter - Variable in class org.apache.commons.io.file.CountingPathVisitor
- fileFilter - Variable in class org.apache.commons.io.filefilter.DelegateFileFilter
-
The File filter
- fileFilter - Variable in class org.apache.commons.io.monitor.FileAlterationObserver
- fileFilters - Variable in class org.apache.commons.io.filefilter.AndFileFilter
-
The list of file filters.
- fileFilters - Variable in class org.apache.commons.io.filefilter.OrFileFilter
-
The list of file filters.
- File Filters - Search tag in class org.apache.commons.io.monitor.FileAlterationObserver
- Section
- 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.
- fileList - Variable in class org.apache.commons.io.file.AccumulatorPathVisitor
- filenameFilter - Variable in class org.apache.commons.io.filefilter.DelegateFileFilter
-
The Filename filter
- FilenameUtils - Class in org.apache.commons.io
-
General file name and file path manipulation utilities.
- FilenameUtils() - Constructor for class org.apache.commons.io.FilenameUtils
-
Instances should NOT be constructed in standard programming.
- 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.
- FilePart(long, int, byte[]) - Constructor for class org.apache.commons.io.input.ReversedLinesFileReader.FilePart
-
Constructs a new instance.
- 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
- FilesUncheck() - Constructor for class org.apache.commons.io.file.FilesUncheck
-
No instances.
- 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)
. - FileSystem(int, boolean, boolean, int, int, int[], String[], boolean, boolean, char) - Constructor for enum org.apache.commons.io.FileSystem
-
Constructs a new instance.
- FileSystemProviders - Class in org.apache.commons.io.file.spi
-
Helps to work with
FileSystemProvider
. - FileSystemProviders(List<FileSystemProvider>) - Constructor for class org.apache.commons.io.file.spi.FileSystemProviders
- FileSystemUtils - Class in org.apache.commons.io
-
Deprecated.As of 2.6 deprecated without replacement. Use equivalent methods in
FileStore
instead, e.g.Files.getFileStore(Paths.get("/home")).getUsableSpace()
or iterate overFileSystems.getDefault().getFileStores()
- FileSystemUtils() - Constructor for class org.apache.commons.io.FileSystemUtils
-
Deprecated.Instances should NOT be constructed in standard programming.
- fileTime - Variable in class org.apache.commons.io.monitor.SerializableFileTime
- FileTimes - Class in org.apache.commons.io.file.attribute
-
Helps use
FileTime
and interoperate Date and NTFS times. - FileTimes() - Constructor for class org.apache.commons.io.file.attribute.FileTimes
- FileUtils - Class in org.apache.commons.io
-
General file manipulation utilities.
- FileUtils() - Constructor for class org.apache.commons.io.FileUtils
-
Deprecated.Will be 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(OutputStreamWriter) - 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
instance. - fill0(byte[]) - Static method in class org.apache.commons.io.IOUtils
-
Fills the given array with 0s.
- fill0(char[]) - Static method in class org.apache.commons.io.IOUtils
-
Fills the given array with 0s.
- fillBuffer() - Method in class org.apache.commons.io.input.buffer.CircularBufferInputStream
-
Fills the buffer with the contents of the input stream.
- fillBuffer() - Method in class org.apache.commons.io.input.CharSequenceInputStream
-
Fills the byte output buffer from the input char buffer.
- fillBuffer() - Method in class org.apache.commons.io.input.ReaderInputStream
-
Fills the internal char buffer from the reader.
- fillBuffer(InputStream, byte[]) - Method in class org.apache.commons.io.input.UnsynchronizedBufferedInputStream
- filledBufferSum - Variable in class org.apache.commons.io.output.AbstractByteArrayOutputStream
-
The total count of bytes in all the filled buffers.
- filter - Variable in class org.apache.commons.io.DirectoryWalker
-
Deprecated.The file filter to use to filter files and directories.
- filter - Variable in class org.apache.commons.io.filefilter.NotFileFilter
-
The filter
- 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
-
Creates a new filtered collection writer.
- FilterCollectionWriter(Collection<Writer>) - Constructor for class org.apache.commons.io.output.FilterCollectionWriter
-
Creates 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.
- filterFiles(IOFileFilter, Stream<File>, Collector<? super File, A, R>) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Applies an
IOFileFilter
to the providedFile
stream and collects the accepted files. - 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. - filterPaths(PathFilter, Stream<Path>, Collector<? super Path, A, R>) - Static method in class org.apache.commons.io.file.PathUtils
- 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() - Method in class org.apache.commons.io.input.BOMInputStream
-
Find a BOM with the specified bytes.
- 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 - Variable in class org.apache.commons.io.LineIterator
-
A flag indicating if the iterator has been fully read.
- finished() - Method in class org.apache.commons.io.input.ObservableInputStream.Observer
-
Called to indicate that EOF has been seen on the underlying stream.
- firstBytes - Variable in class org.apache.commons.io.input.BOMInputStream
- 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? Adding this method now and an IO version later is an issue because call sites would have to type-cast to pick one.
- flatMapToInt(IOFunction<? super T, ? extends IntStream>) - Method in interface org.apache.commons.io.function.IOStream
-
TODO Package-private for now, needs IOIntStream? Adding this method now and an IO version later is an issue because call sites would have to type-cast to pick one.
- flatMapToLong(IOFunction<? super T, ? extends LongStream>) - Method in interface org.apache.commons.io.function.IOStream
-
TODO Package-private for now, needs IOLongStream? Adding this method now and an IO version later is an issue because call sites would have to type-cast to pick one.
- flipSeparator(char) - Static method in class org.apache.commons.io.FilenameUtils
-
Flips the Windows name separator to Linux and vice-versa.
- 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.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.
- flushOutput() - Method in class org.apache.commons.io.output.WriterOutputStream
-
Flush the output.
- forAll(Stream<T>, IOConsumer<T>) - Static method in class org.apache.commons.io.function.IOStreams
- forAll(Stream<T>, IOConsumer<T>, BiFunction<Integer, IOException, IOException>) - Static method in class org.apache.commons.io.function.IOStreams
- 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.
- forAllWriters(IOConsumer<Writer>) - Method in class org.apache.commons.io.output.FilterCollectionWriter
- 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.
- ForceFileDeleteStrategy() - Constructor for class org.apache.commons.io.FileDeleteStrategy.ForceFileDeleteStrategy
-
Default Constructor
- forceMkdir(File) - Static method in class org.apache.commons.io.FileUtils
-
Creates all directories for a File object, including any necessary but nonexistent parent directories.
- forceMkdirParent(File) - Static method in class org.apache.commons.io.FileUtils
-
Calls
File.mkdirs()
and throws anIOException
on failure. - 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(Stream<T>, IOConsumer<T>) - Static method in class org.apache.commons.io.function.IOStreams
- 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.
- forEachObserver(IOConsumer<ObservableInputStream.Observer>) - Method in class org.apache.commons.io.input.ObservableInputStream
- forEachOrdered(IOConsumer<? super T>) - Method in interface org.apache.commons.io.function.IOStream
- forEachRemaining(Consumer<? super T>) - Method in class org.apache.commons.io.function.UncheckedIOSpliterator
- 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
-
Factory method to create an IOCase from a 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()
. - freeSpaceOS(String, int, boolean, Duration) - Method in class org.apache.commons.io.FileSystemUtils
-
Deprecated.Returns the free space on a drive or volume in a cross-platform manner.
- freeSpaceUnix(String, boolean, boolean, Duration) - Method in class org.apache.commons.io.FileSystemUtils
-
Deprecated.Find free space on the *nix platform using the 'df' command.
- freeSpaceWindows(String, Duration) - Method in class org.apache.commons.io.FileSystemUtils
-
Deprecated.Find free space on the Windows platform using the 'dir' command.
- FullClassNameMatcher - Class in org.apache.commons.io.serialization
-
A
ClassNameMatcher
that matches on full class names. - FullClassNameMatcher(String...) - Constructor for class org.apache.commons.io.serialization.FullClassNameMatcher
-
Constructs an object based on the specified class names.
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 class org.apache.commons.io.file.Counters.BigIntegerCounter
- 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.file.Counters.LongCounter
- get() - Method in class org.apache.commons.io.file.Counters.NoopCounter
- 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
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.input.BOMInputStream.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.input.BufferedFileChannelInputStream.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.input.CharSequenceInputStream.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.input.MemoryMappedFileInputStream.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.input.MessageDigestCalculatingInputStream.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.input.QueueInputStream.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.input.RandomAccessFileInputStream.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.input.ReadAheadInputStream.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.input.ReaderInputStream.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.input.ReversedLinesFileReader.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.input.Tailer.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.input.UncheckedBufferedReader.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.input.UncheckedFilterInputStream.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.input.UncheckedFilterReader.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.input.UnsynchronizedBufferedInputStream.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.input.UnsynchronizedFilterInputStream.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.input.XmlStreamReader.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.output.ChunkedOutputStream.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.output.DeferredFileOutputStream.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.output.FileWriterWithEncoding.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.output.LockableFileWriter.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.output.UncheckedFilterOutputStream.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.output.UncheckedFilterWriter.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.output.UnsynchronizedByteArrayOutputStream.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.output.WriterOutputStream.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.io.output.XmlStreamWriter.Builder
-
Constructs a new instance.
- get(int) - Method in class org.apache.commons.io.ByteOrderMark
-
Gets the byte at the specified position.
- get(IOSupplier<FileVisitResult>) - Method in class org.apache.commons.io.filefilter.AbstractFileFilter
- get(IOSupplier<T>) - Static method in class org.apache.commons.io.function.Erase
-
Delegates to the given
IOSupplier
but erases itsIOException
for the compiler, while still throwing the exception at runtime. - get(IOSupplier<T>) - 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)
. - getAdsCriticalOffset(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Special handling for NTFS ADS: Don't accept colon in the fileName.
- getAllowUserInteraction() - Method in class org.apache.commons.io.CloseableURLConnection
- getAppendable() - Method in class org.apache.commons.io.output.AppendableOutputStream
-
Return the target appendable.
- getAppendable() - Method in class org.apache.commons.io.output.AppendableWriter
-
Return the target appendable.
- 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 fileName.
- getBigInteger() - Method in class org.apache.commons.io.file.Counters.BigIntegerCounter
- getBigInteger() - Method in interface org.apache.commons.io.file.Counters.Counter
-
Gets the counter as a BigInteger.
- getBigInteger() - Method in class org.apache.commons.io.file.Counters.LongCounter
- getBigInteger() - Method in class org.apache.commons.io.file.Counters.NoopCounter
- getBlockingQueue() - Method in class org.apache.commons.io.input.QueueInputStream
-
Gets the blocking queue.
- 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 class org.apache.commons.io.input.XmlStreamReaderException
-
Returns the BOM encoding found in the InputStream.
- getBuffer() - Method in class org.apache.commons.io.input.UnsynchronizedBufferedInputStream
- getBufferSize() - Method in class org.apache.commons.io.build.AbstractStreamBuilder
-
Gets the buffer size, defaults to
IOUtils.DEFAULT_BUFFER_SIZE
(8192). - getBufferSize() - Method in class org.apache.commons.io.input.MemoryMappedFileInputStream
- 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
-
Returns the underlying builder.
- 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.FileOrigin
- getByteArray(long, int) - Method in class org.apache.commons.io.build.AbstractOrigin
-
Gets 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
-
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
-
Returns the number of bytes that have been written to this output stream.
- getByteCounter() - Method in class org.apache.commons.io.file.Counters.AbstractPathCounters
- 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 class org.apache.commons.io.TaggedIOException
-
Returns the wrapped exception.
- getCause(int) - Method in exception class org.apache.commons.io.IOExceptionList
-
Gets the cause exception at the given index.
- getCause(int, Class<T>) - Method in exception class org.apache.commons.io.IOExceptionList
-
Gets the cause exception at the given index.
- getCauseList() - Method in exception class org.apache.commons.io.IOExceptionList
-
Gets the cause list.
- getCauseList(Class<T>) - Method in exception class 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.CharSequenceOrigin
- 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
- 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()
. - getCharsetEncoder() - Method in class org.apache.commons.io.input.CharSequenceInputStream.Builder
- getCharsetEncoder() - Method in class org.apache.commons.io.input.CharSequenceInputStream
-
Gets the CharsetEncoder.
- getCharsetEncoder() - Method in class org.apache.commons.io.input.ReaderInputStream.Builder
- getCharsetEncoder() - Method in class org.apache.commons.io.input.ReaderInputStream
-
Gets the CharsetEncoder.
- 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.
- getChunkSize() - Method in class org.apache.commons.io.output.ChunkedOutputStream
- getCleaner() - Static method in class org.apache.commons.io.input.ByteBufferCleaner
- 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
- getComparator() - Method in class org.apache.commons.io.function.UncheckedIOSpliterator
- getConnectTimeout() - Method in class org.apache.commons.io.CloseableURLConnection
- getContent() - Method in class org.apache.commons.io.CloseableURLConnection
- getContent(Class[]) - Method in class org.apache.commons.io.CloseableURLConnection
- getContentEncoding() - Method in class org.apache.commons.io.CloseableURLConnection
- getContentLength() - Method in class org.apache.commons.io.CloseableURLConnection
- getContentLengthLong() - Method in class org.apache.commons.io.CloseableURLConnection
- getContentType() - Method in class org.apache.commons.io.CloseableURLConnection
- getContentTypeEncoding() - Method in exception class org.apache.commons.io.input.XmlStreamReaderException
-
Returns the encoding in the content-type used to attempt determining the encoding.
- getContentTypeEncoding(String) - Static method in class org.apache.commons.io.input.XmlStreamReader
-
Gets the charset parameter value, NULL if not present, NULL if httpContentType is NULL.
- getContentTypeMime() - Method in exception class org.apache.commons.io.input.XmlStreamReaderException
-
Returns the MIME type in the content-type used to attempt determining the encoding.
- getContentTypeMime(String) - Static method in class org.apache.commons.io.input.XmlStreamReader
-
Gets the MIME type or NULL if httpContentType is NULL.
- 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
-
Gets number of bytes that have passed through this stream.
- getCount() - Method in class org.apache.commons.io.output.CountingOutputStream
-
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
-
Returns 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.
- getDate() - Method in class org.apache.commons.io.CloseableURLConnection
- getDefaultByteOrderMark() - Static method in class org.apache.commons.io.input.BOMInputStream.Builder
-
For test access.
- 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.
- getDefaultMessageDigest() - Static method in class org.apache.commons.io.input.MessageDigestCalculatingInputStream
-
Gets a MessageDigest object that implements the default digest algorithm.
- getDefaultUseCaches() - Method in class org.apache.commons.io.CloseableURLConnection
- 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 the file paths that failed to delete.
- getDepth() - Method in exception class 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 class org.apache.commons.io.file.Counters.AbstractPathCounters
- 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 the list of visited directories.
- getDoInput() - Method in class org.apache.commons.io.CloseableURLConnection
- getDoOutput() - Method in class org.apache.commons.io.CloseableURLConnection
- getDosFileAttributeView(Path, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Shorthand for
Files.getFileAttributeView(path, DosFileAttributeView.class)
. - 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
- getExactSizeIfKnown() - Method in class org.apache.commons.io.function.UncheckedIOSpliterator
- getExpiration() - Method in class org.apache.commons.io.CloseableURLConnection
- getExtension(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Gets the extension of a fileName.
- 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.PathOrigin
- getFile() - Method in class org.apache.commons.io.build.AbstractOrigin.URIOrigin
- getFile() - Method in exception class 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.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 class org.apache.commons.io.file.Counters.AbstractPathCounters
-
Gets the count of visited files.
- 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 the list of visited files.
- 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 from a full fileName, which is the prefix + path.
- getFullPathNoEndSeparator(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Gets the full path from a full fileName, which is the prefix + path, and also excluding the final directory separator.
- getHeaderField(int) - Method in class org.apache.commons.io.CloseableURLConnection
- getHeaderField(String) - Method in class org.apache.commons.io.CloseableURLConnection
- getHeaderFieldDate(String, long) - Method in class org.apache.commons.io.CloseableURLConnection
- getHeaderFieldInt(String, int) - Method in class org.apache.commons.io.CloseableURLConnection
- getHeaderFieldKey(int) - Method in class org.apache.commons.io.CloseableURLConnection
- getHeaderFieldLong(String, long) - Method in class org.apache.commons.io.CloseableURLConnection
- getHeaderFields() - Method in class org.apache.commons.io.CloseableURLConnection
- getIfModifiedSince() - Method in class org.apache.commons.io.CloseableURLConnection
- 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 class org.apache.commons.io.IOIndexedException
-
The index of this exception.
- getInputStream() - Method in class org.apache.commons.io.build.AbstractStreamBuilder
-
Gets an input stream from the origin with open options.
- getInputStream() - Method in class org.apache.commons.io.CloseableURLConnection
- getInputStream(OpenOption...) - Method in class org.apache.commons.io.build.AbstractOrigin.ByteArrayOrigin
- getInputStream(OpenOption...) - Method in class org.apache.commons.io.build.AbstractOrigin.CharSequenceOrigin
- 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
- getInputStream(OpenOption...) - Method in class org.apache.commons.io.build.AbstractOrigin.ReaderOrigin
- getInstance() - Static method in class org.apache.commons.io.FileCleaner
-
Deprecated.Returns 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.CloseableURLConnection
- 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
. - getLastModifiedTime(Path, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
- 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 class org.apache.commons.io.file.Counters.BigIntegerCounter
- getLong() - Method in interface org.apache.commons.io.file.Counters.Counter
-
Gets the counter as a Long.
- getLong() - Method in class org.apache.commons.io.file.Counters.LongCounter
- getLong() - Method in class org.apache.commons.io.file.Counters.NoopCounter
- 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
-
Gets the max count of bytes to read.
- 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
-
Gets the
MessageDigest
, which is being used for generating the checksum. - 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 fileName.
- getNameSeparator() - Method in enum org.apache.commons.io.FileSystem
-
Gets the name separator, '\\' on Windows, '/' on Linux.
- getNanosOfMilli(Duration) - Static method in class org.apache.commons.io.ThreadUtils
- getNewLineMatchByteCount(byte[], int) - Method in class org.apache.commons.io.input.ReversedLinesFileReader.FilePart
-
Finds the new-line sequence and return its length.
- getObservers() - Method in class org.apache.commons.io.input.ObservableInputStream
-
Gets all 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
- 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.
- getOsMatchesName(String) - Static method in enum org.apache.commons.io.FileSystem
-
Decides if the operating system matches.
- getOutputStream() - Method in class org.apache.commons.io.build.AbstractStreamBuilder
-
Gets an OutputStream from the origin with open options.
- getOutputStream() - Method in class org.apache.commons.io.CloseableURLConnection
- 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
- getOutputStream(OpenOption...) - Method in class org.apache.commons.io.build.AbstractOrigin.WriterOrigin
- 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.
- getParent(Path) - Static method in class org.apache.commons.io.file.PathUtils
- getParentFile(File) - Static method in class org.apache.commons.io.FileUtils
-
Gets the parent of the given file.
- 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.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.FileCleaningTracker.Tracker
-
Return the path.
- getPath() - Method in class org.apache.commons.io.input.Tailer.TailablePath
- getPath(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Gets the path from a full fileName, which excludes the prefix.
- 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 from a full fileName, which excludes the prefix, and also excluding the final directory separator.
- getPermission() - Method in class org.apache.commons.io.CloseableURLConnection
- getPointer() - Method in class org.apache.commons.io.input.Tailer.RandomAccessFileBridge
- 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
-
Return 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
. - getPrefix(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Gets the prefix from a full fileName, such as
C:/
or~/
. - getPrefixLength(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Returns the length of the fileName 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.
- getRandomAccess(String) - Method in class org.apache.commons.io.input.Tailer.TailablePath
- getRandomAccessFile() - Method in class org.apache.commons.io.input.RandomAccessFileInputStream
-
Gets the underlying file.
- getReader(Charset) - Method in class org.apache.commons.io.build.AbstractOrigin.ByteArrayOrigin
- getReader(Charset) - Method in class org.apache.commons.io.build.AbstractOrigin.CharSequenceOrigin
- 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
- getReadTimeout() - Method in class org.apache.commons.io.CloseableURLConnection
- getRequestProperties() - Method in class org.apache.commons.io.CloseableURLConnection
- getRequestProperty(String) - Method in class org.apache.commons.io.CloseableURLConnection
- 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.
- getScratchByteArray() - Static method in class org.apache.commons.io.IOUtils
-
Gets the internal byte array buffer, intended for both reading and writing.
- getScratchByteArrayWriteOnly() - Static method in class org.apache.commons.io.IOUtils
-
Gets the internal byte array intended for write only operations.
- getScratchCharArray() - Static method in class org.apache.commons.io.IOUtils
-
Gets the char byte array buffer, intended for both reading and writing.
- getScratchCharArrayWriteOnly() - Static method in class org.apache.commons.io.IOUtils
-
Gets the internal char array intended for write only operations.
- getSize() - Method in class org.apache.commons.io.input.NullInputStream
-
Return 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
-
Returns 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
-
Returns the underlying output stream, to which the corresponding
OutputStream
methods in this class will ultimately delegate. - getString() - Method in enum org.apache.commons.io.StandardLineSeparator
-
Gets the String value of this instance.
- getSystemProperty(String) - Static method in enum org.apache.commons.io.FileSystem
-
Gets a System property, defaulting to
null
if the property cannot be read. - getTag() - Method in exception class 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
-
Returns the threshold, in bytes, at which an event will be triggered.
- getTimeout() - Method in class org.apache.commons.io.input.QueueInputStream
-
Gets the timeout duration.
- 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.
- getType(File) - Method in class org.apache.commons.io.comparator.DirectoryFileComparator
-
Converts type to numeric value.
- getURL() - Method in class org.apache.commons.io.CloseableURLConnection
- getUseCaches() - Method in class org.apache.commons.io.CloseableURLConnection
- 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 an writer from the origin with open options.
- 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
- getWriter(Charset, OpenOption...) - Method in class org.apache.commons.io.build.AbstractOrigin.WriterOrigin
- getXmlEncoding() - Method in exception class org.apache.commons.io.input.XmlStreamReaderException
-
Returns the encoding found in the XML prolog of the InputStream.
- getXmlGuessEncoding() - Method in exception class org.apache.commons.io.input.XmlStreamReaderException
-
Returns the encoding guess based on the first bytes of the InputStream.
- getXmlProlog(InputStream, String) - Static method in class org.apache.commons.io.input.XmlStreamReader
-
Gets the encoding declared in the invalid input: '<'?xml encoding=...?>, NULL if none.
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.
- handleEos() - Method in class org.apache.commons.io.input.WindowsLineEndingInputStream
-
Handles the end of stream condition.
- handleEos(boolean) - Method in class org.apache.commons.io.input.UnixLineEndingInputStream
-
Handles the end of stream condition.
- 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
-
Handle 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
-
Returns, whether the buffer is currently holding, at least, a single byte.
- hasCharacteristics(int) - Method in interface org.apache.commons.io.function.IOSpliterator
- hasCharacteristics(int) - Method in class org.apache.commons.io.function.UncheckedIOSpliterator
- hashCode() - Method in class org.apache.commons.io.ByteOrderMark
-
Computes the hash code for this BOM.
- hashCode() - Method in class org.apache.commons.io.CloseableURLConnection
- 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.Counters.AbstractPathCounters
- hashCode() - Method in class org.apache.commons.io.file.Counters.BigIntegerCounter
- hashCode() - Method in class org.apache.commons.io.file.Counters.LongCounter
- hashCode() - Method in class org.apache.commons.io.file.CountingPathVisitor
- hashCode() - Method in class org.apache.commons.io.file.DeletingPathVisitor
- hashCode() - Method in class org.apache.commons.io.monitor.SerializableFileTime
- hasNext() - Method in interface org.apache.commons.io.function.IOIterator
-
Like
Iterator.hasNext()
. - hasNext() - Method in class org.apache.commons.io.function.IOIteratorAdapter
- hasNext() - Method in class org.apache.commons.io.function.UncheckedIOIterator
- 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
-
Returns, whether there is currently room for a single byte in the buffer.
- hasSpace(int) - Method in class org.apache.commons.io.input.buffer.CircularByteBuffer
-
Returns, 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.
- HEX_CODES - Static variable in class org.apache.commons.io.HexDump
- 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.
- HTTP_EX_1 - Static variable in class org.apache.commons.io.input.XmlStreamReader
- HTTP_EX_2 - Static variable in class org.apache.commons.io.input.XmlStreamReader
- HTTP_EX_3 - Static variable in class org.apache.commons.io.input.XmlStreamReader
- httpContentType - Variable in class org.apache.commons.io.input.XmlStreamReader.Builder
- HUNDRED_NANOS_PER_MILLISECOND - Static variable in class org.apache.commons.io.file.attribute.FileTimes
-
The amount of 100-nanosecond intervals in one millisecond.
- HUNDRED_NANOS_PER_SECOND - Static variable in class org.apache.commons.io.file.attribute.FileTimes
-
The amount of 100-nanosecond intervals in one second.
I
- 3.2 Internal - Search tag in class org.apache.commons.io.DirectoryWalker
- Section
- 4. Interrupting a Tailer - Search tag in class org.apache.commons.io.input.Tailer
- Section
- 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.
- idx - Variable in class org.apache.commons.io.input.CharSequenceReader
- illegalFileNameChars - Variable in enum org.apache.commons.io.FileSystem
- in - Variable in class org.apache.commons.io.input.UnixLineEndingInputStream
- in - Variable in class org.apache.commons.io.input.WindowsLineEndingInputStream
- inbuf - Variable in class org.apache.commons.io.input.Tailer
-
Buffer on top of RandomAccessResourceBridge.
- include - Variable in class org.apache.commons.io.input.BOMInputStream.Builder
- include - Variable in class org.apache.commons.io.input.BOMInputStream
- increment() - Method in class org.apache.commons.io.file.Counters.BigIntegerCounter
- increment() - Method in interface org.apache.commons.io.file.Counters.Counter
-
Adds one to this counter.
- increment() - Method in class org.apache.commons.io.file.Counters.LongCounter
- increment() - Method in class org.apache.commons.io.file.Counters.NoopCounter
- index - Variable in exception class org.apache.commons.io.IOIndexedException
- indexOf(CharSequence, int, int) - Static method in enum org.apache.commons.io.FileSystem
-
Copied from Apache Commons Lang CharSequenceUtils.
- 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
-
Creates an instance from the specified array of bytes.
- 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.
- INIT_PROBLEM - Static variable in class org.apache.commons.io.FileSystemUtils
-
Deprecated.Operating system state flag for error.
- initialize() - Method in class org.apache.commons.io.monitor.FileAlterationObserver
-
Initializes the observer.
- initWriter(File, Object, boolean) - Static method in class org.apache.commons.io.output.FileWriterWithEncoding
-
Initializes the wrapped file writer.
- initWriter(File, Charset, boolean) - Method in class org.apache.commons.io.output.LockableFileWriter
-
Initializes the wrapped file writer.
- injectSlashLf - Variable in class org.apache.commons.io.input.WindowsLineEndingInputStream
- inputStream - Variable in class org.apache.commons.io.input.UnsynchronizedFilterInputStream
-
The source input stream that is filtered.
- inputStreamLocal - Variable in class org.apache.commons.io.input.DemuxInputStream
- 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.
- INSTALLED - Static variable in class org.apache.commons.io.file.spi.FileSystemProviders
- INSTANCE - Static variable in class org.apache.commons.io.file.Counters.NoopCounter
- INSTANCE - Static variable in class org.apache.commons.io.file.Counters.NoopPathCounters
- INSTANCE - Static variable in class org.apache.commons.io.file.NoopPathVisitor
-
The singleton instance.
- INSTANCE - Static variable in class org.apache.commons.io.FileCleaner
-
Deprecated.The instance to use for the deprecated, static methods.
- 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.FileSystemUtils
-
Deprecated.Singleton instance, used mainly for testing.
- INSTANCE - Static variable in class org.apache.commons.io.input.BrokenInputStream
-
The singleton instance.
- 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.ByteBufferCleaner
- 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
-
The singleton instance.
- 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
-
A singleton instance.
- INSTANCE - Static variable in class org.apache.commons.io.output.BrokenWriter
-
The singleton instance.
- 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.
- intervalMillis - Variable in class org.apache.commons.io.monitor.FileAlterationMonitor
- INVALID - Static variable in class org.apache.commons.io.input.BoundedReader
- invalidClassNameFound(String) - Method in class org.apache.commons.io.serialization.ValidatingObjectInputStream
-
Called to throw
InvalidClassException
if an invalid class name is found during deserialization. - invokeCleaner - Variable in class org.apache.commons.io.input.ByteBufferCleaner.Java9Cleaner
- IO - Class in org.apache.commons.io
-
Component-wide operations on Apache Commons IO.
- IO() - Constructor for class org.apache.commons.io.IO
- IO_BI_CONSUMER - Static variable in class org.apache.commons.io.function.Constants
-
No-op singleton.
- IO_BI_FUNCTION - Static variable in class org.apache.commons.io.function.Constants
-
No-op singleton.
- IO_FUNCTION_ID - Static variable in class org.apache.commons.io.function.Constants
-
No-op singleton.
- IO_PREDICATE_FALSE - Static variable in class org.apache.commons.io.function.Constants
-
Always false.
- IO_PREDICATE_TRUE - Static variable in class org.apache.commons.io.function.Constants
-
Always true.
- IO_TRI_CONSUMER - Static variable in class org.apache.commons.io.function.Constants
-
No-op singleton.
- IOBaseStream<T,
S, - Interface in org.apache.commons.io.functionB> -
Like
BaseStream
but throwsIOException
. - IOBaseStreamAdapter<T,
S, - Class in org.apache.commons.io.functionB> -
Abstracts an
IOBaseStream
implementation. - IOBaseStreamAdapter(B) - Constructor for class org.apache.commons.io.function.IOBaseStreamAdapter
-
Constructs an instance.
- IOBiConsumer<T,
U> - Interface in org.apache.commons.io.function -
Like
BiConsumer
but throwsIOException
. - IOBiFunction<T,
U, - Interface in org.apache.commons.io.functionR> -
Like
BiFunction
but throwsIOException
. - IOBinaryOperator<T> - Interface in org.apache.commons.io.function
-
Like
BinaryOperator
but throwsIOException
. - ioCase - Variable in class org.apache.commons.io.comparator.ExtensionFileComparator
-
Whether the comparison is case-sensitive.
- ioCase - Variable in class org.apache.commons.io.comparator.NameFileComparator
-
Whether the comparison is case-sensitive.
- ioCase - Variable in class org.apache.commons.io.comparator.PathFileComparator
-
Whether the comparison is case-sensitive.
- ioCase - Variable in class org.apache.commons.io.filefilter.NameFileFilter
-
Whether the comparison is case-sensitive.
- ioCase - Variable in class org.apache.commons.io.filefilter.SuffixFileFilter
-
Whether the comparison is case-sensitive.
- ioCase - Variable in class org.apache.commons.io.filefilter.WildcardFileFilter.Builder
-
Whether the comparison is case-sensitive.
- ioCase - Variable in class org.apache.commons.io.filefilter.WildcardFileFilter
-
Whether the comparison is case-sensitive.
- IOCase - Enum in org.apache.commons.io
-
Enumeration of IO case sensitivity.
- IOCase(String, boolean) - Constructor for enum org.apache.commons.io.IOCase
-
Constructs a new instance.
- 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 Class in org.apache.commons.io
-
An IOException based on a list of Throwable causes.
- IOExceptionList(String, List<? extends Throwable>) - Constructor for exception class org.apache.commons.io.IOExceptionList
-
Creates a new exception caused by a list of exceptions.
- IOExceptionList(List<? extends Throwable>) - Constructor for exception class org.apache.commons.io.IOExceptionList
-
Creates a new exception caused by a list of exceptions.
- IOExceptionWithCause - Exception Class in org.apache.commons.io
-
Deprecated.(since 2.5) use
IOException
instead - IOExceptionWithCause(String, Throwable) - Constructor for exception class org.apache.commons.io.IOExceptionWithCause
-
Deprecated.Constructs a new instance with the given message and cause.
- IOExceptionWithCause(Throwable) - Constructor for exception class 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, and PathFilter interfaces together.
- IOFunction<T,
R> - Interface in org.apache.commons.io.function -
Like
Function
but throwsIOException
. - IOIndexedException - Exception Class in org.apache.commons.io
-
A IOException associated with a source index.
- IOIndexedException(int, Throwable) - Constructor for exception class org.apache.commons.io.IOIndexedException
-
Creates a new exception.
- IOIterator<E> - Interface in org.apache.commons.io.function
-
Like
Iterator
but throwsIOException
. - IOIteratorAdapter<E> - Class in org.apache.commons.io.function
-
Adapts an
Iterator
as anIOIterator
. - IOIteratorAdapter(Iterator<E>) - Constructor for class org.apache.commons.io.function.IOIteratorAdapter
- IOPredicate<T> - Interface in org.apache.commons.io.function
-
Like
Predicate
but throwsIOException
. - IOQuadFunction<T,
U, - Interface in org.apache.commons.io.functionV, W, R> -
Represents a function that accepts four arguments and produces a result.
- 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
. - IOSpliteratorAdapter<T> - Class in org.apache.commons.io.function
-
Adapts an
Spliterator
as anIOSpliterator
. - IOSpliteratorAdapter(Spliterator<T>) - Constructor for class org.apache.commons.io.function.IOSpliteratorAdapter
- IOStream<T> - Interface in org.apache.commons.io.function
-
Like
Stream
but throwsIOException
. - IOStreamAdapter<T> - Class in org.apache.commons.io.function
- IOStreamAdapter(Stream<T>) - Constructor for class org.apache.commons.io.function.IOStreamAdapter
- IOStreams - Class in org.apache.commons.io.function
-
Keep this code package-private for now.
- IOStreams() - Constructor for class org.apache.commons.io.function.IOStreams
- IOSupplier<T> - Interface in org.apache.commons.io.function
-
Like
Supplier
but throwsIOException
. - IOTriConsumer<T,
U, - Interface in org.apache.commons.io.functionV> -
Like
BiConsumer
but throwsIOException
. - IOTriFunction<T,
U, - Interface in org.apache.commons.io.functionV, R> -
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.Will be private in 3.0.
- IPV4_MAX_OCTET_VALUE - Static variable in class org.apache.commons.io.FilenameUtils
- IPV4_PATTERN - Static variable in class org.apache.commons.io.FilenameUtils
- IPV6_MAX_HEX_DIGITS_PER_GROUP - Static variable in class org.apache.commons.io.FilenameUtils
- IPV6_MAX_HEX_GROUPS - Static variable in class org.apache.commons.io.FilenameUtils
- IS_OS_LINUX - Static variable in enum org.apache.commons.io.FileSystem
-
Is
true
if this is Linux. - IS_OS_MAC - Static variable in enum org.apache.commons.io.FileSystem
-
Is
true
if this is Mac. - IS_OS_WINDOWS - Static variable in enum org.apache.commons.io.FileSystem
-
Is
true
if this is Windows. - isAppXml(String) - Static method in class org.apache.commons.io.input.XmlStreamReader
-
Tests if the MIME type belongs to the APPLICATION XML family.
- isCase - Variable in class org.apache.commons.io.filefilter.PrefixFileFilter
-
Whether the comparison is case-sensitive.
- 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 - Variable in class org.apache.commons.io.input.ReadAheadInputStream
- isClosed() - Method in class org.apache.commons.io.input.TimestampedObserver
-
Tests whether
TimestampedObserver.closed()
has been called. - isCloseOnClose() - Method in class org.apache.commons.io.input.RandomAccessFileInputStream
-
Returns 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() - Method in class org.apache.commons.io.filefilter.AndFileFilter
- isEmpty(String) - Static method in class org.apache.commons.io.FilenameUtils
- isEmpty(Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Tests whether the given file or directory is empty.
- isEmpty(List<? extends Throwable>) - Static method in exception class org.apache.commons.io.IOExceptionList
- 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.
- isEndOfStream() - Method in class org.apache.commons.io.input.ReadAheadInputStream
- 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 fileName is that specified.
- isExtension(String, String...) - Static method in class org.apache.commons.io.FilenameUtils
-
Checks whether the extension of the fileName is one of those specified.
- isExtension(String, Collection<String>) - Static method in class org.apache.commons.io.FilenameUtils
-
Checks whether the extension of the fileName 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
- isIllegalFileNameChar(int) - Method in enum org.apache.commons.io.FileSystem
-
Tests if the given character is illegal in a file name,
false
otherwise. - 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.
- isIPv4Address(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Checks whether a given string represents a valid IPv4 address.
- isIPv6Address(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Checks whether a given string represents a valid IPv6 address.
- 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. - isMaxLength() - Method in class org.apache.commons.io.input.BoundedInputStream
- isNewer(FileTime) - Method in interface org.apache.commons.io.input.Tailer.Tailable
-
Tests if this tailable is newer than the specified
FileTime
. - isNewer(FileTime) - Method in class org.apache.commons.io.input.Tailer.TailablePath
- 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. - isOsNameMatch(String, String) - Static method in enum org.apache.commons.io.FileSystem
-
Decides if the operating system matches.
- isParallel() - Method in interface org.apache.commons.io.function.IOBaseStream
-
Like
BaseStream.isParallel()
. - isParallel() - Method in class org.apache.commons.io.function.UncheckedIOBaseStream
- 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
. - isReading - Variable in class org.apache.commons.io.input.ReadAheadInputStream
- 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.
- isRFC3986HostName(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Checks whether a given string is a valid host name according to RFC 3986 - not accepting IP addresses.
- isSameFile(Path, Path) - Static method in class org.apache.commons.io.file.FilesUncheck
- isSeparator(char) - Static method in class org.apache.commons.io.FilenameUtils
-
Checks if the character is a separator.
- isSupported() - Static method in class org.apache.commons.io.input.ByteBufferCleaner
-
Tests if were able to load a suitable cleaner for the current JVM.
- isSymbolicLink(Path) - Method in class org.apache.commons.io.filefilter.SymbolicLinkFileFilter
-
Delegates to
Files.isSymbolicLink(Path)
for testing. - 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.
- isSystemWindows() - Static method in class org.apache.commons.io.FilenameUtils
-
Determines if Windows file system is in use.
- isTaggedWith(Throwable, Object) - Static method in exception class org.apache.commons.io.TaggedIOException
-
Checks whether the given throwable is tagged with the given tag.
- isTextXml(String) - Static method in class org.apache.commons.io.input.XmlStreamReader
-
Tests if the MIME type belongs to the TEXT XML family.
- isThresholdExceeded() - Method in class org.apache.commons.io.output.ThresholdingOutputStream
-
Determines whether or not the configured threshold has been exceeded for this output stream.
- isUnderlyingInputStreamBeingClosed - Variable in class org.apache.commons.io.input.ReadAheadInputStream
- isValidHostName(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Checks whether a given string is a valid host name according to RFC 3986.
- isValidLine(String) - Method in class org.apache.commons.io.LineIterator
-
Overridable method to validate each line that is returned.
- isWaiting - Variable in class org.apache.commons.io.input.ReadAheadInputStream
- 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 - Variable in class org.apache.commons.io.StreamIterator
- iterator() - Method in interface org.apache.commons.io.function.IOBaseStream
-
Like
BaseStream.iterator()
. - iterator() - Method in class org.apache.commons.io.function.UncheckedIOBaseStream
- iterator() - Method in exception class 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.
J
- Java8Cleaner() - Constructor for class org.apache.commons.io.input.ByteBufferCleaner.Java8Cleaner
- Java9Cleaner() - Constructor for class org.apache.commons.io.input.ByteBufferCleaner.Java9Cleaner
L
- lastCoderResult - Variable in class org.apache.commons.io.input.ReaderInputStream
- lastModified - Variable in class org.apache.commons.io.monitor.FileEntry
- 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() - Method in class org.apache.commons.io.input.Tailer.TailablePath
- 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...)
. - LCK - Static variable in class org.apache.commons.io.output.LockableFileWriter
-
The extension for the lock file.
- leftOver - Variable in class org.apache.commons.io.input.ReversedLinesFileReader.FilePart
- length - Variable in class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream.Builder
- length - Variable in class org.apache.commons.io.monitor.FileEntry
- 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.
- lenient - Variable in class org.apache.commons.io.input.XmlStreamReader.Builder
- LF - Enum constant in enum org.apache.commons.io.StandardLineSeparator
-
Line feed.
- LF - Static variable in class org.apache.commons.io.IOUtils
-
LF char.
- 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.
- lineFeedAtEndOfFile - Variable in class org.apache.commons.io.input.UnixLineEndingInputStream
- lineFeedAtEndOfFile - Variable in class org.apache.commons.io.input.WindowsLineEndingInputStream
- 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
- lineSeparator - Variable in enum org.apache.commons.io.StandardLineSeparator
- linkOptions - Variable in class org.apache.commons.io.file.DeletingPathVisitor
- linkOptions - Variable in class org.apache.commons.io.input.Tailer.TailablePath
- 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
- listAccumulate(File, IOFileFilter, IOFileFilter, FileVisitOption...) - Static method in class org.apache.commons.io.FileUtils
- listener - Variable in class org.apache.commons.io.input.Tailer
-
The listener to notify of events when tailing.
- listeners - Variable in class org.apache.commons.io.monitor.FileAlterationObserver
- listFiles(File) - Method in class org.apache.commons.io.monitor.FileAlterationObserver
-
Lists the contents of a directory
- listFiles(File, FileFilter) - Static method in class org.apache.commons.io.FileUtils
-
Lists files in a directory, asserting that the supplied directory exists and is a directory.
- listFiles(File, String[], boolean) - Static method in class org.apache.commons.io.FileUtils
-
Finds 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.2.5 use
LockableFileWriter(File, Charset, boolean, String)
instead - 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
instance. - lockDirectory - Variable in class org.apache.commons.io.output.LockableFileWriter.Builder
- lockFile - Variable in class org.apache.commons.io.output.LockableFileWriter
-
The lock file.
- longCounter() - Static method in class org.apache.commons.io.file.Counters
-
Returns a new long Counter.
- LongCounter() - Constructor for class org.apache.commons.io.file.Counters.LongCounter
- longPathCounters() - Static method in class org.apache.commons.io.file.Counters
-
Returns a new BigInteger PathCounters.
- LongPathCounters() - Constructor for class org.apache.commons.io.file.Counters.LongPathCounters
-
Constructs a new initialized instance.
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.
- magicNumbers - Variable in class org.apache.commons.io.filefilter.MagicNumberFileFilter
-
The magic number to compare against the file's bytes at the provided offset.
- 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? Adding this method now and an IO version later is an issue because call sites would have to type-cast to pick one.
- mapToInt(ToIntFunction<? super T>) - Method in interface org.apache.commons.io.function.IOStream
-
TODO Package-private for now, needs IOToIntFunction? Adding this method now and an IO version later is an issue because call sites would have to type-cast to pick one.
- mapToLong(ToLongFunction<? super T>) - Method in interface org.apache.commons.io.function.IOStream
-
TODO Package-private for now, needs IOToLongFunction? Adding this method now and an IO version later is an issue because call sites would have to type-cast to pick one.
- mark - Variable in class org.apache.commons.io.input.BoundedInputStream
-
The marked position.
- mark - Variable in class org.apache.commons.io.input.CharSequenceReader
- mark - Variable in class org.apache.commons.io.input.NullInputStream
- mark - Variable in class org.apache.commons.io.input.NullReader
- mark() - Static method in class org.apache.commons.io.input.UnsupportedOperationExceptions
-
Creates a new instance of UnsupportedOperationException for a
mark
method. - 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
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
-
Mark 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
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.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
- MARK_RESET - Static variable in class org.apache.commons.io.input.UnsupportedOperationExceptions
- markedAt - Variable in class org.apache.commons.io.input.BoundedReader
- markedAtStart - Variable in class org.apache.commons.io.input.BOMInputStream
- markedOffset - Variable in class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream
-
The current mark (if any).
- markFbIndex - Variable in class org.apache.commons.io.input.BOMInputStream
- 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.
- 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
-
Creates a proxy that shields the given input stream from being marked or rest.
- markSupported - Variable in class org.apache.commons.io.input.NullInputStream
- markSupported - Variable in class org.apache.commons.io.input.NullReader
- markSupported() - Method in class org.apache.commons.io.input.BoundedInputStream
-
Invokes the delegate's
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
-
Indicates 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
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.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(String) - Method in class org.apache.commons.io.serialization.FullClassNameMatcher
- matches(String) - Method in class org.apache.commons.io.serialization.RegexpClassNameMatcher
- matches(String) - Method in class org.apache.commons.io.serialization.WildcardClassNameMatcher
- matches(ByteOrderMark) - Method in class org.apache.commons.io.input.BOMInputStream
-
Checks if the bytes match a BOM.
- max(IOComparator<? super T>) - Method in interface org.apache.commons.io.function.IOStream
- MAX_UNSIGNED_SHORT - Static variable in class org.apache.commons.io.FilenameUtils
- 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
. - maxCharsFromTargetReader - Variable in class org.apache.commons.io.input.BoundedReader
- maxCount - Variable in class org.apache.commons.io.input.BoundedInputStream
-
The max count of bytes to read.
- maxFileNameLength - Variable in enum org.apache.commons.io.FileSystem
- maxPathLength - Variable in enum org.apache.commons.io.FileSystem
- MemoryMappedFileInputStream - Class in org.apache.commons.io.input
-
An
InputStream
that utilizes memory mapped files to improve performance. - MemoryMappedFileInputStream(Path, int) - Constructor for class org.apache.commons.io.input.MemoryMappedFileInputStream
-
Constructs a new instance.
- MemoryMappedFileInputStream.Builder - Class in org.apache.commons.io.input
-
Builds a new
MemoryMappedFileInputStream
instance. - memoryOutputStream - Variable in class org.apache.commons.io.output.DeferredFileOutputStream
-
The output stream to which data will be written prior to the threshold being reached.
- messageDigest - Variable in class org.apache.commons.io.input.MessageDigestCalculatingInputStream.Builder
- messageDigest - Variable in class org.apache.commons.io.input.MessageDigestCalculatingInputStream
- messageDigest - Variable in class org.apache.commons.io.input.MessageDigestCalculatingInputStream.MessageDigestMaintainingObserver
- MessageDigestCalculatingInputStream - Class in org.apache.commons.io.input
-
This class is an example for using an
ObservableInputStream
. - 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
-
Builds a new
MessageDigestCalculatingInputStream
instance. - MessageDigestCalculatingInputStream.MessageDigestMaintainingObserver - Class in org.apache.commons.io.input
-
Maintains the message digest.
- MessageDigestMaintainingObserver(MessageDigest) - Constructor for class org.apache.commons.io.input.MessageDigestCalculatingInputStream.MessageDigestMaintainingObserver
-
Creates an MessageDigestMaintainingObserver for the given MessageDigest.
- method(String) - Static method in class org.apache.commons.io.input.UnsupportedOperationExceptions
-
Creates a new instance of UnsupportedOperationException for the given unsupported a
method
name. - min(IOComparator<? super T>) - Method in interface org.apache.commons.io.function.IOStream
- minBufferSize(CharsetEncoder) - Static method in class org.apache.commons.io.input.ReaderInputStream
- 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.
- mkdirs(File) - Static method in class org.apache.commons.io.FileUtils
-
Calls
File.mkdirs()
and throws anIOException
on failure. - mode - Variable in enum org.apache.commons.io.RandomAccessFileMode
- 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 to a directory.
- moveToDirectory(File, File, boolean) - Static method in class org.apache.commons.io.FileUtils
-
Moves a file or directory to a destination directory.
N
- name - Variable in class org.apache.commons.io.FileDeleteStrategy
-
The name of the strategy.
- name - Variable in enum org.apache.commons.io.IOCase
-
The enumeration name.
- name - Variable in class org.apache.commons.io.monitor.FileEntry
- 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.
- names - Variable in class org.apache.commons.io.filefilter.NameFileFilter
-
The file names to search for
- nameSeparator - Variable in enum org.apache.commons.io.FileSystem
- nameSeparatorOther - Variable in enum org.apache.commons.io.FileSystem
- 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
-
Creates 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
-
Creates 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
-
Creates a new CharSequence origin for a CharSequence.
- newChildInstance(File) - Method in class org.apache.commons.io.monitor.FileEntry
-
Creates a new child instance.
- newDaemonThread(Runnable) - Static method in class org.apache.commons.io.input.ReadAheadInputStream
-
Creates a new daemon thread.
- newDaemonThread(Runnable) - Static method in class org.apache.commons.io.input.Tailer.Builder
-
Creates a new daemon thread.
- 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.
- newEncoder(Charset) - Static method in class org.apache.commons.io.input.CharSequenceInputStream
- newEncoder(Charset) - Static method in class org.apache.commons.io.input.ReaderInputStream
- newExecutorService() - Static method in class org.apache.commons.io.input.ReadAheadInputStream
-
Creates a new daemon executor service.
- newFileOrigin(File) - Static method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Creates a new file origin for a file.
- newFileOrigin(String) - Static method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Creates 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
-
Creates a new input stream origin for a file.
- newLineSequences - Variable in class org.apache.commons.io.input.ReversedLinesFileReader
- 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, LinkOption[], OpenOption...) - Static method in class org.apache.commons.io.file.PathUtils
- 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
-
Creates a new output stream origin for a file.
- newPathOrigin(String) - Static method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Creates a new path name origin for a path name.
- newPathOrigin(Path) - Static method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Creates a new path origin for a file.
- newQueueInputStream() - Method in class org.apache.commons.io.output.QueueOutputStream
-
Creates a new QueueInputStream instance connected to this.
- newQueueOutputStream() - Method in class org.apache.commons.io.input.QueueInputStream
-
Creates a new QueueOutputStream instance connected to this.
- newReaderOrigin(Reader) - Static method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Creates a new reader origin for a reader.
- newURIOrigin(URI) - Static method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Creates a new reader origin for a URI.
- newWriterOrigin(Writer) - Static method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Creates 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.function.IOIteratorAdapter
- next() - Method in class org.apache.commons.io.function.UncheckedIOIterator
- 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
- nextBuffer() - Method in class org.apache.commons.io.input.MemoryMappedFileInputStream
- nextBufferPosition - Variable in class org.apache.commons.io.input.MemoryMappedFileInputStream
-
The starting position (within the file) of the next sliding buffer.
- nextLine() - Method in class org.apache.commons.io.LineIterator
-
Returns the next line in the wrapped
Reader
. - nextReader() - Method in class org.apache.commons.io.input.SequenceReader
-
Returns the next available reader or null if done.
- no - Variable in class org.apache.commons.io.input.ReversedLinesFileReader.FilePart
- NO_MARK - Static variable in class org.apache.commons.io.input.CharSequenceInputStream
- 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
. - NONE - Static variable in class org.apache.commons.io.function.IOStreams
- 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.IOTriConsumer
-
Returns the no-op singleton.
- NOOP_IO_CONSUMER - Static variable in interface org.apache.commons.io.function.IOConsumer
-
Consider private.
- NOOP_OS_GETTER - Static variable in class org.apache.commons.io.output.ThresholdingOutputStream
-
Noop output stream getter function.
- noopCounter() - Static method in class org.apache.commons.io.file.Counters
-
Returns the no-op Counter.
- NoopCounter() - Constructor for class org.apache.commons.io.file.Counters.NoopCounter
- noopPathCounters() - Static method in class org.apache.commons.io.file.Counters
-
Returns the no-op PathCounters.
- NoopPathCounters() - Constructor for class org.apache.commons.io.file.Counters.NoopPathCounters
-
Constructs a new initialized instance.
- 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(FileVisitResult) - Method in class org.apache.commons.io.filefilter.NotFileFilter
- NOT_EMPTY - Static variable in class org.apache.commons.io.filefilter.EmptyFileFilter
-
Singleton instance of not-empty filter
- NOT_FOUND - Static variable in class org.apache.commons.io.FilenameUtils
- 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()
. - notExists(Path, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
- 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.
- notify(byte[], int, int, IOException) - Method in class org.apache.commons.io.input.ObservableInputStream
- 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_LINK_OPTION - Static variable in class org.apache.commons.io.file.PathUtils
-
A LinkOption used to follow link in this class, the inverse of
LinkOption.NOFOLLOW_LINKS
. - 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.
- NullAppendable() - Constructor for class org.apache.commons.io.output.NullAppendable
-
Use the singleton.
- nullCharset - Variable in class org.apache.commons.io.input.XmlStreamReader.Builder
- NullInputStream - Class in org.apache.commons.io.input
-
A functional, light weight
InputStream
that emulates a stream of a specified size. - NullInputStream() - Constructor for class org.apache.commons.io.input.NullInputStream
-
Create 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
-
Create 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
-
Create 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
-
Creates 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
-
Creates 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
-
Creates 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
- 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
-
Creates a new ObservableInputStream for the given InputStream.
- ObservableInputStream(InputStream, List<ObservableInputStream.Observer>) - Constructor for class org.apache.commons.io.input.ObservableInputStream
-
Creates a new ObservableInputStream for the given InputStream.
- ObservableInputStream(InputStream, ObservableInputStream.Observer...) - Constructor for class org.apache.commons.io.input.ObservableInputStream
-
Creates a new ObservableInputStream for the given InputStream.
- 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
- observers - Variable in class org.apache.commons.io.input.ObservableInputStream
- observers - Variable in class org.apache.commons.io.monitor.FileAlterationMonitor
- of(Iterable<T>) - Static method in interface org.apache.commons.io.function.IOStream
-
Null-safe version of
StreamSupport.stream(java.util.Spliterator, boolean)
. - of(Iterable<T>) - Static method in class org.apache.commons.io.function.IOStreams
-
Null-safe version of
StreamSupport.stream(java.util.Spliterator, boolean)
. - of(Stream<T>) - Static method in class org.apache.commons.io.function.IOStreams
- 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. - of(T...) - Static method in class org.apache.commons.io.function.IOStreams
-
Null-safe version of
Stream.of(Object[])
. - offset - Variable in class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream.Builder
- offset - Variable in class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream
-
Current offset in the data buffer.
- on(Appendable) - Static method in interface org.apache.commons.io.output.UncheckedAppendable
-
Creates a new instance on the given Appendable.
- onAccept - Variable in class org.apache.commons.io.filefilter.AbstractFileFilter
-
What to do when this filter accepts.
- onClose(Runnable) - Method in class org.apache.commons.io.function.UncheckedIOBaseStream
- 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. - onReject - Variable in class org.apache.commons.io.filefilter.AbstractFileFilter
-
What to do when this filter rejects.
- 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.
- open(URI) - Static method in class org.apache.commons.io.CloseableURLConnection
- open(URL) - Static method in class org.apache.commons.io.CloseableURLConnection
- OPEN_OPTIONS_APPEND - Static variable in class org.apache.commons.io.file.PathUtils
- OPEN_OPTIONS_TRUNCATE - Static variable in class org.apache.commons.io.file.PathUtils
- 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)
. - openInstant - Variable in class org.apache.commons.io.input.TimestampedObserver
- openOptions - Variable in class org.apache.commons.io.build.AbstractStreamBuilder
- 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. - openProcess(String[]) - Method in class org.apache.commons.io.FileSystemUtils
-
Deprecated.Opens the process to the operating system.
- or(IOFileFilter) - Method in class org.apache.commons.io.filefilter.FalseFileFilter
- or(IOFileFilter) - Method in interface org.apache.commons.io.filefilter.IOFileFilter
-
Creates 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(int) - Constructor for class org.apache.commons.io.filefilter.OrFileFilter
-
Constructs a new instance with the given initial capacity.
- OrFileFilter(ArrayList<IOFileFilter>) - Constructor for class org.apache.commons.io.filefilter.OrFileFilter
-
Constructs a new instance with the given initial list.
- 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.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
-
Provides various
Comparator
implementations forFile
s. - 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.
- origin - Variable in class org.apache.commons.io.build.AbstractOrigin
-
The non-null origin.
- origin - Variable in class org.apache.commons.io.build.AbstractOriginSupplier
-
The underlying origin.
- OS - Static variable in class org.apache.commons.io.FileSystemUtils
-
Deprecated.The operating system flag.
- OS_NAME_WINDOWS_PREFIX - Static variable in enum org.apache.commons.io.FileSystem
-
The prefix String for all Windows OS.
- OTHER - Static variable in class org.apache.commons.io.FileSystemUtils
-
Deprecated.Operating system state flag for neither Unix nor Windows.
- OTHER_SEPARATOR - Static variable in class org.apache.commons.io.FilenameUtils
-
The separator character that is the opposite of the system separator.
- out - Variable in class org.apache.commons.io.output.LockableFileWriter
-
The writer to decorate.
- out - Variable in class org.apache.commons.io.output.XmlStreamWriter
- outputFile - Variable in class org.apache.commons.io.output.DeferredFileOutputStream.Builder
- outputPath - Variable in class org.apache.commons.io.output.DeferredFileOutputStream
-
The file to which output will be directed if the threshold is exceeded.
- outputStreamGetter - Variable in class org.apache.commons.io.output.ThresholdingOutputStream
-
Gets the output stream.
- OutputStreamOrigin(OutputStream) - Constructor for class org.apache.commons.io.build.AbstractOrigin.OutputStreamOrigin
-
Constructs a new instance for the given origin.
- outputStreamThreadLocal - Variable in class org.apache.commons.io.output.DemuxOutputStream
- 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 - Variable in class org.apache.commons.io.file.CleaningPathVisitor
- overrideReadOnly - Variable in class org.apache.commons.io.file.DeletingPathVisitor
- overrideReadOnly(DeleteOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Returns true if the given options contain
StandardDeleteOption.OVERRIDE_READ_ONLY
. - 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()
. - parallel() - Method in class org.apache.commons.io.function.UncheckedIOBaseStream
- parent - Variable in class org.apache.commons.io.monitor.FileEntry
- parseByteOrder(String) - Static method in class org.apache.commons.io.ByteOrderParser
-
Parses the String argument as a
ByteOrder
. - parseBytes(String, String) - Method in class org.apache.commons.io.FileSystemUtils
-
Deprecated.Parses the bytes from a string.
- parseDir(String, String) - Method in class org.apache.commons.io.FileSystemUtils
-
Deprecated.Parses the Windows dir response last line
- path - Variable in class org.apache.commons.io.FileCleaningTracker.Tracker
-
The full path to the file being tracked.
- path - Variable in class org.apache.commons.io.filefilter.FileEqualsFileFilter
- path - Variable in class org.apache.commons.io.filefilter.PathEqualsFileFilter
- path - Variable in class org.apache.commons.io.input.Tailer.TailablePath
- 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
) - pathCounters - Variable in class org.apache.commons.io.file.CountingPathVisitor
- 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 - Variable in class org.apache.commons.io.file.DirectoryStreamFilter
- PathFilter - Interface in org.apache.commons.io.file
-
A filter for
Path
s. - PathOrigin(Path) - Constructor for class org.apache.commons.io.build.AbstractOrigin.PathOrigin
-
Constructs a new instance for the given origin.
- pathToString - Variable in class org.apache.commons.io.filefilter.RegexFileFilter
-
How convert a path to a string.
- PathUtils - Class in org.apache.commons.io.file
-
NIO Path utilities.
- PathUtils() - Constructor for class org.apache.commons.io.file.PathUtils
-
Does allow to instantiate.
- PathUtils.RelativeSortedPaths - Class in org.apache.commons.io.file
-
Private worker/holder that computes and tracks relative path names and their equality.
- pathVisitor - Variable in class org.apache.commons.io.filefilter.PathVisitorFileFilter
- 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.
- pattern - Variable in class org.apache.commons.io.filefilter.RegexFileFilter
-
The regular expression pattern that will be used to match file names.
- pattern - Variable in class org.apache.commons.io.serialization.RegexpClassNameMatcher
- pattern - Variable in class org.apache.commons.io.serialization.WildcardClassNameMatcher
- 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(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
-
Creates 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
-
Creates a new instance, which filters the given input stream, and uses the given buffer size.
- performCommand(String[], int, Duration) - Method in class org.apache.commons.io.FileSystemUtils
-
Deprecated.Performs an OS command.
- 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
buf
. - position - Variable in class org.apache.commons.io.input.CircularInputStream
- position - Variable in class org.apache.commons.io.input.NullInputStream
- position - Variable in class org.apache.commons.io.input.NullReader
- POSIX_UNIX - Static variable in class org.apache.commons.io.FileSystemUtils
-
Deprecated.Operating system state flag for Posix flavour Unix.
- 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
- prefix - Variable in class org.apache.commons.io.output.DeferredFileOutputStream.Builder
- prefix - Variable in class org.apache.commons.io.output.DeferredFileOutputStream
-
The temporary file prefix.
- prefixes - Variable in class org.apache.commons.io.filefilter.PrefixFileFilter
-
The file name prefixes to search for
- 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
-
Return a byte value for the
read()
method. - processBytes(byte[], int, int) - Method in class org.apache.commons.io.input.NullInputStream
-
Process 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. - processHttpStream(BOMInputStream, BOMInputStream, String, boolean) - Method in class org.apache.commons.io.input.XmlStreamReader
-
Processes an HTTP stream.
- processInput(boolean) - Method in class org.apache.commons.io.output.WriterOutputStream
-
Decode the contents of the input ByteBuffer into a CharBuffer.
- prologWriter - Variable in class org.apache.commons.io.output.XmlStreamWriter
- propagateClose - Variable in class org.apache.commons.io.input.BoundedInputStream
-
Flag if close should be propagated.
- providers - Variable in class org.apache.commons.io.file.spi.FileSystemProviders
- 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
-
Creates a new proxy collection writer.
- ProxyCollectionWriter(Collection<Writer>) - Constructor for class org.apache.commons.io.output.ProxyCollectionWriter
-
Creates a new proxy collection writer.
- ProxyInputStream - 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.
- ProxyInputStream(InputStream) - Constructor for class org.apache.commons.io.input.ProxyInputStream
-
Constructs a new ProxyInputStream.
- 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
- q - Variable in class org.apache.commons.io.FileCleaningTracker
-
Queue of
FileCleaningTracker.Tracker
instances being watched. - 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(BlockingQueue<Integer>, Duration) - Constructor for class org.apache.commons.io.input.QueueInputStream
-
Constructs a new instance with given queue and timeout.
- QueueInputStream.Builder - Class in org.apache.commons.io.input
-
Builds a new
QueueInputStream
instance. - 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
- RAF_READ_ONLY_MODE - Static variable in class org.apache.commons.io.input.Tailer
- randomAccessFile - Variable in class org.apache.commons.io.input.RandomAccessFileInputStream.Builder
- randomAccessFile - Variable in class org.apache.commons.io.input.RandomAccessFileInputStream
- randomAccessFile - Variable in class org.apache.commons.io.input.Tailer.RandomAccessFileBridge
- RandomAccessFileBridge(File, String) - Constructor for class org.apache.commons.io.input.Tailer.RandomAccessFileBridge
- 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
instance. - RandomAccessFileMode - Enum in org.apache.commons.io
-
Access modes and factory methods for
RandomAccessFile
. - RandomAccessFileMode(String) - Constructor for enum org.apache.commons.io.RandomAccessFileMode
- RandomAccessFiles - Class in org.apache.commons.io
-
Works on RandomAccessFile.
- RandomAccessFiles() - Constructor for class org.apache.commons.io.RandomAccessFiles
- RAW_EX_1 - Static variable in class org.apache.commons.io.input.XmlStreamReader
- RAW_EX_2 - Static variable in class org.apache.commons.io.input.XmlStreamReader
- 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
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
-
Read 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
read()
method. - 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.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
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
-
Read 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
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 class org.apache.commons.io.input.Tailer.RandomAccessFileBridge
- 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
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.MemoryMappedFileInputStream
- read(byte[], int, int) - Method in class org.apache.commons.io.input.NullInputStream
-
Read 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
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.XmlStreamReader
-
Reads the underlying reader's
read(char[], int, int)
method. - read(InputStream) - Static method in class org.apache.commons.io.EndianUtils
-
Reads the next byte from the input stream.
- 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(IOTriFunction<byte[], Integer, Integer, Integer>, byte[], int, int) - Static method in class org.apache.commons.io.IOUtils
-
Reads bytes from an input.
- READ_ONLY - Enum constant in enum org.apache.commons.io.RandomAccessFileMode
-
Mode
"r"
opens 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
-
Mode
"rw"
opens for reading and writing. - READ_WRITE_SYNC_ALL - Enum constant in enum org.apache.commons.io.RandomAccessFileMode
-
Mode
"rws"
opens 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
-
Mode
"rwd"
open 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. - readAborted - Variable in class org.apache.commons.io.input.ReadAheadInputStream
- readAheadBuffer - Variable in class org.apache.commons.io.input.ReadAheadInputStream
- 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(InputStream, int, ExecutorService, boolean) - Constructor for class org.apache.commons.io.input.ReadAheadInputStream
-
Creates an instance with the specified buffer size and read-ahead threshold
- ReadAheadInputStream.Builder - Class in org.apache.commons.io.input
-
Builds a new
ReadAheadInputStream
instance. - readAheadLimit - Variable in class org.apache.commons.io.input.BoundedReader
- 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
. - readAsync() - Method in class org.apache.commons.io.input.ReadAheadInputStream
-
Read data from underlyingInputStream to readAheadBuffer asynchronously.
- 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
-
Deprecated.Will be removed in 3.0.0 in favor of
PathUtils.readBasicFileAttributes(Path, LinkOption...)
. - 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()
!= 0 - 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 character delegating to
SwappedDataInputStream.readShort()
. - 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
-
Delegates to
EndianUtils.readSwappedDouble(InputStream)
. - reader - Variable in class org.apache.commons.io.input.ReaderInputStream
- reader - Variable in class org.apache.commons.io.input.SequenceReader
- reader - Variable in class org.apache.commons.io.input.XmlStreamReader
- 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
instance. - ReaderOrigin(Reader) - Constructor for class org.apache.commons.io.build.AbstractOrigin.ReaderOrigin
-
Constructs a new instance for the given origin.
- readers - Variable in class org.apache.commons.io.input.SequenceReader
- readException - Variable in class org.apache.commons.io.input.ReadAheadInputStream
- 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.2.5 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.
- readFirstBytes() - Method in class org.apache.commons.io.input.BOMInputStream
-
This method reads and either preserves or skips the first bytes in the stream.
- readFloat() - Method in class org.apache.commons.io.input.SwappedDataInputStream
-
Delegates to
EndianUtils.readSwappedFloat(InputStream)
. - 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.
- readIfSymbolicLink(Path) - Static method in class org.apache.commons.io.file.PathUtils
- readInProgress - Variable in class org.apache.commons.io.input.ReadAheadInputStream
- readInt() - Method in class org.apache.commons.io.input.SwappedDataInputStream
-
Delegates to
EndianUtils.readSwappedInteger(InputStream)
. - readlimit - Variable in class org.apache.commons.io.input.NullInputStream
- readlimit - Variable in class org.apache.commons.io.input.NullReader
- readLine() - Method in class org.apache.commons.io.input.ReversedLinesFileReader.FilePart
-
Reads a line.
- 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
. - 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.2.5 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.2.5 use
IOUtils.readLines(InputStream, Charset)
instead - readLines(InputStream, String) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents of an
InputStream
as a list of Strings, one entry per line, using the specified character encoding. - readLines(InputStream, Charset) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents of an
InputStream
as a list of Strings, one entry per line, using the specified character encoding. - readLines(Reader) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents of a
Reader
as a list of Strings, one entry per line. - readLines(Tailer.RandomAccessResourceBridge) - Method in class org.apache.commons.io.input.Tailer
-
Reads new lines.
- readLong() - Method in class org.apache.commons.io.input.SwappedDataInputStream
-
Delegates to
EndianUtils.readSwappedLong(InputStream)
. - readObject(ObjectInputStream) - Method in class org.apache.commons.io.monitor.SerializableFileTime
- readOsFileAttributes(Path, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Reads the PosixFileAttributes or DosFileAttributes from the given path.
- readPosixFileAttributes(Path, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Reads the PosixFileAttributes from the given path.
- readResolve() - Method in enum org.apache.commons.io.IOCase
-
Replaces the enumeration from the stream with a real one.
- readShort() - Method in class org.apache.commons.io.input.SwappedDataInputStream
-
Delegates to
EndianUtils.readSwappedShort(InputStream)
. - readString(Path, Charset) - Static method in class org.apache.commons.io.file.PathUtils
-
Reads the given path as a String.
- readSwappedDouble(byte[], int) - Static method in class org.apache.commons.io.EndianUtils
-
Reads a "double" value from a byte array at a given offset.
- readSwappedDouble(InputStream) - Static method in class org.apache.commons.io.EndianUtils
-
Reads a "double" value from an InputStream.
- readSwappedFloat(byte[], int) - Static method in class org.apache.commons.io.EndianUtils
-
Reads a "float" value from a byte array at a given offset.
- readSwappedFloat(InputStream) - Static method in class org.apache.commons.io.EndianUtils
-
Reads a "float" value from an InputStream.
- readSwappedInteger(byte[], int) - Static method in class org.apache.commons.io.EndianUtils
-
Reads an "int" value from a byte array at a given offset.
- readSwappedInteger(InputStream) - Static method in class org.apache.commons.io.EndianUtils
-
Reads an "int" value from an InputStream.
- readSwappedLong(byte[], int) - Static method in class org.apache.commons.io.EndianUtils
-
Reads a "long" value from a byte array at a given offset.
- readSwappedLong(InputStream) - Static method in class org.apache.commons.io.EndianUtils
-
Reads a "long" value from an InputStream.
- readSwappedShort(byte[], int) - Static method in class org.apache.commons.io.EndianUtils
-
Reads a "short" value from a byte array at a given offset.
- readSwappedShort(InputStream) - Static method in class org.apache.commons.io.EndianUtils
-
Reads a "short" value from an InputStream.
- readSwappedUnsignedInteger(byte[], int) - Static method in class org.apache.commons.io.EndianUtils
-
Reads an unsigned integer (32-bit) value from a byte array at a given offset.
- readSwappedUnsignedInteger(InputStream) - Static method in class org.apache.commons.io.EndianUtils
-
Reads an unsigned integer (32-bit) from an InputStream.
- readSwappedUnsignedShort(byte[], int) - Static method in class org.apache.commons.io.EndianUtils
-
Reads an unsigned short (16-bit) value from a byte array at a given offset.
- readSwappedUnsignedShort(InputStream) - Static method in class org.apache.commons.io.EndianUtils
-
Reads an unsigned short (16-bit) from an InputStream.
- readSymbolicLink(Path) - Static method in class org.apache.commons.io.file.FilesUncheck
- readUnsignedByte() - Method in class org.apache.commons.io.input.SwappedDataInputStream
-
Invokes the delegate's
read()
method. - readUnsignedShort() - Method in class org.apache.commons.io.input.SwappedDataInputStream
-
Delegates to
EndianUtils.readSwappedUnsignedShort(InputStream)
. - readUTF() - Method in class org.apache.commons.io.input.SwappedDataInputStream
-
Not currently supported - throws
UnsupportedOperationException
. - readWithUpdate() - Method in class org.apache.commons.io.input.UnixLineEndingInputStream
-
Reads the next item from the target, updating internal flags in the process
- readWithUpdate() - Method in class org.apache.commons.io.input.WindowsLineEndingInputStream
-
Reads the next item from the target, updating internal flags in the process
- ready() - Method in class org.apache.commons.io.input.BrokenReader
-
Throws the configured exception.
- ready() - Method in class org.apache.commons.io.input.CharSequenceReader
-
Tells whether this stream is ready to be read.
- ready() - Method in class org.apache.commons.io.input.ProxyReader
-
Invokes the delegate's
ready()
method. - ready() - Method in class org.apache.commons.io.input.UncheckedBufferedReader
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - ready() - Method in class org.apache.commons.io.input.UncheckedFilterReader
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - reaper - Variable in class org.apache.commons.io.FileCleaningTracker
-
The thread that will clean up registered files.
- Reaper() - Constructor for class org.apache.commons.io.FileCleaningTracker.Reaper
-
Constructs a new Reaper
- reduce(IOBinaryOperator<T>) - Method in interface org.apache.commons.io.function.IOStream
- reduce(T, IOBinaryOperator<T>) - Method in interface org.apache.commons.io.function.IOStream
- reduce(U, IOBiFunction<U, ? super T, U>, IOBinaryOperator<U>) - Method in interface org.apache.commons.io.function.IOStream
- refill() - Method in class org.apache.commons.io.input.BufferedFileChannelInputStream
-
Checks whether data is left to be read from the input stream.
- refresh(File) - Method in class org.apache.commons.io.monitor.FileEntry
-
Refreshes the attributes from the
File
, indicating whether the file has changed. - REG_NAME_PART_PATTERN - Static variable in class org.apache.commons.io.FilenameUtils
- RegexFileFilter - Class in org.apache.commons.io.filefilter
-
Filters files using supplied regular expression(s).
- RegexFileFilter(String) - Constructor for class org.apache.commons.io.filefilter.RegexFileFilter
-
Constructs a new regular expression filter.
- RegexFileFilter(String, int) - Constructor for class org.apache.commons.io.filefilter.RegexFileFilter
-
Constructs a new regular expression filter with the specified flags.
- RegexFileFilter(String, IOCase) - Constructor for class org.apache.commons.io.filefilter.RegexFileFilter
-
Constructs a new regular expression filter with the specified flags case sensitivity.
- RegexFileFilter(Pattern) - Constructor for class org.apache.commons.io.filefilter.RegexFileFilter
-
Constructs a new regular expression filter for a compiled regular expression
- RegexFileFilter(Pattern, Function<Path, String>) - Constructor for class org.apache.commons.io.filefilter.RegexFileFilter
-
Constructs a new regular expression filter for a compiled regular expression
- RegexpClassNameMatcher - Class in org.apache.commons.io.serialization
-
A
ClassNameMatcher
that uses regular expressions. - RegexpClassNameMatcher(String) - Constructor for class org.apache.commons.io.serialization.RegexpClassNameMatcher
-
Constructs an object based on the specified regular expression.
- RegexpClassNameMatcher(Pattern) - Constructor for class org.apache.commons.io.serialization.RegexpClassNameMatcher
-
Constructs an object based on the specified pattern.
- reject(Class<?>...) - Method in class org.apache.commons.io.serialization.ValidatingObjectInputStream
-
Reject the specified classes for deserialization, even if they are otherwise accepted.
- reject(String...) - Method in class org.apache.commons.io.serialization.ValidatingObjectInputStream
-
Reject the wildcard specified classes for deserialization, even if they are otherwise accepted.
- reject(Pattern) - Method in class org.apache.commons.io.serialization.ValidatingObjectInputStream
-
Reject class names that match the supplied pattern for deserialization, even if they are otherwise accepted.
- reject(ClassNameMatcher) - Method in class org.apache.commons.io.serialization.ValidatingObjectInputStream
-
Reject class names where the supplied ClassNameMatcher matches for deserialization, even if they are otherwise accepted.
- rejectMatchers - Variable in class org.apache.commons.io.serialization.ValidatingObjectInputStream
- relativeFileList1 - Variable in class org.apache.commons.io.file.PathUtils.RelativeSortedPaths
- relativeFileList2 - Variable in class org.apache.commons.io.file.PathUtils.RelativeSortedPaths
- RelativeSortedPaths(Path, Path, int, LinkOption[], FileVisitOption[]) - Constructor for class org.apache.commons.io.file.PathUtils.RelativeSortedPaths
-
Constructs and initializes a new instance by accumulating directory and file info.
- relativize(Collection<Path>, Path, boolean, Comparator<? super Path>) - Static method in class org.apache.commons.io.file.PathUtils
-
Relativizes all files in the given
collection
against aparent
. - relativizeDirectories(Path, boolean, Comparator<? super Path>) - Method in class org.apache.commons.io.file.AccumulatorPathVisitor
-
Relativizes each directory path with
Path.relativize(Path)
against the givenparent
, optionally sorting the result. - relativizeFiles(Path, boolean, Comparator<? super Path>) - Method in class org.apache.commons.io.file.AccumulatorPathVisitor
-
Relativizes each file path with
Path.relativize(Path)
against the givenparent
, optionally sorting the result. - remove() - Method in interface org.apache.commons.io.function.IOIterator
-
Like
Iterator.remove()
. - remove() - Method in class org.apache.commons.io.function.UncheckedIOIterator
- remove() - Method in class org.apache.commons.io.LineIterator
-
Unsupported.
- remove(ObservableInputStream.Observer) - Method in class org.apache.commons.io.input.ObservableInputStream
-
Removes an Observer.
- removeAllObservers() - Method in class org.apache.commons.io.input.ObservableInputStream
-
Removes all Observers.
- removeExtension(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Removes the extension from a fileName.
- removeFileFilter(IOFileFilter) - Method in class org.apache.commons.io.filefilter.AndFileFilter
-
Removes the specified file filter.
- removeFileFilter(IOFileFilter) - Method in interface org.apache.commons.io.filefilter.ConditionalFileFilter
-
Removes the specified file filter.
- removeFileFilter(IOFileFilter) - Method in class org.apache.commons.io.filefilter.OrFileFilter
-
Removes the specified file filter.
- removeListener(FileAlterationListener) - Method in class org.apache.commons.io.monitor.FileAlterationObserver
-
Removes a file system listener.
- removeObserver(FileAlterationObserver) - Method in class org.apache.commons.io.monitor.FileAlterationMonitor
-
Removes a file system observer from this monitor.
- reOpen - Variable in class org.apache.commons.io.input.Tailer.Builder
- reOpen - Variable in class org.apache.commons.io.input.Tailer
-
Whether to close and reopen the file whilst waiting for more input.
- repeatedContent - Variable in class org.apache.commons.io.input.CircularInputStream
- replace(String, char, char) - Static method in enum org.apache.commons.io.FileSystem
-
Null-safe replace.
- requireAbsent(File, String) - Static method in class org.apache.commons.io.FileUtils
- requireCanonicalPathsNotEquals(File, File) - Static method in class org.apache.commons.io.FileUtils
-
Throws IllegalArgumentException if the given files' canonical representations are equal.
- requireCanWrite(File, String) - Static method in class org.apache.commons.io.FileUtils
-
Throws an
IllegalArgumentException
if the file is not writable. - requiredCharsets() - Static method in class org.apache.commons.io.Charsets
-
Constructs a sorted map from canonical charset names to charset objects required of every implementation of the Java platform.
- requireDirectory(File, String) - Static method in class org.apache.commons.io.FileUtils
-
Requires that the given
File
is a directory. - requireDirectoryExists(File, String) - Static method in class org.apache.commons.io.FileUtils
-
Requires that the given
File
exists and is a directory. - requireDirectoryIfExists(File, String) - Static method in class org.apache.commons.io.FileUtils
-
Requires that the given
File
is a directory if it exists. - requireExists(File, String) - Static method in class org.apache.commons.io.FileUtils
-
Requires that the given
File
exists and throws anIllegalArgumentException
if it doesn't. - requireExists(Path, String, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Requires that the given
File
exists and throws anIllegalArgumentException
if it doesn't. - requireExistsChecked(File, String) - Static method in class org.apache.commons.io.FileUtils
-
Requires that the given
File
exists and throws anFileNotFoundException
if it doesn't. - requireFile(File, String) - Static method in class org.apache.commons.io.FileUtils
-
Requires that the given
File
is a file. - requireFileCopy(File, File) - Static method in class org.apache.commons.io.FileUtils
-
Requires parameter attributes for a file copy operation.
- requireFileIfExists(File, String) - Static method in class org.apache.commons.io.FileUtils
-
Requires that the given
File
is a file if it exists. - requireNonNullChars(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Checks the input for null characters (
U+0000
), a sign of unsanitized data being passed to file level functions. - requireWildcards(T) - Static method in class org.apache.commons.io.filefilter.WildcardFileFilter
- reservedFileNames - Variable in enum org.apache.commons.io.FileSystem
- reservedFileNamesExtensions - Variable in enum org.apache.commons.io.FileSystem
- reset() - Method in class org.apache.commons.io.file.Counters.AbstractPathCounters
- reset() - Method in class org.apache.commons.io.file.Counters.BigIntegerCounter
- reset() - Method in interface org.apache.commons.io.file.Counters.Counter
-
Resets this count to 0.
- reset() - Method in class org.apache.commons.io.file.Counters.LongCounter
- reset() - Method in interface org.apache.commons.io.file.Counters.PathCounters
-
Resets the counts to 0.
- reset() - Method in class org.apache.commons.io.input.BOMInputStream
-
Invokes the delegate's
reset()
method. - reset() - Method in class org.apache.commons.io.input.BoundedInputStream
-
Invokes the delegate's
reset()
method. - reset() - Method in class org.apache.commons.io.input.BoundedReader
-
Resets the target to the latest mark,
- reset() - Method in class org.apache.commons.io.input.BrokenInputStream
-
Throws the configured exception.
- reset() - Method in class org.apache.commons.io.input.BrokenReader
-
Throws the configured exception.
- reset() - Method in class org.apache.commons.io.input.CharSequenceInputStream
- reset() - Method in class org.apache.commons.io.input.CharSequenceReader
-
Reset the reader to the last marked position (or the beginning if mark has not been called).
- reset() - Method in class org.apache.commons.io.input.MarkShieldInputStream
- reset() - Method in class org.apache.commons.io.input.NullInputStream
-
Reset the stream to the point when mark was last called.
- reset() - Method in class org.apache.commons.io.input.NullReader
-
Resets the stream to the point when mark was last called.
- reset() - Method in class org.apache.commons.io.input.ProxyInputStream
-
Invokes the delegate's
reset()
method. - reset() - Method in class org.apache.commons.io.input.ProxyReader
-
Invokes the delegate's
reset()
method. - reset() - Method in class org.apache.commons.io.input.UncheckedBufferedReader
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - reset() - Method in class org.apache.commons.io.input.UncheckedFilterInputStream
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - reset() - Method in class org.apache.commons.io.input.UncheckedFilterReader
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - reset() - Static method in class org.apache.commons.io.input.UnsupportedOperationExceptions
-
Creates a new instance of UnsupportedOperationException for a
reset
method. - reset() - Method in class org.apache.commons.io.input.UnsynchronizedBufferedInputStream
-
Resets this stream to the last marked location.
- reset() - Method in class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream
- reset() - Method in class org.apache.commons.io.input.UnsynchronizedFilterInputStream
-
Resets this stream to the last marked location.
- reset() - Method in class org.apache.commons.io.output.AbstractByteArrayOutputStream
- reset() - Method in class org.apache.commons.io.output.ByteArrayOutputStream
- reset() - Method in class org.apache.commons.io.output.UnsynchronizedByteArrayOutputStream
- resetByteCount() - Method in class org.apache.commons.io.input.CountingInputStream
-
Resets the byte count back to 0.
- resetByteCount() - Method in class org.apache.commons.io.output.CountingOutputStream
-
Set the byte count back to 0.
- resetByteCount() - Method in class org.apache.commons.io.output.ThresholdingOutputStream
-
Resets the byteCount to zero.
- resetCount() - Method in class org.apache.commons.io.input.CountingInputStream
-
Resets the byte count back to 0.
- resetCount() - Method in class org.apache.commons.io.output.CountingOutputStream
-
Set the byte count back to 0.
- resetImpl() - Method in class org.apache.commons.io.output.AbstractByteArrayOutputStream
- resolveClass(ObjectStreamClass) - Method in class org.apache.commons.io.input.ClassLoaderObjectInputStream
-
Resolve a class specified by the descriptor using the specified ClassLoader or the super ClassLoader.
- resolveClass(ObjectStreamClass) - Method in class org.apache.commons.io.serialization.ValidatingObjectInputStream
- resolveProxyClass(String[]) - Method in class org.apache.commons.io.input.ClassLoaderObjectInputStream
-
Create a proxy class that implements the specified interfaces using the specified ClassLoader or the super ClassLoader.
- resolveRelativeAsString(Path) - Method in class org.apache.commons.io.file.CopyDirectoryVisitor
-
Relativizes against
sourceDirectory
, then resolves againsttargetDirectory
. - resourceToByteArray(String) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents of a resource as a byte array.
- resourceToByteArray(String, ClassLoader) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents of a resource as a byte array.
- resourceToString(String, Charset) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents of a resource as a String using the specified character encoding.
- resourceToString(String, Charset, ClassLoader) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents of a resource as a String using the specified character encoding.
- resourceToURL(String) - Static method in class org.apache.commons.io.IOUtils
-
Gets a URL pointing to the given resource.
- resourceToURL(String, ClassLoader) - Static method in class org.apache.commons.io.IOUtils
-
Gets a URL pointing to the given resource.
- rethrow(Throwable) - Static method in class org.apache.commons.io.function.Erase
-
Throws the given throwable.
- reuseBuffers - Variable in class org.apache.commons.io.output.AbstractByteArrayOutputStream
-
Flag to indicate if the buffers can be reused after reset
- ReversedLinesFileReader - Class in org.apache.commons.io.input
-
Reads lines in a file reversely (similar to a BufferedReader, but starting at the last line).
- ReversedLinesFileReader(File) - Constructor for class org.apache.commons.io.input.ReversedLinesFileReader
-
Deprecated.Use
ReaderInputStream.builder()
instead - ReversedLinesFileReader(File, int, String) - Constructor for class org.apache.commons.io.input.ReversedLinesFileReader
-
Deprecated.Use
ReaderInputStream.builder()
instead - ReversedLinesFileReader(File, int, Charset) - Constructor for class org.apache.commons.io.input.ReversedLinesFileReader
-
Deprecated.Use
ReaderInputStream.builder()
instead - ReversedLinesFileReader(File, Charset) - Constructor for class org.apache.commons.io.input.ReversedLinesFileReader
-
Deprecated.Use
ReaderInputStream.builder()
instead - ReversedLinesFileReader(Path, int, String) - Constructor for class org.apache.commons.io.input.ReversedLinesFileReader
-
Deprecated.Use
ReaderInputStream.builder()
instead - ReversedLinesFileReader(Path, int, Charset) - Constructor for class org.apache.commons.io.input.ReversedLinesFileReader
-
Deprecated.Use
ReaderInputStream.builder()
instead - ReversedLinesFileReader(Path, Charset) - Constructor for class org.apache.commons.io.input.ReversedLinesFileReader
-
Deprecated.Use
ReaderInputStream.builder()
instead - ReversedLinesFileReader.Builder - Class in org.apache.commons.io.input
-
Builds a new
ReversedLinesFileReader
instance. - ReversedLinesFileReader.FilePart - Class in org.apache.commons.io.input
- ReverseFileComparator - Class in org.apache.commons.io.comparator
-
Reverses the result of comparing two
File
objects using the delegateComparator
. - ReverseFileComparator(Comparator<File>) - Constructor for class org.apache.commons.io.comparator.ReverseFileComparator
-
Constructs an instance with the specified delegate
Comparator
. - rollOver() - Method in class org.apache.commons.io.input.ReversedLinesFileReader.FilePart
-
Handles block rollover
- rootEntry - Variable in class org.apache.commons.io.monitor.FileAlterationObserver
- run - Variable in class org.apache.commons.io.input.Tailer
-
The tailer will run as long as this value is true.
- run() - Method in class org.apache.commons.io.FileCleaningTracker.Reaper
-
Runs the reaper thread that will delete files as their associated marker objects are reclaimed by the garbage collector.
- run() - Method in interface org.apache.commons.io.function.IORunnable
-
Like
Runnable.run()
but throwsIOException
. - run() - Method in class org.apache.commons.io.input.Tailer
-
Follows changes in the file, calling
TailerListener.handle(String)
with each new line. - run() - Method in class org.apache.commons.io.monitor.FileAlterationMonitor
-
Runs this monitor.
- run() - Method in class org.apache.commons.io.ThreadMonitor
-
Sleeps until the specified timeout amount and then interrupt the thread being monitored.
- run(IORunnable) - Static method in class org.apache.commons.io.function.Erase
-
Delegates to the given
IORunnable
but erases itsIOException
for the compiler, while still throwing the exception at runtime. - run(IORunnable) - Static method in class org.apache.commons.io.function.Uncheck
-
Runs an IO runnable.
- running - Variable in class org.apache.commons.io.monitor.FileAlterationMonitor
S
- 3. Stopping a Tailer - Search tag in class org.apache.commons.io.input.Tailer
- Section
- SCRATCH_BYTE_BUFFER_RW - Static variable in class org.apache.commons.io.IOUtils
-
Internal byte array buffer, intended for both reading and writing.
- SCRATCH_BYTE_BUFFER_WO - Static variable in class org.apache.commons.io.IOUtils
-
Internal byte array buffer, intended for write only operations.
- SCRATCH_CHAR_BUFFER_RW - Static variable in class org.apache.commons.io.IOUtils
-
Internal char array buffer, intended for both reading and writing.
- SCRATCH_CHAR_BUFFER_WO - Static variable in class org.apache.commons.io.IOUtils
-
Internal char array buffer, intended for write only operations.
- seek(long) - Method in class org.apache.commons.io.input.RandomAccessFileInputStream
-
Delegates to the underlying file.
- seek(long) - Method in class org.apache.commons.io.input.Tailer.RandomAccessFileBridge
- seek(long) - Method in interface org.apache.commons.io.input.Tailer.RandomAccessResourceBridge
-
Sets the file-pointer offset, measured from the beginning of this tailable, at which the next read or write occurs.
- sensitive - Variable in enum org.apache.commons.io.IOCase
-
The sensitivity flag.
- SENSITIVE - Enum constant in enum org.apache.commons.io.IOCase
-
The constant for case-sensitive regardless of operating system.
- separatorsToSystem(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Converts all separators to the system separator.
- separatorsToUnix(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Converts all separators to the Unix separator of forward slash.
- separatorsToWindows(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Converts all separators to the Windows separator of backslash.
- SequenceReader - Class in org.apache.commons.io.input
-
Provides the contents of multiple
Reader
s in sequence. - SequenceReader(Reader...) - Constructor for class org.apache.commons.io.input.SequenceReader
-
Constructs a new instance with readers
- SequenceReader(Iterable<? extends Reader>) - Constructor for class org.apache.commons.io.input.SequenceReader
-
Constructs a new instance with readers
- sequential() - Method in interface org.apache.commons.io.function.IOBaseStream
-
Like
BaseStream.sequential()
. - sequential() - Method in class org.apache.commons.io.function.UncheckedIOBaseStream
- SerializableFileTime - Class in org.apache.commons.io.monitor
-
Wraps a
FileTime
and allows it to be Serializable. - SerializableFileTime(FileTime) - Constructor for class org.apache.commons.io.monitor.SerializableFileTime
- serialVersionUID - Static variable in class org.apache.commons.io.ByteOrderMark
- serialVersionUID - Static variable in class org.apache.commons.io.comparator.CompositeFileComparator
- serialVersionUID - Static variable in class org.apache.commons.io.comparator.DefaultFileComparator
- serialVersionUID - Static variable in class org.apache.commons.io.comparator.DirectoryFileComparator
- serialVersionUID - Static variable in class org.apache.commons.io.comparator.ExtensionFileComparator
- serialVersionUID - Static variable in class org.apache.commons.io.comparator.LastModifiedFileComparator
- serialVersionUID - Static variable in class org.apache.commons.io.comparator.NameFileComparator
- serialVersionUID - Static variable in class org.apache.commons.io.comparator.PathFileComparator
- serialVersionUID - Static variable in class org.apache.commons.io.comparator.ReverseFileComparator
- serialVersionUID - Static variable in class org.apache.commons.io.comparator.SizeFileComparator
- serialVersionUID - Static variable in exception class org.apache.commons.io.DirectoryWalker.CancelException
-
Deprecated.Serialization id.
- serialVersionUID - Static variable in exception class org.apache.commons.io.FileExistsException
-
Defines the serial version UID.
- serialVersionUID - Static variable in class org.apache.commons.io.filefilter.AgeFileFilter
- serialVersionUID - Static variable in class org.apache.commons.io.filefilter.AndFileFilter
- serialVersionUID - Static variable in class org.apache.commons.io.filefilter.CanExecuteFileFilter
- serialVersionUID - Static variable in class org.apache.commons.io.filefilter.CanReadFileFilter
- serialVersionUID - Static variable in class org.apache.commons.io.filefilter.CanWriteFileFilter
- serialVersionUID - Static variable in class org.apache.commons.io.filefilter.DelegateFileFilter
- serialVersionUID - Static variable in class org.apache.commons.io.filefilter.DirectoryFileFilter
- serialVersionUID - Static variable in class org.apache.commons.io.filefilter.EmptyFileFilter
- serialVersionUID - Static variable in class org.apache.commons.io.filefilter.FalseFileFilter
- serialVersionUID - Static variable in class org.apache.commons.io.filefilter.FileFileFilter
- serialVersionUID - Static variable in class org.apache.commons.io.filefilter.HiddenFileFilter
- serialVersionUID - Static variable in class org.apache.commons.io.filefilter.MagicNumberFileFilter
-
The serialization version unique identifier.
- serialVersionUID - Static variable in class org.apache.commons.io.filefilter.NameFileFilter
- serialVersionUID - Static variable in class org.apache.commons.io.filefilter.NotFileFilter
- serialVersionUID - Static variable in class org.apache.commons.io.filefilter.OrFileFilter
- serialVersionUID - Static variable in class org.apache.commons.io.filefilter.PrefixFileFilter
- serialVersionUID - Static variable in class org.apache.commons.io.filefilter.RegexFileFilter
- serialVersionUID - Static variable in class org.apache.commons.io.filefilter.SizeFileFilter
- serialVersionUID - Static variable in class org.apache.commons.io.filefilter.SuffixFileFilter
- serialVersionUID - Static variable in class org.apache.commons.io.filefilter.SymbolicLinkFileFilter
- serialVersionUID - Static variable in class org.apache.commons.io.filefilter.TrueFileFilter
- serialVersionUID - Static variable in class org.apache.commons.io.filefilter.WildcardFileFilter
- serialVersionUID - Static variable in class org.apache.commons.io.filefilter.WildcardFilter
-
Deprecated.
- serialVersionUID - Static variable in class org.apache.commons.io.input.CharSequenceReader
- serialVersionUID - Static variable in exception class org.apache.commons.io.input.XmlStreamReaderException
- serialVersionUID - Static variable in enum org.apache.commons.io.IOCase
-
Serialization version.
- serialVersionUID - Static variable in exception class org.apache.commons.io.IOExceptionList
- serialVersionUID - Static variable in exception class org.apache.commons.io.IOExceptionWithCause
-
Deprecated.Defines the serial version UID.
- serialVersionUID - Static variable in exception class org.apache.commons.io.IOIndexedException
- serialVersionUID - Static variable in class org.apache.commons.io.monitor.FileAlterationObserver
- serialVersionUID - Static variable in class org.apache.commons.io.monitor.FileEntry
- serialVersionUID - Static variable in class org.apache.commons.io.monitor.SerializableFileTime
- serialVersionUID - Static variable in class org.apache.commons.io.output.StringBuilderWriter
- serialVersionUID - Static variable in exception class org.apache.commons.io.TaggedIOException
-
Generated serial version UID.
- setAllowUserInteraction(boolean) - Method in class org.apache.commons.io.CloseableURLConnection
- setAppend(boolean) - Method in class org.apache.commons.io.output.FileWriterWithEncoding.Builder
-
Sets whether or not to append.
- setAppend(boolean) - Method in class org.apache.commons.io.output.LockableFileWriter.Builder
-
Sets whether to append (true) or overwrite (false).
- setAttribute(Path, String, Object, LinkOption...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.setAttribute(Path, String, Object, LinkOption...)
throwingUncheckedIOException
instead ofIOException
. - setBlockingQueue(BlockingQueue<Integer>) - Method in class org.apache.commons.io.input.QueueInputStream.Builder
-
Sets backing queue for the stream.
- setBufferSize(int) - Method in class org.apache.commons.io.build.AbstractStreamBuilder
-
Sets the buffer size.
- setBufferSize(Integer) - Method in class org.apache.commons.io.build.AbstractStreamBuilder
-
Sets the buffer size.
- setBufferSizeDefault(int) - Method in class org.apache.commons.io.build.AbstractStreamBuilder
-
Sets the buffer size for subclasses to initialize.
- setByteArray(byte[]) - Method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Sets a new origin.
- setByteArray(byte[]) - Method in class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream.Builder
- setByteCount(long) - Method in class org.apache.commons.io.output.ThresholdingOutputStream
-
Sets the byteCount to count.
- setByteOrderMarks(ByteOrderMark...) - Method in class org.apache.commons.io.input.BOMInputStream.Builder
-
Sets the ByteOrderMarks to detect and optionally exclude.
- setCharSequence(CharSequence) - Method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Sets a new origin.
- setCharset(String) - Method in class org.apache.commons.io.build.AbstractStreamBuilder
-
Sets the Charset.
- setCharset(String) - Method in class org.apache.commons.io.input.XmlStreamReader.Builder
- setCharset(String) - Method in class org.apache.commons.io.output.WriterOutputStream.Builder
- setCharset(Charset) - Method in class org.apache.commons.io.build.AbstractStreamBuilder
-
Sets the Charset.
- setCharset(Charset) - Method in class org.apache.commons.io.input.CharSequenceInputStream.Builder
- setCharset(Charset) - Method in class org.apache.commons.io.input.ReaderInputStream.Builder
- setCharset(Charset) - Method in class org.apache.commons.io.input.XmlStreamReader.Builder
- setCharset(Charset) - Method in class org.apache.commons.io.output.WriterOutputStream.Builder
- setCharsetDecoder(CharsetDecoder) - Method in class org.apache.commons.io.output.WriterOutputStream.Builder
-
Sets the charset decoder.
- setCharsetDefault(Charset) - Method in class org.apache.commons.io.build.AbstractStreamBuilder
-
Sets the Charset default for subclasses to initialize.
- setCharsetEncoder(CharsetEncoder) - Method in class org.apache.commons.io.input.CharSequenceInputStream.Builder
-
Sets the charset encoder.
- setCharsetEncoder(CharsetEncoder) - Method in class org.apache.commons.io.input.ReaderInputStream.Builder
-
Sets the charset encoder.
- setCharsetEncoder(CharsetEncoder) - Method in class org.apache.commons.io.output.FileWriterWithEncoding.Builder
-
Sets charsetEncoder to use for encoding.
- setChildren(FileEntry...) - Method in class org.apache.commons.io.monitor.FileEntry
-
Sets the directory's files.
- setCloseOnClose(boolean) - Method in class org.apache.commons.io.input.RandomAccessFileInputStream.Builder
-
Sets whether to close the underlying file when this stream is closed.
- setConnectTimeout(int) - Method in class org.apache.commons.io.CloseableURLConnection
- setDefaultUseCaches(boolean) - Method in class org.apache.commons.io.CloseableURLConnection
- setDelayDuration(Duration) - Method in class org.apache.commons.io.input.Tailer.Builder
-
Sets the delay duration.
- setDirectory(boolean) - Method in class org.apache.commons.io.monitor.FileEntry
-
Sets whether the file is a directory or not.
- setDirectory(File) - Method in class org.apache.commons.io.output.DeferredFileOutputStream.Builder
-
Sets the temporary file directory.
- setDoInput(boolean) - Method in class org.apache.commons.io.CloseableURLConnection
- setDoOutput(boolean) - Method in class org.apache.commons.io.CloseableURLConnection
- setDosReadOnly(Path, boolean, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
- setExecutorService(ExecutorService) - Method in class org.apache.commons.io.input.ReadAheadInputStream.Builder
-
Sets the executor service for the read-ahead thread.
- setExecutorService(ExecutorService) - Method in class org.apache.commons.io.input.Tailer.Builder
-
Sets the executor service to use when startThread is true.
- setExists(boolean) - Method in class org.apache.commons.io.monitor.FileEntry
-
Sets whether the file existed the last time it was checked.
- setFile(File) - Method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Sets a new origin.
- setFile(String) - Method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Sets a new origin.
- setFileFilters(List<IOFileFilter>) - Method in class org.apache.commons.io.filefilter.AndFileFilter
-
Sets the list of file filters, replacing any previously configured file filters on this filter.
- setFileFilters(List<IOFileFilter>) - Method in interface org.apache.commons.io.filefilter.ConditionalFileFilter
-
Sets the list of file filters, replacing any previously configured file filters on this filter.
- setFileFilters(List<IOFileFilter>) - Method in class org.apache.commons.io.filefilter.OrFileFilter
-
Sets the list of file filters, replacing any previously configured file filters on this filter.
- setHttpContentType(String) - Method in class org.apache.commons.io.input.XmlStreamReader.Builder
- setIfModifiedSince(long) - Method in class org.apache.commons.io.CloseableURLConnection
- setInclude(boolean) - Method in class org.apache.commons.io.input.BOMInputStream.Builder
-
Sets whether to include the UTF-8 BOM (true) or to exclude it (false).
- setInputStream(InputStream) - Method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Sets a new origin.
- setIoCase(IOCase) - Method in class org.apache.commons.io.filefilter.WildcardFileFilter.Builder
-
Sets how to handle case sensitivity, null means case-sensitive.
- setLastModified(long) - Method in class org.apache.commons.io.monitor.FileEntry
-
Sets the last modified time from the last time it was checked.
- setLastModified(FileTime) - Method in class org.apache.commons.io.monitor.FileEntry
-
Sets the last modified time from the last time it was checked.
- setLastModified(SerializableFileTime) - Method in class org.apache.commons.io.monitor.FileEntry
- setLastModifiedTime(Path) - Static method in class org.apache.commons.io.file.attribute.FileTimes
-
Sets the last modified time of the given file path to now.
- setLastModifiedTime(Path, FileTime) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.setLastModifiedTime(Path, FileTime)
throwingUncheckedIOException
instead ofIOException
. - setLastModifiedTime(Path, Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Sets the given
targetFile
's last modified time to the value fromsourceFile
. - setLength(int) - Method in class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream.Builder
- setLength(long) - Method in class org.apache.commons.io.monitor.FileEntry
-
Sets the length.
- setLenient(boolean) - Method in class org.apache.commons.io.input.XmlStreamReader.Builder
- setLockDirectory(File) - Method in class org.apache.commons.io.output.LockableFileWriter.Builder
-
Sets the directory in which the lock file should be held.
- setLockDirectory(String) - Method in class org.apache.commons.io.output.LockableFileWriter.Builder
-
Sets the directory in which the lock file should be held.
- setMessageDigest(String) - Method in class org.apache.commons.io.input.MessageDigestCalculatingInputStream.Builder
-
Sets the name of the name of the message digest algorithm.
- setMessageDigest(MessageDigest) - Method in class org.apache.commons.io.input.MessageDigestCalculatingInputStream.Builder
-
Sets the message digest.
- setName(String) - Method in class org.apache.commons.io.monitor.FileEntry
-
Sets the file name.
- setOffset(int) - Method in class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream.Builder
- setOpenOptions(OpenOption...) - Method in class org.apache.commons.io.build.AbstractStreamBuilder
-
Sets the OpenOption[].
- setOrigin(AbstractOrigin<?, ?>) - Method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Sets a new origin.
- setOrigin(AbstractOrigin<?, ?>) - Method in class org.apache.commons.io.input.Tailer.Builder
-
Sets the origin.
- setOutputFile(File) - Method in class org.apache.commons.io.output.DeferredFileOutputStream.Builder
-
Sets the file to which data is saved beyond the threshold.
- setOutputStream(OutputStream) - Method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Sets a new origin.
- setOwner(Path, UserPrincipal) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.setOwner(Path, UserPrincipal)
throwingUncheckedIOException
instead ofIOException
. - setPath(String) - Method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Sets a new origin.
- setPath(Path) - Method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Sets a new origin.
- setPosixDeletePermissions(Path, boolean, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
To delete a file in POSIX, you need Write and Execute permissions on its parent directory.
- setPosixFilePermissions(Path, Set<PosixFilePermission>) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.setPosixFilePermissions(Path, Set)
throwingUncheckedIOException
instead ofIOException
. - setPosixPermissions(Path, boolean, List<PosixFilePermission>, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Low-level POSIX permission operation to set permissions.
- setPosixReadOnlyFile(Path, boolean, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
- setPrefix(String) - Method in class org.apache.commons.io.output.DeferredFileOutputStream.Builder
-
Sets the prefix to use for the temporary file.
- setPropagateClose(boolean) - Method in class org.apache.commons.io.input.BoundedInputStream
-
Sets whether the
BoundedInputStream.close()
method should propagate to the underlingInputStream
. - setRandomAccessFile(RandomAccessFile) - Method in class org.apache.commons.io.input.RandomAccessFileInputStream.Builder
-
Sets the RandomAccessFile to stream.
- setReader(Reader) - Method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Sets a new origin.
- setReadOnly(Path, boolean, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Sets the given Path to the
readOnly
value. - setReadTimeout(int) - Method in class org.apache.commons.io.CloseableURLConnection
- setReOpen(boolean) - Method in class org.apache.commons.io.input.Tailer.Builder
-
Sets the re-open behavior.
- setRequestProperty(String, String) - Method in class org.apache.commons.io.CloseableURLConnection
- setStartThread(boolean) - Method in class org.apache.commons.io.input.Tailer.Builder
-
Sets the daemon thread startup behavior.
- setSuffix(String) - Method in class org.apache.commons.io.output.DeferredFileOutputStream.Builder
-
Sets the suffix to use for the temporary file.
- setTailable(Tailer.Tailable) - Method in class org.apache.commons.io.input.Tailer.Builder
-
Sets the tailable.
- setTailerListener(TailerListener) - Method in class org.apache.commons.io.input.Tailer.Builder
-
Sets the listener.
- setTailFromEnd(boolean) - Method in class org.apache.commons.io.input.Tailer.Builder
-
Sets the tail start behavior.
- setThreadFactory(ThreadFactory) - Method in class org.apache.commons.io.monitor.FileAlterationMonitor
-
Sets the thread factory.
- setThreshold(int) - Method in class org.apache.commons.io.output.DeferredFileOutputStream.Builder
-
Sets the number of bytes at which to trigger an event.
- setTimeout(Duration) - Method in class org.apache.commons.io.input.QueueInputStream.Builder
-
Sets the polling timeout.
- setTimes(File, File) - Static method in class org.apache.commons.io.FileUtils
-
Set file lastModifiedTime, lastAccessTime and creationTime to match source file
- setURI(URI) - Method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Sets a new origin.
- setUseCaches(boolean) - Method in class org.apache.commons.io.CloseableURLConnection
- setWildcards(String...) - Method in class org.apache.commons.io.filefilter.WildcardFileFilter.Builder
-
Sets the wildcards to match, not null.
- setWildcards(List<String>) - Method in class org.apache.commons.io.filefilter.WildcardFileFilter.Builder
-
Sets the list of wildcards to match, not null.
- setWriteImmediately(boolean) - Method in class org.apache.commons.io.output.WriterOutputStream.Builder
-
Sets whether the output buffer will be flushed after each write operation (
true
), i.e. - setWriter(Writer) - Method in class org.apache.commons.io.build.AbstractOriginSupplier
-
Sets a new origin.
- SHIFTS - Static variable in class org.apache.commons.io.HexDump
- shutdownExecutorService - Variable in class org.apache.commons.io.input.ReadAheadInputStream
- signalAsyncReadComplete() - Method in class org.apache.commons.io.input.ReadAheadInputStream
- SimplePathVisitor - Class in org.apache.commons.io.file
-
A
SimpleFileVisitor
typed to aPath
. - SimplePathVisitor() - Constructor for class org.apache.commons.io.file.SimplePathVisitor
-
Constructs a new instance.
- SimplePathVisitor(IOBiFunction<Path, IOException, FileVisitResult>) - Constructor for class org.apache.commons.io.file.SimplePathVisitor
-
Constructs a new instance.
- Singleton Instances (thread-safe) - Search tag in package org.apache.commons.io.comparator
- Section
- size - Variable in class org.apache.commons.io.filefilter.SizeFileFilter
-
The size threshold.
- size - Variable in class org.apache.commons.io.input.NullInputStream
- size - Variable in class org.apache.commons.io.input.NullReader
- size() - Method in class org.apache.commons.io.build.AbstractOrigin.ByteArrayOrigin
- size() - Method in class org.apache.commons.io.build.AbstractOrigin.CharSequenceOrigin
- size() - Method in class org.apache.commons.io.build.AbstractOrigin
-
Gets the size of the origin, if possible.
- size() - Method in interface org.apache.commons.io.input.Tailer.Tailable
-
Gets the size of this tailable.
- size() - Method in class org.apache.commons.io.input.Tailer.TailablePath
- size() - Method in class org.apache.commons.io.output.AbstractByteArrayOutputStream
-
Returns the current size of the byte array.
- size() - Method in class org.apache.commons.io.output.ByteArrayOutputStream
- size() - Method in class org.apache.commons.io.output.UnsynchronizedByteArrayOutputStream
- size(Path) - Static method in class org.apache.commons.io.file.FilesUncheck
- size(List<? extends Throwable>) - Static method in exception class org.apache.commons.io.IOExceptionList
- SIZE_COMPARATOR - Static variable in class org.apache.commons.io.comparator.SizeFileComparator
-
Size comparator instance - directories are treated as zero size
- SIZE_REVERSE - Static variable in class org.apache.commons.io.comparator.SizeFileComparator
-
Reverse size comparator instance - directories are treated as zero size
- SIZE_SUMDIR_COMPARATOR - Static variable in class org.apache.commons.io.comparator.SizeFileComparator
-
Size comparator instance which sums the size of a directory's contents using
FileUtils.sizeOfDirectory(File)
- SIZE_SUMDIR_REVERSE - Static variable in class org.apache.commons.io.comparator.SizeFileComparator
-
Reverse size comparator instance which sums the size of a directory's contents using
FileUtils.sizeOfDirectory(File)
- SizeFileComparator - Class in org.apache.commons.io.comparator
-
Compare the length/size of two files for order (see
File.length()
andFileUtils.sizeOfDirectory(File)
). - SizeFileComparator() - Constructor for class org.apache.commons.io.comparator.SizeFileComparator
-
Constructs a file size comparator instance (directories treated as zero size).
- SizeFileComparator(boolean) - Constructor for class org.apache.commons.io.comparator.SizeFileComparator
-
Constructs a file size comparator instance specifying whether the size of the directory contents should be aggregated.
- sizeFileFilter(long) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that returns true if the file is bigger than a certain size.
- sizeFileFilter(long, boolean) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that filters based on file size.
- SizeFileFilter - Class in org.apache.commons.io.filefilter
-
Filters files based on size, can filter either smaller files or files equal to or larger than a given threshold.
- SizeFileFilter(long) - Constructor for class org.apache.commons.io.filefilter.SizeFileFilter
-
Constructs a new size file filter for files equal to or larger than a certain size.
- SizeFileFilter(long, boolean) - Constructor for class org.apache.commons.io.filefilter.SizeFileFilter
-
Constructs a new size file filter for files based on a certain size threshold.
- sizeOf(File) - Static method in class org.apache.commons.io.FileUtils
-
Returns the size of the specified file or directory.
- sizeOf(Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Returns the size of the given file or directory.
- sizeOfAsBigInteger(File) - Static method in class org.apache.commons.io.FileUtils
-
Returns the size of the specified file or directory.
- sizeOfAsBigInteger(Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Returns the size of the given file or directory.
- sizeOfDirectory(File) - Static method in class org.apache.commons.io.FileUtils
-
Counts the size of a directory recursively (sum of the length of all files).
- sizeOfDirectory(Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Counts the size of a directory recursively (sum of the size of all files).
- sizeOfDirectoryAsBigInteger(File) - Static method in class org.apache.commons.io.FileUtils
-
Counts the size of a directory recursively (sum of the length of all files).
- sizeOfDirectoryAsBigInteger(Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Counts the size of a directory recursively (sum of the size of all files).
- sizeRangeFileFilter(long, long) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that accepts files whose size is >= minimum size and <= maximum size.
- skip - Variable in class org.apache.commons.io.file.CleaningPathVisitor
- skip - Variable in class org.apache.commons.io.file.DeletingPathVisitor
- skip - Variable in class org.apache.commons.io.input.AbstractCharacterFilterReader
- skip(long) - Method in interface org.apache.commons.io.function.IOStream
-
Like
Stream.skip(long)
. - skip(long) - Method in class org.apache.commons.io.input.BOMInputStream
-
Invokes the delegate's
skip(long)
method, detecting and optionally skipping BOM. - skip(long) - Method in class org.apache.commons.io.input.BoundedInputStream
-
Invokes the delegate's
skip(long)
method. - skip(long) - Method in class org.apache.commons.io.input.BrokenInputStream
-
Throws the configured exception.
- skip(long) - Method in class org.apache.commons.io.input.BrokenReader
-
Throws the configured exception.
- skip(long) - Method in class org.apache.commons.io.input.BufferedFileChannelInputStream
- skip(long) - Method in class org.apache.commons.io.input.CharSequenceInputStream
- skip(long) - Method in class org.apache.commons.io.input.CharSequenceReader
-
Skip the specified number of characters.
- skip(long) - Method in class org.apache.commons.io.input.CountingInputStream
-
Skips the stream over the specified number of bytes, adding the skipped amount to the count.
- skip(long) - Method in class org.apache.commons.io.input.MemoryMappedFileInputStream
- skip(long) - Method in class org.apache.commons.io.input.NullInputStream
-
Skip a specified number of bytes.
- skip(long) - Method in class org.apache.commons.io.input.NullReader
-
Skips a specified number of characters.
- skip(long) - Method in class org.apache.commons.io.input.ProxyInputStream
-
Invokes the delegate's
skip(long)
method. - skip(long) - Method in class org.apache.commons.io.input.ProxyReader
-
Invokes the delegate's
skip(long)
method. - skip(long) - Method in class org.apache.commons.io.input.RandomAccessFileInputStream
- skip(long) - Method in class org.apache.commons.io.input.ReadAheadInputStream
- skip(long) - Method in class org.apache.commons.io.input.UncheckedBufferedReader
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - skip(long) - Method in class org.apache.commons.io.input.UncheckedFilterInputStream
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - skip(long) - Method in class org.apache.commons.io.input.UncheckedFilterReader
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - skip(long) - Method in class org.apache.commons.io.input.UnsynchronizedBufferedInputStream
-
Skips
amount
number of bytes in this stream. - skip(long) - Method in class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream
- skip(long) - Method in class org.apache.commons.io.input.UnsynchronizedFilterInputStream
-
Skips
count
number of bytes in this stream. - skip(InputStream, long) - Static method in class org.apache.commons.io.IOUtils
-
Skips bytes from an input byte stream.
- skip(Reader, long) - Static method in class org.apache.commons.io.IOUtils
-
Skips characters from an input character stream.
- skip(ReadableByteChannel, long) - Static method in class org.apache.commons.io.IOUtils
-
Skips bytes from a ReadableByteChannel.
- SKIP_NONE - Static variable in class org.apache.commons.io.input.AbstractCharacterFilterReader
-
Skips nothing.
- skipBytes(int) - Method in class org.apache.commons.io.input.SwappedDataInputStream
-
Invokes the delegate's
skip(int)
method. - skipFromFileChannel(long) - Method in class org.apache.commons.io.input.BufferedFileChannelInputStream
- skipFully(InputStream, long) - Static method in class org.apache.commons.io.IOUtils
-
Skips the requested number of bytes or fail if there are not enough left.
- skipFully(Reader, long) - Static method in class org.apache.commons.io.IOUtils
-
Skips the requested number of characters or fail if there are not enough left.
- skipFully(ReadableByteChannel, long) - Static method in class org.apache.commons.io.IOUtils
-
Skips the requested number of bytes or fail if there are not enough left.
- skipInternal(long) - Method in class org.apache.commons.io.input.ReadAheadInputStream
-
Internal skip function which should be called only from skip().
- sleep(Duration) - Static method in class org.apache.commons.io.ThreadUtils
-
Sleeps for a guaranteed minimum duration unless interrupted.
- sort(File...) - Method in class org.apache.commons.io.comparator.AbstractFileComparator
-
Sorts an array of files.
- sort(List<File>) - Method in class org.apache.commons.io.comparator.AbstractFileComparator
-
Sorts a List of files.
- sorted() - Method in interface org.apache.commons.io.function.IOStream
-
Like
Stream.sorted()
. - sorted(IOComparator<? super T>) - Method in interface org.apache.commons.io.function.IOStream
- Sorting - Search tag in package org.apache.commons.io.comparator
- Section
- sourceDirectory - Variable in class org.apache.commons.io.file.CopyDirectoryVisitor
- spliterator() - Method in interface org.apache.commons.io.function.IOBaseStream
-
Like
BaseStream.spliterator()
. - spliterator() - Method in class org.apache.commons.io.function.UncheckedIOBaseStream
- splitOnTokens(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Splits a string into a number of tokens.
- STANDARD_CHARSET_MAP - Static variable in class org.apache.commons.io.Charsets
- StandardDeleteOption - Enum in org.apache.commons.io.file
-
Defines the standard delete options.
- StandardDeleteOption() - Constructor for enum org.apache.commons.io.file.StandardDeleteOption
- StandardLineSeparator - Enum in org.apache.commons.io
-
Enumerates standard line separators:
StandardLineSeparator.CR
,StandardLineSeparator.CRLF
,StandardLineSeparator.LF
. - StandardLineSeparator(String) - Constructor for enum org.apache.commons.io.StandardLineSeparator
-
Constructs a new instance for a non-null line separator.
- start - Variable in class org.apache.commons.io.input.CharSequenceReader
-
The start index in the character sequence, inclusive.
- start() - Method in class org.apache.commons.io.input.CharSequenceReader
-
Returns the index in the character sequence to start reading from, taking into account its length.
- start() - Method in class org.apache.commons.io.monitor.FileAlterationMonitor
-
Starts monitoring.
- start(Thread, Duration) - Static method in class org.apache.commons.io.ThreadMonitor
-
Starts monitoring the specified thread.
- start(Duration) - Static method in class org.apache.commons.io.ThreadMonitor
-
Starts monitoring the current thread.
- startOffset - Variable in class org.apache.commons.io.input.buffer.CircularByteBuffer
- startThread - Variable in class org.apache.commons.io.input.Tailer.Builder
- stateChangeLock - Variable in class org.apache.commons.io.input.ReadAheadInputStream
- stop() - Method in class org.apache.commons.io.input.Tailer
-
Deprecated.Use
Tailer.close()
. - stop() - Method in class org.apache.commons.io.monitor.FileAlterationMonitor
-
Stops monitoring.
- stop(long) - Method in class org.apache.commons.io.monitor.FileAlterationMonitor
-
Stops monitoring.
- stop(Thread) - Static method in class org.apache.commons.io.ThreadMonitor
-
Stops monitoring the specified thread.
- stream - Variable in class org.apache.commons.io.StreamIterator
- streamFiles(File, boolean, String...) - Static method in class org.apache.commons.io.FileUtils
-
Streams over the files in a given directory (and optionally its subdirectories) which match an array of extensions.
- StreamIterator<E> - Class in org.apache.commons.io
-
Wraps and presents a stream as a closable iterator resource that automatically closes itself when reaching the end of stream.
- StreamIterator(Stream<E>) - Constructor for class org.apache.commons.io.StreamIterator
- StringBuilderWriter - Class in org.apache.commons.io.output
-
Writer
implementation that outputs to aStringBuilder
. - StringBuilderWriter() - Constructor for class org.apache.commons.io.output.StringBuilderWriter
-
Constructs a new
StringBuilder
instance with default capacity. - StringBuilderWriter(int) - Constructor for class org.apache.commons.io.output.StringBuilderWriter
-
Constructs a new
StringBuilder
instance with the specified capacity. - StringBuilderWriter(StringBuilder) - Constructor for class org.apache.commons.io.output.StringBuilderWriter
-
Constructs a new instance with the specified
StringBuilder
. - suffix - Variable in class org.apache.commons.io.output.DeferredFileOutputStream.Builder
- suffix - Variable in class org.apache.commons.io.output.DeferredFileOutputStream
-
The temporary file suffix.
- suffixes - Variable in class org.apache.commons.io.filefilter.SuffixFileFilter
-
The file name suffixes to search for
- suffixFileFilter(String) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that returns true if the file name ends with the specified text.
- suffixFileFilter(String, IOCase) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that returns true if the file name ends with the specified text.
- SuffixFileFilter - Class in org.apache.commons.io.filefilter
-
Filters files based on the suffix (what the file name ends with).
- SuffixFileFilter(String) - Constructor for class org.apache.commons.io.filefilter.SuffixFileFilter
-
Constructs a new Suffix file filter for a single extension.
- SuffixFileFilter(String...) - Constructor for class org.apache.commons.io.filefilter.SuffixFileFilter
-
Constructs a new Suffix file filter for an array of suffixes.
- SuffixFileFilter(String[], IOCase) - Constructor for class org.apache.commons.io.filefilter.SuffixFileFilter
-
Constructs a new Suffix file filter for an array of suffixes specifying case-sensitivity.
- SuffixFileFilter(String, IOCase) - Constructor for class org.apache.commons.io.filefilter.SuffixFileFilter
-
Constructs a new Suffix file filter for a single extension specifying case-sensitivity.
- SuffixFileFilter(List<String>) - Constructor for class org.apache.commons.io.filefilter.SuffixFileFilter
-
Constructs a new Suffix file filter for a list of suffixes.
- SuffixFileFilter(List<String>, IOCase) - Constructor for class org.apache.commons.io.filefilter.SuffixFileFilter
-
Constructs a new Suffix file filter for a list of suffixes specifying case-sensitivity.
- sumDirectoryContents - Variable in class org.apache.commons.io.comparator.SizeFileComparator
-
Whether the sum of the directory's contents should be calculated.
- supportsDriveLetter - Variable in enum org.apache.commons.io.FileSystem
- supportsDriveLetter() - Method in enum org.apache.commons.io.FileSystem
-
Tests whether this file system support driver letters.
- SVN_FILTER - Static variable in class org.apache.commons.io.filefilter.FileFilterUtils
- swapBuffers() - Method in class org.apache.commons.io.input.ReadAheadInputStream
-
Flips the active and read ahead buffer
- swapDouble(double) - Static method in class org.apache.commons.io.EndianUtils
-
Converts a "double" value between endian systems.
- swapFloat(float) - Static method in class org.apache.commons.io.EndianUtils
-
Converts a "float" value between endian systems.
- swapInteger(int) - Static method in class org.apache.commons.io.EndianUtils
-
Converts an "int" value between endian systems.
- swapLong(long) - Static method in class org.apache.commons.io.EndianUtils
-
Converts a "long" value between endian systems.
- SwappedDataInputStream - Class in org.apache.commons.io.input
-
DataInput for systems relying on little endian data formats.
- SwappedDataInputStream(InputStream) - Constructor for class org.apache.commons.io.input.SwappedDataInputStream
-
Constructs a SwappedDataInputStream.
- swapShort(short) - Static method in class org.apache.commons.io.EndianUtils
-
Converts a "short" value between endian systems.
- SymbolicLinkFileFilter - Class in org.apache.commons.io.filefilter
-
This filter accepts
File
s that are symbolic links. - SymbolicLinkFileFilter() - Constructor for class org.apache.commons.io.filefilter.SymbolicLinkFileFilter
-
Restrictive constructor.
- SymbolicLinkFileFilter(FileVisitResult, FileVisitResult) - Constructor for class org.apache.commons.io.filefilter.SymbolicLinkFileFilter
-
Constructs a new instance.
- SYSTEM - Enum constant in enum org.apache.commons.io.IOCase
-
The constant for case sensitivity determined by the current operating system.
- SYSTEM_NAME_SEPARATOR - Static variable in class org.apache.commons.io.FilenameUtils
-
The system separator character.
T
- tag - Variable in class org.apache.commons.io.input.TaggedInputStream
-
The unique tag associated with exceptions from stream.
- tag - Variable in class org.apache.commons.io.input.TaggedReader
-
The unique tag associated with exceptions from reader.
- tag - Variable in class org.apache.commons.io.output.TaggedOutputStream
-
The unique tag associated with exceptions from stream.
- tag - Variable in class org.apache.commons.io.output.TaggedWriter
-
The unique tag associated with exceptions from writer.
- tag - Variable in exception class org.apache.commons.io.TaggedIOException
-
The tag of this exception.
- TaggedInputStream - Class in org.apache.commons.io.input
-
An input stream decorator that tags potential exceptions so that the stream that caused the exception can easily be identified.
- TaggedInputStream(InputStream) - Constructor for class org.apache.commons.io.input.TaggedInputStream
-
Creates a tagging decorator for the given input stream.
- TaggedIOException - Exception Class in org.apache.commons.io
-
An
IOException
decorator that adds a serializable tag to the wrapped exception. - TaggedIOException(IOException, Serializable) - Constructor for exception class org.apache.commons.io.TaggedIOException
-
Creates a tagged wrapper for the given exception.
- TaggedOutputStream - Class in org.apache.commons.io.output
-
An output stream decorator that tags potential exceptions so that the stream that caused the exception can easily be identified.
- TaggedOutputStream(OutputStream) - Constructor for class org.apache.commons.io.output.TaggedOutputStream
-
Creates a tagging decorator for the given output stream.
- TaggedReader - Class in org.apache.commons.io.input
-
A reader decorator that tags potential exceptions so that the reader that caused the exception can easily be identified.
- TaggedReader(Reader) - Constructor for class org.apache.commons.io.input.TaggedReader
-
Creates a tagging decorator for the given reader.
- TaggedWriter - Class in org.apache.commons.io.output
-
A writer decorator that tags potential exceptions so that the reader that caused the exception can easily be identified.
- TaggedWriter(Writer) - Constructor for class org.apache.commons.io.output.TaggedWriter
-
Creates a tagging decorator for the given writer.
- tailable - Variable in class org.apache.commons.io.input.Tailer.Builder
- tailable - Variable in class org.apache.commons.io.input.Tailer
-
The file which will be tailed.
- TailablePath(Path, LinkOption...) - Constructor for class org.apache.commons.io.input.Tailer.TailablePath
- tailAtEnd - Variable in class org.apache.commons.io.input.Tailer
-
Whether to tail from the end or start of file
- Tailer - Class in org.apache.commons.io.input
-
Simple implementation of the UNIX "tail -f" functionality.
- Tailer(File, Charset, TailerListener, long, boolean, boolean, int) - Constructor for class org.apache.commons.io.input.Tailer
-
Deprecated.
- Tailer(File, TailerListener) - Constructor for class org.apache.commons.io.input.Tailer
-
Deprecated.
- Tailer(File, TailerListener, long) - Constructor for class org.apache.commons.io.input.Tailer
-
Deprecated.
- Tailer(File, TailerListener, long, boolean) - Constructor for class org.apache.commons.io.input.Tailer
-
Deprecated.
- Tailer(File, TailerListener, long, boolean, boolean) - Constructor for class org.apache.commons.io.input.Tailer
-
Deprecated.
- Tailer(File, TailerListener, long, boolean, boolean, int) - Constructor for class org.apache.commons.io.input.Tailer
-
Deprecated.
- Tailer(File, TailerListener, long, boolean, int) - Constructor for class org.apache.commons.io.input.Tailer
-
Deprecated.
- Tailer(Tailer.Tailable, Charset, TailerListener, Duration, boolean, boolean, int) - Constructor for class org.apache.commons.io.input.Tailer
-
Creates a Tailer for the given file, with a specified buffer size.
- Tailer.Builder - Class in org.apache.commons.io.input
-
Builds a
Tailer
with default values. - Tailer.RandomAccessFileBridge - Class in org.apache.commons.io.input
-
Bridges random access to a
RandomAccessFile
. - Tailer.RandomAccessResourceBridge - Interface in org.apache.commons.io.input
-
Bridges access to a resource for random access, normally a file.
- Tailer.Tailable - Interface in org.apache.commons.io.input
-
A tailable resource like a file.
- Tailer.TailablePath - Class in org.apache.commons.io.input
-
A tailable for a file
Path
. - tailerListener - Variable in class org.apache.commons.io.input.Tailer.Builder
- TailerListener - Interface in org.apache.commons.io.input
-
Listener for events from a
Tailer
. - TailerListenerAdapter - Class in org.apache.commons.io.input
-
TailerListener
Adapter. - TailerListenerAdapter() - Constructor for class org.apache.commons.io.input.TailerListenerAdapter
- target - Variable in class org.apache.commons.io.input.BoundedReader
- targetByteCount - Variable in class org.apache.commons.io.input.CircularInputStream
- targetDirectory - Variable in class org.apache.commons.io.file.CopyDirectoryVisitor
- TeeInputStream - Class in org.apache.commons.io.input
-
InputStream proxy that transparently writes a copy of all bytes read from the proxied stream to a given OutputStream.
- TeeInputStream(InputStream, OutputStream) - Constructor for class org.apache.commons.io.input.TeeInputStream
-
Creates a TeeInputStream that proxies the given
InputStream
and copies all read bytes to the givenOutputStream
. - TeeInputStream(InputStream, OutputStream, boolean) - Constructor for class org.apache.commons.io.input.TeeInputStream
-
Creates a TeeInputStream that proxies the given
InputStream
and copies all read bytes to the givenOutputStream
. - TeeOutputStream - Class in org.apache.commons.io.output
-
Classic splitter of
OutputStream
. - TeeOutputStream(OutputStream, OutputStream) - Constructor for class org.apache.commons.io.output.TeeOutputStream
-
Constructs a TeeOutputStream.
- TeeReader - Class in org.apache.commons.io.input
-
Reader proxy that transparently writes a copy of all characters read from the proxied reader to a given Reader.
- TeeReader(Reader, Writer) - Constructor for class org.apache.commons.io.input.TeeReader
- TeeReader(Reader, Writer, boolean) - Constructor for class org.apache.commons.io.input.TeeReader
- TeeWriter - Class in org.apache.commons.io.output
-
Classic splitter of
Writer
. - TeeWriter(Writer...) - Constructor for class org.apache.commons.io.output.TeeWriter
-
Creates a new filtered collection writer.
- TeeWriter(Collection<Writer>) - Constructor for class org.apache.commons.io.output.TeeWriter
-
Creates a new filtered collection writer.
- test(IOPredicate<? super T>, T) - Static method in class org.apache.commons.io.function.Erase
-
Delegates to the given
IOPredicate
but erases itsIOException
for the compiler, while still throwing the exception at runtime. - test(IOPredicate<T>, T) - Static method in class org.apache.commons.io.function.Uncheck
-
Tests an IO predicate.
- test(T) - Method in interface org.apache.commons.io.function.IOPredicate
-
Evaluates this predicate on the given argument.
- testLockDir(File) - Method in class org.apache.commons.io.output.LockableFileWriter
-
Tests that we can write to the lock directory.
- theUnsafe - Variable in class org.apache.commons.io.input.ByteBufferCleaner.Java9Cleaner
- thread - Variable in class org.apache.commons.io.monitor.FileAlterationMonitor
- thread - Variable in class org.apache.commons.io.ThreadMonitor
- threadFactory - Variable in class org.apache.commons.io.monitor.FileAlterationMonitor
- ThreadMonitor - Class in org.apache.commons.io
-
Monitors a thread, interrupting it if it reaches the specified timeout.
- ThreadMonitor(Thread, Duration) - Constructor for class org.apache.commons.io.ThreadMonitor
-
Constructs a new monitor.
- ThreadUtils - Class in org.apache.commons.io
-
Helps work with threads.
- ThreadUtils() - Constructor for class org.apache.commons.io.ThreadUtils
- threshold - Variable in class org.apache.commons.io.output.DeferredFileOutputStream.Builder
- threshold - Variable in class org.apache.commons.io.output.ThresholdingOutputStream
-
The threshold at which the event will be triggered.
- thresholdConsumer - Variable in class org.apache.commons.io.output.ThresholdingOutputStream
-
Accepts reaching the threshold.
- thresholdExceeded - Variable in class org.apache.commons.io.output.ThresholdingOutputStream
-
Whether or not the configured threshold has been exceeded.
- ThresholdingOutputStream - Class in org.apache.commons.io.output
-
An output stream which triggers an event when a specified number of bytes of data have been written to it.
- ThresholdingOutputStream(int) - Constructor for class org.apache.commons.io.output.ThresholdingOutputStream
-
Constructs an instance of this class which will trigger an event at the specified threshold.
- ThresholdingOutputStream(int, IOConsumer<ThresholdingOutputStream>, IOFunction<ThresholdingOutputStream, OutputStream>) - Constructor for class org.apache.commons.io.output.ThresholdingOutputStream
-
Constructs an instance of this class which will trigger an event at the specified threshold.
- thresholdReached() - Method in class org.apache.commons.io.output.DeferredFileOutputStream
-
Switches the underlying output stream from a memory based stream to one that is backed by disk.
- thresholdReached() - Method in class org.apache.commons.io.output.ThresholdingOutputStream
-
Indicates that the configured threshold has been reached, and that a subclass should take whatever action necessary on this event.
- throwCauseIfTaggedWith(Throwable, Object) - Static method in exception class org.apache.commons.io.TaggedIOException
-
Throws the original
IOException
if the given throwable is aTaggedIOException
decorator the given tag. - throwEofException - Variable in class org.apache.commons.io.input.NullInputStream
- throwEofException - Variable in class org.apache.commons.io.input.NullReader
- throwIfCauseOf(Exception) - Method in class org.apache.commons.io.output.TaggedOutputStream
-
Re-throws the original exception thrown by this stream.
- throwIfCauseOf(Exception) - Method in class org.apache.commons.io.output.TaggedWriter
-
Re-throws the original exception thrown by this writer.
- throwIfCauseOf(Throwable) - Method in class org.apache.commons.io.input.TaggedInputStream
-
Re-throws the original exception thrown by this stream.
- throwIfCauseOf(Throwable) - Method in class org.apache.commons.io.input.TaggedReader
-
Re-throws the original exception thrown by this reader.
- timeout - Variable in class org.apache.commons.io.input.QueueInputStream.Builder
- timeout - Variable in class org.apache.commons.io.ThreadMonitor
- timeoutNanos - Variable in class org.apache.commons.io.input.QueueInputStream
- TimestampedObserver - Class in org.apache.commons.io.input
-
An observer with timestamps.
- TimestampedObserver() - Constructor for class org.apache.commons.io.input.TimestampedObserver
- to(TimeUnit) - Method in class org.apache.commons.io.monitor.SerializableFileTime
- TO_STRING - Static variable in class org.apache.commons.io.filefilter.FalseFileFilter
- TO_STRING - Static variable in class org.apache.commons.io.filefilter.TrueFileFilter
- toArray() - Method in interface org.apache.commons.io.function.IOStream
-
Like
Stream.toArray()
. - toArray(IntFunction<A[]>) - Method in interface org.apache.commons.io.function.IOStream
-
TODO Package-private for now, needs IOIntFunction? Adding this method now and an IO version later is an issue because call sites would have to type-cast to pick one.
- toBufferedInputStream(InputStream) - Static method in class org.apache.commons.io.IOUtils
-
Fetches entire contents of an
InputStream
and represent same data as result InputStream. - toBufferedInputStream(InputStream) - Static method in class org.apache.commons.io.output.ByteArrayOutputStream
-
Fetches entire contents of an
InputStream
and represent same data as result InputStream. - toBufferedInputStream(InputStream) - Static method in class org.apache.commons.io.output.UnsynchronizedByteArrayOutputStream
-
Fetches entire contents of an
InputStream
and represent same data as result InputStream. - toBufferedInputStream(InputStream, int) - Static method in class org.apache.commons.io.IOUtils
-
Fetches entire contents of an
InputStream
and represent same data as result InputStream. - toBufferedInputStream(InputStream, int) - Static method in class org.apache.commons.io.output.ByteArrayOutputStream
-
Fetches entire contents of an
InputStream
and represent same data as result InputStream. - toBufferedInputStream(InputStream, int) - Static method in class org.apache.commons.io.output.UnsynchronizedByteArrayOutputStream
-
Fetches entire contents of an
InputStream
and represent same data as result InputStream. - toBufferedReader(Reader) - Static method in class org.apache.commons.io.IOUtils
-
Returns the given reader if it is a
BufferedReader
, otherwise creates a BufferedReader from the given reader. - toBufferedReader(Reader, int) - Static method in class org.apache.commons.io.IOUtils
-
Returns the given reader if it is a
BufferedReader
, otherwise creates a BufferedReader from the given reader. - toByteArray() - Method in class org.apache.commons.io.output.AbstractByteArrayOutputStream
-
Gets the current contents of this byte stream as a byte array.
- toByteArray() - Method in class org.apache.commons.io.output.ByteArrayOutputStream
- toByteArray() - Method in class org.apache.commons.io.output.UnsynchronizedByteArrayOutputStream
- toByteArray(InputStream) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents of an
InputStream
as abyte[]
. - toByteArray(InputStream, int) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents of an
InputStream
as abyte[]
. - toByteArray(InputStream, long) - Static method in class org.apache.commons.io.IOUtils
-
Gets contents of an
InputStream
as abyte[]
. - toByteArray(Reader) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.2.5 use
IOUtils.toByteArray(Reader, Charset)
instead - toByteArray(Reader, String) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents of a
Reader
as abyte[]
using the specified character encoding. - toByteArray(Reader, Charset) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents of a
Reader
as abyte[]
using the specified character encoding. - toByteArray(String) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.2.5 Use
String.getBytes()
instead - toByteArray(URI) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents of a
URI
as abyte[]
. - toByteArray(URL) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents of a
URL
as abyte[]
. - toByteArray(URLConnection) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents of a
URLConnection
as abyte[]
. - toByteArray(IOTriFunction<byte[], Integer, Integer, Integer>, int) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents of an input as a
byte[]
. - toByteArrayImpl() - Method in class org.apache.commons.io.output.AbstractByteArrayOutputStream
-
Gets the current contents of this byte stream as a byte array.
- toCharArray(InputStream) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.2.5 use
IOUtils.toCharArray(InputStream, Charset)
instead - toCharArray(InputStream, String) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents of an
InputStream
as a character array using the specified character encoding. - toCharArray(InputStream, Charset) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents of an
InputStream
as a character array using the specified character encoding. - toCharArray(Reader) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents of a
Reader
as a character array. - toCharset(String) - Static method in class org.apache.commons.io.Charsets
-
Returns a Charset for the named charset.
- toCharset(String, Charset) - Static method in class org.apache.commons.io.Charsets
-
Returns a Charset for the named charset.
- toCharset(Charset) - Static method in class org.apache.commons.io.Charsets
-
Returns the given Charset or the default Charset if the given Charset is null.
- toCharset(Charset, Charset) - Static method in class org.apache.commons.io.Charsets
-
Returns the given charset if non-null, otherwise return defaultCharset.
- toCharsetDecoder(CharsetDecoder) - Static method in class org.apache.commons.io.charset.CharsetDecoders
-
Returns the given non-null CharsetDecoder or a new default CharsetDecoder.
- toCharsetEncoder(CharsetEncoder) - Static method in class org.apache.commons.io.charset.CharsetEncoders
-
Returns the given non-null CharsetEncoder or a new default CharsetEncoder.
- toCharsetEncoder(CharsetEncoder, Supplier<CharsetEncoder>) - Static method in class org.apache.commons.io.charset.CharsetEncoders
-
Returns the given non-null CharsetEncoder or a new default CharsetEncoder.
- toCopyOption(CopyOption...) - Static method in class org.apache.commons.io.file.CopyDirectoryVisitor
- toDate(FileTime) - Static method in class org.apache.commons.io.file.attribute.FileTimes
- toDefaultFileVisitResult(boolean) - Static method in class org.apache.commons.io.filefilter.AbstractFileFilter
- toFile(URL) - Static method in class org.apache.commons.io.FileUtils
- toFiles(URL...) - Static method in class org.apache.commons.io.FileUtils
- toFileTime(Date) - Static method in class org.apache.commons.io.file.attribute.FileTimes
- toFileVisitOptionSet(FileVisitOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Converts an array of
FileVisitOption
to aSet
. - toFileVisitResult(boolean) - Method in class org.apache.commons.io.filefilter.AbstractFileFilter
-
Converts a boolean into a FileVisitResult.
- toFlags(IOCase) - Static method in class org.apache.commons.io.filefilter.RegexFileFilter
-
Converts IOCase to Pattern compilation flags.
- toInputStream() - Method in class org.apache.commons.io.output.AbstractByteArrayOutputStream
-
Gets the current contents of this byte stream as an Input Stream.
- toInputStream() - Method in class org.apache.commons.io.output.ByteArrayOutputStream
- toInputStream() - Method in class org.apache.commons.io.output.DeferredFileOutputStream
-
Converts the current contents of this byte stream to an
InputStream
. - toInputStream() - Method in class org.apache.commons.io.output.UnsynchronizedByteArrayOutputStream
- toInputStream(CharSequence) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.2.5 use
IOUtils.toInputStream(CharSequence, Charset)
instead - toInputStream(CharSequence, String) - Static method in class org.apache.commons.io.IOUtils
-
Converts the specified CharSequence to an input stream, encoded as bytes using the specified character encoding.
- toInputStream(CharSequence, Charset) - Static method in class org.apache.commons.io.IOUtils
-
Converts the specified CharSequence to an input stream, encoded as bytes using the specified character encoding.
- toInputStream(String) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.2.5 use
IOUtils.toInputStream(String, Charset)
instead - toInputStream(String, String) - Static method in class org.apache.commons.io.IOUtils
-
Converts the specified string to an input stream, encoded as bytes using the specified character encoding.
- toInputStream(String, Charset) - Static method in class org.apache.commons.io.IOUtils
-
Converts the specified string to an input stream, encoded as bytes using the specified character encoding.
- toInputStream(AbstractByteArrayOutputStream.InputStreamConstructor<T>) - Method in class org.apache.commons.io.output.AbstractByteArrayOutputStream
-
Gets the current contents of this byte stream as an Input Stream.
- toInstant() - Method in class org.apache.commons.io.monitor.SerializableFileTime
- toIntPredicate(Set<Integer>) - Static method in class org.apache.commons.io.input.CharacterSetFilterReader
- toIOCase(IOCase) - Method in class org.apache.commons.io.filefilter.NameFileFilter
- toIOConsumer(IOConsumer<T>) - Static method in class org.apache.commons.io.function.IOStreams
- toLegalFileName(String, char) - Method in enum org.apache.commons.io.FileSystem
-
Converts a candidate file name (without a path) like
"filename.ext"
or"filename"
to a legal file name. - toList(Stream<File>) - Static method in class org.apache.commons.io.FileUtils
- toList(IOFileFilter...) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Create a List of file filters.
- toMaxDepth(boolean) - Static method in class org.apache.commons.io.FileUtils
-
Converts whether or not to recurse into a recursion max depth.
- toMessage(int, Throwable) - Static method in exception class org.apache.commons.io.IOIndexedException
-
Converts input to a suitable String for exception message.
- toMessage(List<? extends Throwable>) - Static method in exception class org.apache.commons.io.IOExceptionList
- toMillis() - Method in class org.apache.commons.io.monitor.SerializableFileTime
- toNtfsTime(FileTime) - Static method in class org.apache.commons.io.file.attribute.FileTimes
-
Converts a
FileTime
to NTFS time (100-nanosecond units since 1 January 1601). - toNtfsTime(Date) - Static method in class org.apache.commons.io.file.attribute.FileTimes
-
Converts a
Date
to NTFS time. - toPath(File, Supplier<Path>) - Method in class org.apache.commons.io.output.DeferredFileOutputStream
- toSeparator(boolean) - Static method in class org.apache.commons.io.FilenameUtils
-
Returns '/' if given true, '\\' otherwise.
- toString() - Method in class org.apache.commons.io.build.AbstractOrigin
- toString() - Method in class org.apache.commons.io.ByteOrderMark
-
Converts this instance to a String representation of the BOM.
- toString() - Method in class org.apache.commons.io.CloseableURLConnection
- toString() - Method in class org.apache.commons.io.comparator.AbstractFileComparator
-
String representation of this file comparator.
- toString() - Method in class org.apache.commons.io.comparator.CompositeFileComparator
-
String representation of this file comparator.
- toString() - Method in class org.apache.commons.io.comparator.ExtensionFileComparator
-
String representation of this file comparator.
- toString() - Method in class org.apache.commons.io.comparator.NameFileComparator
-
String representation of this file comparator.
- toString() - Method in class org.apache.commons.io.comparator.PathFileComparator
-
String representation of this file comparator.
- toString() - Method in class org.apache.commons.io.comparator.ReverseFileComparator
-
Returns the String representation of this file comparator.
- toString() - Method in class org.apache.commons.io.comparator.SizeFileComparator
-
String representation of this file comparator.
- toString() - Method in class org.apache.commons.io.file.Counters.AbstractPathCounters
- toString() - Method in class org.apache.commons.io.file.Counters.BigIntegerCounter
- toString() - Method in class org.apache.commons.io.file.Counters.LongCounter
- toString() - Method in class org.apache.commons.io.file.Counters.NoopCounter
-
Returns
"0"
, always. - toString() - Method in class org.apache.commons.io.file.CountingPathVisitor
- toString() - Method in class org.apache.commons.io.FileDeleteStrategy
-
Gets a string describing the delete strategy.
- toString() - Method in class org.apache.commons.io.filefilter.AbstractFileFilter
-
Provides a String representation of this file filter.
- toString() - Method in class org.apache.commons.io.filefilter.AgeFileFilter
-
Provide a String representation of this file filter.
- toString() - Method in class org.apache.commons.io.filefilter.AndFileFilter
-
Provide a String representation of this file filter.
- toString() - Method in class org.apache.commons.io.filefilter.DelegateFileFilter
-
Provide a String representation of this file filter.
- toString() - Method in class org.apache.commons.io.filefilter.FalseFileFilter
- toString() - Method in class org.apache.commons.io.filefilter.MagicNumberFileFilter
-
Returns a String representation of the file filter, which includes the magic number bytes and byte offset.
- toString() - Method in class org.apache.commons.io.filefilter.NameFileFilter
-
Provide a String representation of this file filter.
- toString() - Method in class org.apache.commons.io.filefilter.NotFileFilter
-
Provide a String representation of this file filter.
- toString() - Method in class org.apache.commons.io.filefilter.OrFileFilter
-
Provide a String representation of this file filter.
- toString() - Method in class org.apache.commons.io.filefilter.PrefixFileFilter
-
Provide a String representation of this file filter.
- toString() - Method in class org.apache.commons.io.filefilter.RegexFileFilter
-
Returns a debug string.
- toString() - Method in class org.apache.commons.io.filefilter.SizeFileFilter
-
Provide a String representation of this file filter.
- toString() - Method in class org.apache.commons.io.filefilter.SuffixFileFilter
-
Provide a String representation of this file filter.
- toString() - Method in class org.apache.commons.io.filefilter.TrueFileFilter
- toString() - Method in class org.apache.commons.io.filefilter.WildcardFileFilter
-
Provide a String representation of this file filter.
- toString() - Method in class org.apache.commons.io.input.BoundedInputStream
-
Invokes the delegate's
toString()
method. - toString() - Method in class org.apache.commons.io.input.CharSequenceReader
-
Return a String representation of the underlying character sequence.
- toString() - Method in class org.apache.commons.io.input.Tailer.TailablePath
- toString() - Method in class org.apache.commons.io.input.TimestampedObserver
- toString() - Method in enum org.apache.commons.io.IOCase
-
Gets a string describing the sensitivity.
- toString() - Method in class org.apache.commons.io.monitor.FileAlterationObserver
-
Returns a String representation of this observer.
- toString() - Method in class org.apache.commons.io.monitor.SerializableFileTime
- toString() - Method in class org.apache.commons.io.output.AbstractByteArrayOutputStream
-
Deprecated.2.5 use
AbstractByteArrayOutputStream.toString(String)
instead - toString() - Method in class org.apache.commons.io.output.StringBuilderWriter
-
Returns
StringBuilder.toString()
. - toString() - Method in class org.apache.commons.io.output.UncheckedAppendableImpl
- toString() - Method in enum org.apache.commons.io.RandomAccessFileMode
- toString(byte[]) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.2.5 Use
String(byte[])
instead - toString(byte[], String) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents of a
byte[]
as a String using the specified character encoding. - toString(int) - Method in class org.apache.commons.io.input.ReversedLinesFileReader
-
Returns the last
lineCount
lines of the file. - toString(InputStream) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.2.5 use
IOUtils.toString(InputStream, Charset)
instead - toString(InputStream, String) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents of an
InputStream
as a String using the specified character encoding. - toString(InputStream, Charset) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents of an
InputStream
as a String using the specified character encoding. - toString(Reader) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents of a
Reader
as a String. - toString(String) - Method in class org.apache.commons.io.output.AbstractByteArrayOutputStream
-
Gets the current contents of this byte stream as a string using the specified encoding.
- toString(URI) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.2.5 use
IOUtils.toString(URI, Charset)
instead - toString(URI, String) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents at the given URI.
- toString(URI, Charset) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents at the given URI.
- toString(URL) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.2.5 use
IOUtils.toString(URL, Charset)
instead - toString(URL, String) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents at the given URL.
- toString(URL, Charset) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents at the given URL.
- toString(Charset) - Method in class org.apache.commons.io.output.AbstractByteArrayOutputStream
-
Gets the current contents of this byte stream as a string using the specified encoding.
- toString(IOSupplier<InputStream>, Charset) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents of an
InputStream
from a supplier as a String using the specified character encoding. - toString(IOSupplier<InputStream>, Charset, IOSupplier<String>) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents of an
InputStream
from a supplier as a String using the specified character encoding. - toSuffixes(String...) - Static method in class org.apache.commons.io.FileUtils
-
Converts an array of file extensions to suffixes.
- totalBlockCount - Variable in class org.apache.commons.io.input.ReversedLinesFileReader
- totalByteLength - Variable in class org.apache.commons.io.input.ReversedLinesFileReader
- touch(File) - Static method in class org.apache.commons.io.FileUtils
-
Implements behavior similar to the Unix "touch" utility.
- touch(Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Implements behavior similar to the Unix "touch" utility.
- toURLs(File...) - Static method in class org.apache.commons.io.FileUtils
- track(File, Object) - Static method in class org.apache.commons.io.FileCleaner
-
Deprecated.
- track(File, Object) - Method in class org.apache.commons.io.FileCleaningTracker
-
Track the specified file, using the provided marker, deleting the file when the marker instance is garbage collected.
- track(File, Object, FileDeleteStrategy) - Static method in class org.apache.commons.io.FileCleaner
-
Deprecated.
- track(File, Object, FileDeleteStrategy) - Method in class org.apache.commons.io.FileCleaningTracker
-
Tracks the specified file, using the provided marker, deleting the file when the marker instance is garbage collected.
- track(String, Object) - Static method in class org.apache.commons.io.FileCleaner
-
Deprecated.
- track(String, Object) - Method in class org.apache.commons.io.FileCleaningTracker
-
Tracks the specified file, using the provided marker, deleting the file when the marker instance is garbage collected.
- track(String, Object, FileDeleteStrategy) - Static method in class org.apache.commons.io.FileCleaner
-
Deprecated.
- track(String, Object, FileDeleteStrategy) - Method in class org.apache.commons.io.FileCleaningTracker
-
Tracks the specified file, using the provided marker, deleting the file when the marker instance is garbage collected.
- Tracker(String, FileDeleteStrategy, Object, ReferenceQueue<? super Object>) - Constructor for class org.apache.commons.io.FileCleaningTracker.Tracker
-
Constructs an instance of this class from the supplied parameters.
- trackers - Variable in class org.apache.commons.io.FileCleaningTracker
-
Collection of
FileCleaningTracker.Tracker
instances in existence. - trailingNewlineOfFileSkipped - Variable in class org.apache.commons.io.input.ReversedLinesFileReader
- trimExtension(CharSequence) - Method in enum org.apache.commons.io.FileSystem
- TRUE - Static variable in class org.apache.commons.io.filefilter.TrueFileFilter
-
Singleton instance of true filter.
- trueFileFilter() - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that always returns true.
- TrueFileFilter - Class in org.apache.commons.io.filefilter
-
A file filter that always returns true.
- TrueFileFilter() - Constructor for class org.apache.commons.io.filefilter.TrueFileFilter
-
Restrictive constructor.
- tryAdvance(Consumer<? super T>) - Method in class org.apache.commons.io.function.UncheckedIOSpliterator
- tryAdvance(IOConsumer<? super T>) - Method in interface org.apache.commons.io.function.IOSpliterator
- trySplit() - Method in interface org.apache.commons.io.function.IOSpliterator
-
Like
Spliterator.trySplit()
. - trySplit() - Method in class org.apache.commons.io.function.UncheckedIOSpliterator
- TYPE_DIRECTORY - Static variable in class org.apache.commons.io.comparator.DirectoryFileComparator
- TYPE_FILE - Static variable in class org.apache.commons.io.comparator.DirectoryFileComparator
U
- 2.1 Using a Builder - Search tag in class org.apache.commons.io.input.Tailer
- Section
- 2.2 Using an Executor - Search tag in class org.apache.commons.io.input.Tailer
- Section
- 2.3 Using a Thread - Search tag in class org.apache.commons.io.input.Tailer
- Section
- 2. Using a Tailer - Search tag in class org.apache.commons.io.input.Tailer
- Section
- Uncheck - Class in org.apache.commons.io.function
-
Unchecks calls by throwing
UncheckedIOException
instead ofIOException
. - Uncheck() - Constructor for class org.apache.commons.io.function.Uncheck
-
No instances needed.
- UncheckedAppendable - Interface in org.apache.commons.io.output
- UncheckedAppendableImpl - Class in org.apache.commons.io.output
- UncheckedAppendableImpl(Appendable) - Constructor for class org.apache.commons.io.output.UncheckedAppendableImpl
- UncheckedBufferedReader - Class in org.apache.commons.io.input
- UncheckedBufferedReader(Reader, int) - Constructor for class org.apache.commons.io.input.UncheckedBufferedReader
-
Creates a buffering character-input stream that uses an input buffer of the specified size.
- UncheckedBufferedReader.Builder - Class in org.apache.commons.io.input
-
Builds a new
UncheckedBufferedReader
instance. - UncheckedFilterInputStream - Class in org.apache.commons.io.input
- UncheckedFilterInputStream(InputStream) - Constructor for class org.apache.commons.io.input.UncheckedFilterInputStream
-
Creates a
UncheckedFilterInputStream
. - UncheckedFilterInputStream.Builder - Class in org.apache.commons.io.input
-
Builds a new
UncheckedFilterInputStream
instance. - UncheckedFilterOutputStream - Class in org.apache.commons.io.output
- UncheckedFilterOutputStream(OutputStream) - Constructor for class org.apache.commons.io.output.UncheckedFilterOutputStream
-
Creates an output stream filter built on top of the specified underlying output stream.
- UncheckedFilterOutputStream.Builder - Class in org.apache.commons.io.output
-
Builds a new
UncheckedFilterOutputStream
instance. - UncheckedFilterReader - Class in org.apache.commons.io.input
- UncheckedFilterReader(Reader) - Constructor for class org.apache.commons.io.input.UncheckedFilterReader
-
Creates a new filtered reader.
- UncheckedFilterReader.Builder - Class in org.apache.commons.io.input
-
Builds a new
UncheckedFilterReader
instance. - UncheckedFilterWriter - Class in org.apache.commons.io.output
- UncheckedFilterWriter(Writer) - Constructor for class org.apache.commons.io.output.UncheckedFilterWriter
-
Creates a new filtered writer.
- UncheckedFilterWriter.Builder - Class in org.apache.commons.io.output
-
Builds a new
UncheckedFilterWriter
instance. - UncheckedIOBaseStream<T,
S, - Class in org.apache.commons.io.functionB> - UncheckedIOBaseStream(S) - Constructor for class org.apache.commons.io.function.UncheckedIOBaseStream
- UncheckedIOExceptions - Class in org.apache.commons.io
-
Helps use lambdas that throw
IOException
rethrow asUncheckedIOException
. - UncheckedIOExceptions() - Constructor for class org.apache.commons.io.UncheckedIOExceptions
- UncheckedIOIterator<E> - Class in org.apache.commons.io.function
- UncheckedIOIterator(IOIterator<E>) - Constructor for class org.apache.commons.io.function.UncheckedIOIterator
-
Constructs a new instance.
- UncheckedIOSpliterator<T> - Class in org.apache.commons.io.function
- UncheckedIOSpliterator(IOSpliterator<T>) - Constructor for class org.apache.commons.io.function.UncheckedIOSpliterator
- UNIX - Static variable in class org.apache.commons.io.FileSystemUtils
-
Deprecated.Operating system state flag for Unix.
- UNIX_NAME_SEPARATOR - Static variable in class org.apache.commons.io.FilenameUtils
-
The Unix separator character.
- UnixLineEndingInputStream - Class in org.apache.commons.io.input
-
A filtering input stream that ensures the content will have UNIX-style line endings, LF.
- UnixLineEndingInputStream(InputStream, boolean) - Constructor for class org.apache.commons.io.input.UnixLineEndingInputStream
-
Creates an input stream that filters another stream
- unordered() - Method in interface org.apache.commons.io.function.IOBaseStream
-
Like
BaseStream.unordered()
. - unordered() - Method in class org.apache.commons.io.function.UncheckedIOBaseStream
- UnsupportedOperationExceptions - Class in org.apache.commons.io.input
-
Package-private factory for
UnsupportedOperationException
to provide messages with consistent formatting. - UnsupportedOperationExceptions() - Constructor for class org.apache.commons.io.input.UnsupportedOperationExceptions
- UnsynchronizedBufferedInputStream - Class in org.apache.commons.io.input
-
An unsynchronized version of
BufferedInputStream
, not thread-safe. - UnsynchronizedBufferedInputStream(InputStream, int) - Constructor for class org.apache.commons.io.input.UnsynchronizedBufferedInputStream
- UnsynchronizedBufferedInputStream.Builder - Class in org.apache.commons.io.input
-
Builds a new
UnsynchronizedBufferedInputStream
instance. - UnsynchronizedByteArrayInputStream - 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. - UnsynchronizedByteArrayInputStream(byte[]) - Constructor for class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream
- UnsynchronizedByteArrayInputStream(byte[], int) - Constructor for class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream
- UnsynchronizedByteArrayInputStream(byte[], int, int) - Constructor for class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream
- UnsynchronizedByteArrayInputStream.Builder - Class in org.apache.commons.io.input
-
Builds a new
UnsynchronizedByteArrayInputStream
instance. - UnsynchronizedByteArrayOutputStream - Class in org.apache.commons.io.output
-
Implements a version of
AbstractByteArrayOutputStream
without any concurrent thread safety. - UnsynchronizedByteArrayOutputStream() - Constructor for class org.apache.commons.io.output.UnsynchronizedByteArrayOutputStream
- UnsynchronizedByteArrayOutputStream(int) - Constructor for class org.apache.commons.io.output.UnsynchronizedByteArrayOutputStream
- UnsynchronizedByteArrayOutputStream.Builder - Class in org.apache.commons.io.output
-
Builds a new
UnsynchronizedByteArrayOutputStream
instance. - UnsynchronizedFilterInputStream - Class in org.apache.commons.io.input
-
An unsynchronized version of
FilterInputStream
, not thread-safe. - UnsynchronizedFilterInputStream(InputStream) - Constructor for class org.apache.commons.io.input.UnsynchronizedFilterInputStream
-
Constructs a new
FilterInputStream
with the specified input stream as source. - UnsynchronizedFilterInputStream.Builder - Class in org.apache.commons.io.input
-
Builds a new
UnsynchronizedFilterInputStream
instance. - unwrap() - Method in interface org.apache.commons.io.function.IOBaseStream
-
Unwraps this instance and returns the underlying
Stream
. - unwrap() - Method in class org.apache.commons.io.function.IOBaseStreamAdapter
- unwrap() - Method in interface org.apache.commons.io.function.IOIterator
-
Unwraps this instance and returns the underlying
Iterator
. - unwrap() - Method in class org.apache.commons.io.function.IOIteratorAdapter
- unwrap() - Method in interface org.apache.commons.io.function.IOSpliterator
-
Unwraps this instance and returns the underlying
Spliterator
. - unwrap() - Method in class org.apache.commons.io.function.IOSpliteratorAdapter
- unwrap() - Method in class org.apache.commons.io.monitor.SerializableFileTime
- updateDirCounter(Path, IOException) - Method in class org.apache.commons.io.file.AccumulatorPathVisitor
- updateDirCounter(Path, IOException) - Method in class org.apache.commons.io.file.CountingPathVisitor
-
Updates the counter for visiting the given directory.
- updateFileCounters(Path, BasicFileAttributes) - Method in class org.apache.commons.io.file.AccumulatorPathVisitor
- updateFileCounters(Path, BasicFileAttributes) - Method in class org.apache.commons.io.file.CountingPathVisitor
-
Updates the counters for visiting the given file.
- URIOrigin(URI) - Constructor for class org.apache.commons.io.build.AbstractOrigin.URIOrigin
-
Constructs a new instance for the given origin.
- urlConnection - Variable in class org.apache.commons.io.CloseableURLConnection
- US_ASCII - Static variable in class org.apache.commons.io.Charsets
-
Deprecated.Use Java 7's
StandardCharsets
- US_ASCII - Static variable in class org.apache.commons.io.input.XmlStreamReader
- Using a Charset - Search tag in class org.apache.commons.io.input.CharSequenceInputStream.Builder
- Section
- Using a CharsetEncoder - Search tag in class org.apache.commons.io.input.CharSequenceInputStream.Builder
- Section
- Using Classic IO - Search tag in class org.apache.commons.io.filefilter.AgeFileFilter
- Section
- Using Classic IO - Search tag in class org.apache.commons.io.filefilter.CanExecuteFileFilter
- Section
- Using Classic IO - Search tag in class org.apache.commons.io.filefilter.CanReadFileFilter
- Section
- Using Classic IO - Search tag in class org.apache.commons.io.filefilter.CanWriteFileFilter
- Section
- Using Classic IO - Search tag in class org.apache.commons.io.filefilter.DirectoryFileFilter
- Section
- Using Classic IO - Search tag in class org.apache.commons.io.filefilter.EmptyFileFilter
- Section
- Using Classic IO - Search tag in class org.apache.commons.io.filefilter.FileFileFilter
- Section
- Using Classic IO - Search tag in class org.apache.commons.io.filefilter.HiddenFileFilter
- Section
- Using Classic IO - Search tag in class org.apache.commons.io.filefilter.MagicNumberFileFilter
- Section
- Using Classic IO - Search tag in class org.apache.commons.io.filefilter.NameFileFilter
- Section
- Using Classic IO - Search tag in class org.apache.commons.io.filefilter.PrefixFileFilter
- Section
- Using Classic IO - Search tag in class org.apache.commons.io.filefilter.RegexFileFilter
- Section
- Using Classic IO - Search tag in class org.apache.commons.io.filefilter.SizeFileFilter
- Section
- Using Classic IO - Search tag in class org.apache.commons.io.filefilter.SuffixFileFilter
- Section
- Using Classic IO - Search tag in class org.apache.commons.io.filefilter.SymbolicLinkFileFilter
- Section
- Using Classic IO - Search tag in class org.apache.commons.io.filefilter.WildcardFileFilter
- Section
- Using Classic IO - Search tag in class org.apache.commons.io.filefilter.WildcardFilter
- Section
- Using Classic IO - Search tag in package org.apache.commons.io.filefilter
- Section
- Using IO - Search tag in class org.apache.commons.io.input.BOMInputStream.Builder
- Section
- Using NIO - Search tag in class org.apache.commons.io.filefilter.AgeFileFilter
- Section
- Using NIO - Search tag in class org.apache.commons.io.filefilter.DirectoryFileFilter
- Section
- Using NIO - Search tag in class org.apache.commons.io.filefilter.EmptyFileFilter
- Section
- Using NIO - Search tag in class org.apache.commons.io.filefilter.FileFileFilter
- Section
- Using NIO - Search tag in class org.apache.commons.io.filefilter.HiddenFileFilter
- Section
- Using NIO - Search tag in class org.apache.commons.io.filefilter.MagicNumberFileFilter
- Section
- Using NIO - Search tag in class org.apache.commons.io.filefilter.NameFileFilter
- Section
- Using NIO - Search tag in class org.apache.commons.io.filefilter.PrefixFileFilter
- Section
- Using NIO - Search tag in class org.apache.commons.io.filefilter.RegexFileFilter
- Section
- Using NIO - Search tag in class org.apache.commons.io.filefilter.SizeFileFilter
- Section
- Using NIO - Search tag in class org.apache.commons.io.filefilter.SuffixFileFilter
- Section
- Using NIO - Search tag in class org.apache.commons.io.filefilter.SymbolicLinkFileFilter
- Section
- Using NIO - Search tag in class org.apache.commons.io.filefilter.WildcardFileFilter
- Section
- Using NIO - Search tag in class org.apache.commons.io.filefilter.WildcardFilter
- Section
- Using NIO - Search tag in class org.apache.commons.io.input.BOMInputStream.Builder
- Section
- Using NIO - Search tag in package org.apache.commons.io.filefilter
- Section
- UTF_16 - Static variable in class org.apache.commons.io.Charsets
-
Deprecated.Use Java 7's
StandardCharsets
- UTF_16 - Static variable in class org.apache.commons.io.input.XmlStreamReader
- UTF_16BE - Static variable in class org.apache.commons.io.ByteOrderMark
-
UTF-16BE BOM (Big-Endian).
- UTF_16BE - Static variable in class org.apache.commons.io.Charsets
-
Deprecated.Use Java 7's
StandardCharsets
- UTF_16BE - Static variable in class org.apache.commons.io.input.XmlStreamReader
- UTF_16LE - Static variable in class org.apache.commons.io.ByteOrderMark
-
UTF-16LE BOM (Little-Endian).
- UTF_16LE - Static variable in class org.apache.commons.io.Charsets
-
Deprecated.Use Java 7's
StandardCharsets
- UTF_16LE - Static variable in class org.apache.commons.io.input.XmlStreamReader
- UTF_32 - Static variable in class org.apache.commons.io.input.XmlStreamReader
- UTF_32BE - Static variable in class org.apache.commons.io.ByteOrderMark
-
UTF-32BE BOM (Big-Endian).
- UTF_32BE - Static variable in class org.apache.commons.io.input.XmlStreamReader
- UTF_32LE - Static variable in class org.apache.commons.io.ByteOrderMark
-
UTF-32LE BOM (Little-Endian).
- UTF_32LE - Static variable in class org.apache.commons.io.input.XmlStreamReader
- UTF_8 - Static variable in class org.apache.commons.io.ByteOrderMark
-
UTF-8 BOM.
- UTF_8 - Static variable in class org.apache.commons.io.Charsets
-
Deprecated.Use Java 7's
StandardCharsets
- UTF_8 - Static variable in class org.apache.commons.io.input.XmlStreamReader
- UTF_BOM - Static variable in class org.apache.commons.io.ByteOrderMark
-
Unicode BOM character; external form depends on the encoding.
V
- validate(byte[]) - Static method in class org.apache.commons.io.input.CircularInputStream
-
Throws an
IllegalArgumentException
if the input contains -1. - validateClassName(String) - Method in class org.apache.commons.io.serialization.ValidatingObjectInputStream
-
Check that the classname conforms to requirements.
- validateMoveParameters(File, File) - Static method in class org.apache.commons.io.FileUtils
-
Validates the given arguments.
- ValidatingObjectInputStream - Class in org.apache.commons.io.serialization
-
An
ObjectInputStream
that's restricted to deserialize a limited set of classes. - ValidatingObjectInputStream(InputStream) - Constructor for class org.apache.commons.io.serialization.ValidatingObjectInputStream
-
Constructs an object to deserialize the specified input stream.
- value - Variable in class org.apache.commons.io.file.Counters.BigIntegerCounter
- value - Variable in class org.apache.commons.io.file.Counters.LongCounter
- value(IOCase, IOCase) - Static method in enum org.apache.commons.io.IOCase
-
Returns the given value if not-null, the defaultValue if null.
- valueOf(String) - Static method in enum org.apache.commons.io.file.StandardDeleteOption
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.apache.commons.io.FileSystem
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.apache.commons.io.IOCase
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.apache.commons.io.RandomAccessFileMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.apache.commons.io.StandardLineSeparator
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.apache.commons.io.file.StandardDeleteOption
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.apache.commons.io.FileSystem
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.apache.commons.io.IOCase
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.apache.commons.io.RandomAccessFileMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.apache.commons.io.StandardLineSeparator
-
Returns an array containing the constants of this enum type, in the order they are declared.
- VISIBLE - Static variable in class org.apache.commons.io.filefilter.HiddenFileFilter
-
Singleton instance of visible filter
- visitFile(Path, BasicFileAttributes) - Method in class org.apache.commons.io.file.CleaningPathVisitor
- visitFile(Path, BasicFileAttributes) - Method in class org.apache.commons.io.file.CopyDirectoryVisitor
- visitFile(Path, BasicFileAttributes) - Method in class org.apache.commons.io.file.CountingPathVisitor
- visitFile(Path, BasicFileAttributes) - Method in class org.apache.commons.io.file.DeletingPathVisitor
- visitFile(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.AbstractFileFilter
- visitFile(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.PathVisitorFileFilter
- visitFile(Path, BasicFileAttributes) - Method in class org.apache.commons.io.filefilter.SizeFileFilter
- visitFileFailed(Path, IOException) - Method in class org.apache.commons.io.file.SimplePathVisitor
- visitFileFailed(Path, IOException) - Method in class org.apache.commons.io.filefilter.AbstractFileFilter
- visitFileFailedFunction - Variable in class org.apache.commons.io.file.SimplePathVisitor
- visitFileTree(T, String, String...) - Static method in class org.apache.commons.io.file.PathUtils
-
Performs
Files.walkFileTree(Path,FileVisitor)
and returns the given visitor. - visitFileTree(T, URI) - Static method in class org.apache.commons.io.file.PathUtils
-
Performs
Files.walkFileTree(Path,FileVisitor)
and returns the given visitor. - visitFileTree(T, Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Performs
Files.walkFileTree(Path,FileVisitor)
and returns the given visitor. - visitFileTree(T, Path, Set<FileVisitOption>, int) - Static method in class org.apache.commons.io.file.PathUtils
-
Performs
Files.walkFileTree(Path,FileVisitor)
and returns the given visitor.
W
- waitFor(File, int) - Static method in class org.apache.commons.io.FileUtils
-
Waits for the file system to propagate a file creation, with a timeout.
- waitFor(Path, Duration, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Waits for the file system to propagate a file creation, with a timeout.
- waitForAsyncReadComplete() - Method in class org.apache.commons.io.input.ReadAheadInputStream
- walk(File, int, Collection<T>) - Method in class org.apache.commons.io.DirectoryWalker
-
Deprecated.Main recursive method to examine the directory hierarchy.
- walk(File, Collection<T>) - Method in class org.apache.commons.io.DirectoryWalker
-
Deprecated.Internal method that walks the directory hierarchy in a depth-first manner.
- walk(Path, int, FileVisitOption...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.walk(Path, int, FileVisitOption...)
throwingUncheckedIOException
instead ofIOException
. - walk(Path, FileVisitOption...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.walk(Path, FileVisitOption...)
throwingUncheckedIOException
instead ofIOException
. - walk(Path, PathFilter, int, boolean, FileVisitOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Returns a stream of filtered paths.
- walkFileTree(Path, FileVisitor<? super Path>) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.walkFileTree(Path, FileVisitor)
throwingUncheckedIOException
instead ofIOException
. - walkFileTree(Path, Set<FileVisitOption>, int, FileVisitor<? super Path>) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.walkFileTree(Path, Set, int, FileVisitor)
throwingUncheckedIOException
instead ofIOException
. - Warning - Search tag in org.apache.commons.io.StreamIterator.iterator(Stream<T>)
- Section
- WildcardClassNameMatcher - Class in org.apache.commons.io.serialization
-
A
ClassNameMatcher
that uses simplified regular expressions provided byFilenameUtils.wildcardMatch
- WildcardClassNameMatcher(String) - Constructor for class org.apache.commons.io.serialization.WildcardClassNameMatcher
-
Constructs an object based on the specified simplified regular expression.
- WildcardFileFilter - Class in org.apache.commons.io.filefilter
-
Filters files using the supplied wildcards.
- WildcardFileFilter(String) - Constructor for class org.apache.commons.io.filefilter.WildcardFileFilter
-
Deprecated.
- WildcardFileFilter(String...) - Constructor for class org.apache.commons.io.filefilter.WildcardFileFilter
-
Deprecated.
- WildcardFileFilter(String[], IOCase) - Constructor for class org.apache.commons.io.filefilter.WildcardFileFilter
-
Deprecated.
- WildcardFileFilter(String, IOCase) - Constructor for class org.apache.commons.io.filefilter.WildcardFileFilter
-
Deprecated.
- WildcardFileFilter(List<String>) - Constructor for class org.apache.commons.io.filefilter.WildcardFileFilter
-
Deprecated.
- WildcardFileFilter(List<String>, IOCase) - Constructor for class org.apache.commons.io.filefilter.WildcardFileFilter
-
Deprecated.
- WildcardFileFilter(IOCase, String...) - Constructor for class org.apache.commons.io.filefilter.WildcardFileFilter
-
Constructs a new wildcard filter for an array of wildcards specifying case-sensitivity.
- WildcardFileFilter.Builder - Class in org.apache.commons.io.filefilter
-
Builds a new
WildcardFileFilter
instance. - WildcardFilter - Class in org.apache.commons.io.filefilter
-
Deprecated.Use WildcardFileFilter. Deprecated as this class performs directory filtering which it shouldn't do, but that can't be removed due to compatibility.
- WildcardFilter(String) - Constructor for class org.apache.commons.io.filefilter.WildcardFilter
-
Deprecated.Constructs a new case-sensitive wildcard filter for a single wildcard.
- WildcardFilter(String...) - Constructor for class org.apache.commons.io.filefilter.WildcardFilter
-
Deprecated.Constructs a new case-sensitive wildcard filter for an array of wildcards.
- WildcardFilter(List<String>) - Constructor for class org.apache.commons.io.filefilter.WildcardFilter
-
Deprecated.Constructs a new case-sensitive wildcard filter for a list of wildcards.
- wildcardMatch(String, String) - Static method in class org.apache.commons.io.FilenameUtils
-
Checks a fileName to see if it matches the specified wildcard matcher, always testing case-sensitive.
- wildcardMatch(String, String, IOCase) - Static method in class org.apache.commons.io.FilenameUtils
-
Checks a fileName to see if it matches the specified wildcard matcher allowing control over case-sensitivity.
- wildcardMatchOnSystem(String, String) - Static method in class org.apache.commons.io.FilenameUtils
-
Checks a fileName to see if it matches the specified wildcard matcher using the case rules of the system.
- wildcards - Variable in class org.apache.commons.io.filefilter.WildcardFileFilter.Builder
-
The wildcards that will be used to match file names.
- wildcards - Variable in class org.apache.commons.io.filefilter.WildcardFileFilter
-
The wildcards that will be used to match file names.
- wildcards - Variable in class org.apache.commons.io.filefilter.WildcardFilter
-
Deprecated.The wildcards that will be used to match file names.
- WINDOWS - Enum constant in enum org.apache.commons.io.FileSystem
-
Windows file system.
- WINDOWS - Static variable in class org.apache.commons.io.FileSystemUtils
-
Deprecated.Operating system state flag for Windows.
- WINDOWS_EPOCH_OFFSET - Static variable in class org.apache.commons.io.file.attribute.FileTimes
-
The offset of Windows time 0 to Unix epoch in 100-nanosecond intervals.
- WINDOWS_NAME_SEPARATOR - Static variable in class org.apache.commons.io.FilenameUtils
-
The Windows separator character.
- WindowsLineEndingInputStream - Class in org.apache.commons.io.input
-
A filtering input stream that ensures the content will have Windows line endings, CRLF.
- WindowsLineEndingInputStream(InputStream, boolean) - Constructor for class org.apache.commons.io.input.WindowsLineEndingInputStream
-
Creates an input stream that filters another stream
- withBigIntegerCounters() - Static method in class org.apache.commons.io.file.AccumulatorPathVisitor
-
Creates a new instance configured with a BigInteger
Counters.PathCounters
. - withBigIntegerCounters() - Static method in class org.apache.commons.io.file.CleaningPathVisitor
-
Creates a new instance configured with a BigInteger
Counters.PathCounters
. - withBigIntegerCounters() - Static method in class org.apache.commons.io.file.CountingPathVisitor
-
Creates a new instance configured with a
BigInteger
Counters.PathCounters
. - withBigIntegerCounters() - Static method in class org.apache.commons.io.file.DeletingPathVisitor
-
Creates a new instance configured with a BigInteger
Counters.PathCounters
. - withBigIntegerCounters(PathFilter, PathFilter) - Static method in class org.apache.commons.io.file.AccumulatorPathVisitor
-
Creates a new instance configured with a BigInteger
Counters.PathCounters
. - withLongCounters() - Static method in class org.apache.commons.io.file.AccumulatorPathVisitor
-
Creates a new instance configured with a long
Counters.PathCounters
. - withLongCounters() - Static method in class org.apache.commons.io.file.CleaningPathVisitor
-
Creates a new instance configured with a long
Counters.PathCounters
. - withLongCounters() - Static method in class org.apache.commons.io.file.CountingPathVisitor
-
Creates a new instance configured with a
long
Counters.PathCounters
. - withLongCounters() - Static method in class org.apache.commons.io.file.DeletingPathVisitor
-
Creates a new instance configured with a long
Counters.PathCounters
. - withLongCounters(PathFilter, PathFilter) - Static method in class org.apache.commons.io.file.AccumulatorPathVisitor
-
Creates a new instance configured with a long
Counters.PathCounters
. - withPosixFileAttributes(Path, LinkOption[], boolean, IOFunction<PosixFileAttributes, R>) - Static method in class org.apache.commons.io.file.PathUtils
- wrap(B) - Method in interface org.apache.commons.io.function.IOBaseStream
-
Wraps a
Stream
. - wrap(InputStream) - Static method in class org.apache.commons.io.input.CloseShieldInputStream
-
Creates a proxy that shields the given input stream from being closed.
- wrap(IOException) - Static method in class org.apache.commons.io.function.Uncheck
-
Creates a new UncheckedIOException for the given detail message.
- wrap(IOException, Object) - Static method in class org.apache.commons.io.UncheckedIOExceptions
-
Creates a new UncheckedIOException for the given detail message.
- wrap(OutputStream) - Static method in class org.apache.commons.io.output.CloseShieldOutputStream
-
Creates a proxy that shields the given output stream from being closed.
- wrap(Reader) - Static method in class org.apache.commons.io.input.CloseShieldReader
-
Creates a proxy that shields the given reader from being closed.
- wrap(Writer) - Static method in class org.apache.commons.io.output.CloseShieldWriter
-
Creates a proxy that shields the given writer from being closed.
- wrap(Stream<T>) - Method in class org.apache.commons.io.function.IOStreamAdapter
- write(byte[]) - Method in class org.apache.commons.io.output.NullOutputStream
-
Does nothing - output to
/dev/null
. - write(byte[]) - Method in class org.apache.commons.io.output.ProxyOutputStream
-
Invokes the delegate's
write(byte[])
method. - write(byte[]) - Method in class org.apache.commons.io.output.TeeOutputStream
-
Writes the bytes to both streams.
- write(byte[]) - Method in class org.apache.commons.io.output.ThresholdingOutputStream
-
Writes
b.length
bytes from the specified byte array to this output stream. - write(byte[]) - Method in class org.apache.commons.io.output.UncheckedFilterOutputStream
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - write(byte[]) - Method in class org.apache.commons.io.output.WriterOutputStream
-
Write bytes from the specified byte array to the stream.
- write(byte[], int, int) - Method in class org.apache.commons.io.output.AbstractByteArrayOutputStream
- write(byte[], int, int) - Method in class org.apache.commons.io.output.ByteArrayOutputStream
- write(byte[], int, int) - Method in class org.apache.commons.io.output.ChunkedOutputStream
-
Writes the data buffer in chunks to the underlying stream
- write(byte[], int, int) - Method in class org.apache.commons.io.output.NullOutputStream
-
Does nothing - output to
/dev/null
. - write(byte[], int, int) - Method in class org.apache.commons.io.output.ProxyOutputStream
-
Invokes the delegate's
write(byte[])
method. - write(byte[], int, int) - Method in class org.apache.commons.io.output.TeeOutputStream
-
Writes the specified bytes to both streams.
- write(byte[], int, int) - Method in class org.apache.commons.io.output.ThresholdingOutputStream
-
Writes
len
bytes from the specified byte array starting at offsetoff
to this output stream. - write(byte[], int, int) - Method in class org.apache.commons.io.output.UncheckedFilterOutputStream
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - write(byte[], int, int) - Method in class org.apache.commons.io.output.UnsynchronizedByteArrayOutputStream
- write(byte[], int, int) - Method in class org.apache.commons.io.output.WriterOutputStream
-
Write bytes from the specified byte array to the stream.
- write(byte[], OutputStream) - Static method in class org.apache.commons.io.IOUtils
-
Writes bytes from a
byte[]
to anOutputStream
. - write(byte[], Writer) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.2.5 use
IOUtils.write(byte[], Writer, Charset)
instead - write(byte[], Writer, String) - Static method in class org.apache.commons.io.IOUtils
-
Writes bytes from a
byte[]
to chars on aWriter
using the specified character encoding. - write(byte[], Writer, Charset) - Static method in class org.apache.commons.io.IOUtils
-
Writes bytes from a
byte[]
to chars on aWriter
using the specified character encoding. - write(char[]) - Method in class org.apache.commons.io.output.FilterCollectionWriter
- write(char[]) - Method in class org.apache.commons.io.output.LockableFileWriter
-
Writes the characters from an array.
- write(char[]) - Method in class org.apache.commons.io.output.NullWriter
-
Does nothing - output to
/dev/null
. - write(char[]) - Method in class org.apache.commons.io.output.ProxyCollectionWriter
-
Invokes the delegate's
write(char[])
method. - write(char[]) - Method in class org.apache.commons.io.output.ProxyWriter
-
Invokes the delegate's
write(char[])
method. - write(char[]) - Method in class org.apache.commons.io.output.UncheckedFilterWriter
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - write(char[], int, int) - Method in class org.apache.commons.io.output.AppendableWriter
-
Writes a portion of an array of characters to the underlying appendable.
- write(char[], int, int) - Method in class org.apache.commons.io.output.BrokenWriter
-
Throws the configured exception.
- write(char[], int, int) - Method in class org.apache.commons.io.output.ChunkedWriter
-
writes the data buffer in chunks to the underlying writer
- write(char[], int, int) - Method in class org.apache.commons.io.output.ClosedWriter
-
Throws an
IOException
to indicate that the writer is closed. - write(char[], int, int) - Method in class org.apache.commons.io.output.FilterCollectionWriter
-
Writes a portion of an array of characters.
- write(char[], int, int) - Method in class org.apache.commons.io.output.LockableFileWriter
-
Writes the specified characters from an array.
- write(char[], int, int) - Method in class org.apache.commons.io.output.NullWriter
-
Does nothing - output to
/dev/null
. - write(char[], int, int) - Method in class org.apache.commons.io.output.ProxyCollectionWriter
-
Invokes the delegate's
write(char[], int, int)
method. - write(char[], int, int) - Method in class org.apache.commons.io.output.ProxyWriter
-
Invokes the delegate's
write(char[], int, int)
method. - write(char[], int, int) - Method in class org.apache.commons.io.output.StringBuilderWriter
-
Writes a portion of a character array to the
StringBuilder
. - write(char[], int, int) - Method in class org.apache.commons.io.output.UncheckedFilterWriter
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - write(char[], int, int) - Method in class org.apache.commons.io.output.XmlStreamWriter
-
Writes the characters to the underlying writer, detecting encoding.
- write(char[], OutputStream) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.2.5 use
IOUtils.write(char[], OutputStream, Charset)
instead - write(char[], OutputStream, String) - Static method in class org.apache.commons.io.IOUtils
-
Writes chars from a
char[]
to bytes on anOutputStream
using the specified character encoding. - write(char[], OutputStream, Charset) - Static method in class org.apache.commons.io.IOUtils
-
Writes chars from a
char[]
to bytes on anOutputStream
using the specified character encoding. - write(char[], Writer) - Static method in class org.apache.commons.io.IOUtils
-
Writes chars from a
char[]
to aWriter
- write(int) - Method in class org.apache.commons.io.output.AbstractByteArrayOutputStream
- write(int) - Method in class org.apache.commons.io.output.AppendableOutputStream
-
Write a character to the underlying appendable.
- write(int) - Method in class org.apache.commons.io.output.AppendableWriter
-
Writes a character to the underlying appendable.
- write(int) - Method in class org.apache.commons.io.output.BrokenOutputStream
-
Throws the configured exception.
- write(int) - Method in class org.apache.commons.io.output.ByteArrayOutputStream
- write(int) - Method in class org.apache.commons.io.output.ClosedOutputStream
-
Throws an
IOException
to indicate that the stream is closed. - write(int) - Method in class org.apache.commons.io.output.DemuxOutputStream
-
Writes byte to stream associated with current thread.
- write(int) - Method in class org.apache.commons.io.output.FilterCollectionWriter
-
Writes a single character.
- write(int) - Method in class org.apache.commons.io.output.LockableFileWriter
-
Writes a character.
- write(int) - Method in class org.apache.commons.io.output.NullOutputStream
-
Does nothing - output to
/dev/null
. - write(int) - Method in class org.apache.commons.io.output.NullWriter
-
Does nothing - output to
/dev/null
. - write(int) - Method in class org.apache.commons.io.output.ProxyCollectionWriter
-
Invokes the delegate's
write(int)
method. - write(int) - Method in class org.apache.commons.io.output.ProxyOutputStream
-
Invokes the delegate's
write(int)
method. - write(int) - Method in class org.apache.commons.io.output.ProxyWriter
-
Invokes the delegate's
write(int)
method. - write(int) - Method in class org.apache.commons.io.output.QueueOutputStream
-
Writes a single byte.
- write(int) - Method in class org.apache.commons.io.output.TeeOutputStream
-
Writes a byte to both streams.
- write(int) - Method in class org.apache.commons.io.output.ThresholdingOutputStream
-
Writes the specified byte to this output stream.
- write(int) - Method in class org.apache.commons.io.output.UncheckedFilterOutputStream
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - write(int) - Method in class org.apache.commons.io.output.UncheckedFilterWriter
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - write(int) - Method in class org.apache.commons.io.output.UnsynchronizedByteArrayOutputStream
- write(int) - Method in class org.apache.commons.io.output.WriterOutputStream
-
Write a single byte to the stream.
- write(File, CharSequence) - Static method in class org.apache.commons.io.FileUtils
-
Deprecated.2.5 use
FileUtils.write(File, CharSequence, Charset)
instead (and specify the appropriate encoding) - write(File, CharSequence, boolean) - Static method in class org.apache.commons.io.FileUtils
-
Deprecated.2.5 use
FileUtils.write(File, CharSequence, Charset, boolean)
instead (and specify the appropriate encoding) - write(File, CharSequence, String) - Static method in class org.apache.commons.io.FileUtils
-
Writes a CharSequence to a file creating the file if it does not exist.
- write(File, CharSequence, String, boolean) - Static method in class org.apache.commons.io.FileUtils
-
Writes a CharSequence to a file creating the file if it does not exist.
- write(File, CharSequence, Charset) - Static method in class org.apache.commons.io.FileUtils
-
Writes a CharSequence to a file creating the file if it does not exist.
- write(File, CharSequence, Charset, boolean) - Static method in class org.apache.commons.io.FileUtils
-
Writes a CharSequence to a file creating the file if it does not exist.
- write(InputStream) - Method in class org.apache.commons.io.output.AbstractByteArrayOutputStream
-
Writes the entire contents of the specified input stream to this byte stream.
- write(InputStream) - Method in class org.apache.commons.io.output.ByteArrayOutputStream
- write(InputStream) - Method in class org.apache.commons.io.output.UnsynchronizedByteArrayOutputStream
- write(CharSequence, OutputStream) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.2.5 use
IOUtils.write(CharSequence, OutputStream, Charset)
instead - write(CharSequence, OutputStream, String) - Static method in class org.apache.commons.io.IOUtils
-
Writes chars from a
CharSequence
to bytes on anOutputStream
using the specified character encoding. - write(CharSequence, OutputStream, Charset) - Static method in class org.apache.commons.io.IOUtils
-
Writes chars from a
CharSequence
to bytes on anOutputStream
using the specified character encoding. - write(CharSequence, Writer) - Static method in class org.apache.commons.io.IOUtils
-
Writes chars from a
CharSequence
to aWriter
. - write(String) - Method in class org.apache.commons.io.output.FilterCollectionWriter
- write(String) - Method in class org.apache.commons.io.output.LockableFileWriter
-
Writes the characters from a string.
- write(String) - Method in class org.apache.commons.io.output.NullWriter
-
Does nothing - output to
/dev/null
. - write(String) - Method in class org.apache.commons.io.output.ProxyCollectionWriter
-
Invokes the delegate's
write(String)
method. - write(String) - Method in class org.apache.commons.io.output.ProxyWriter
-
Invokes the delegate's
write(String)
method. - write(String) - Method in class org.apache.commons.io.output.StringBuilderWriter
-
Writes a String to the
StringBuilder
. - write(String) - Method in class org.apache.commons.io.output.UncheckedFilterWriter
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - write(StringBuffer, OutputStream) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.
- write(StringBuffer, OutputStream, String) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.
- write(StringBuffer, Writer) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.
- write(String, int, int) - Method in class org.apache.commons.io.output.AppendableWriter
-
Writes a portion of a String to the underlying appendable.
- write(String, int, int) - Method in class org.apache.commons.io.output.FilterCollectionWriter
-
Writes a portion of a string.
- write(String, int, int) - Method in class org.apache.commons.io.output.LockableFileWriter
-
Writes the specified characters from a string.
- write(String, int, int) - Method in class org.apache.commons.io.output.NullWriter
-
Does nothing - output to
/dev/null
. - write(String, int, int) - Method in class org.apache.commons.io.output.ProxyCollectionWriter
-
Invokes the delegate's
write(String)
method. - write(String, int, int) - Method in class org.apache.commons.io.output.ProxyWriter
-
Invokes the delegate's
write(String)
method. - write(String, int, int) - Method in class org.apache.commons.io.output.UncheckedFilterWriter
-
Calls this method's super and rethrow
IOException
asUncheckedIOException
. - write(String, OutputStream) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.2.5 use
IOUtils.write(String, OutputStream, Charset)
instead - write(String, OutputStream, String) - Static method in class org.apache.commons.io.IOUtils
-
Writes chars from a
String
to bytes on anOutputStream
using the specified character encoding. - write(String, OutputStream, Charset) - Static method in class org.apache.commons.io.IOUtils
-
Writes chars from a
String
to bytes on anOutputStream
using the specified character encoding. - write(String, Writer) - Static method in class org.apache.commons.io.IOUtils
- write(Path, byte[], OpenOption...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.write(Path, byte[], OpenOption...)
throwingUncheckedIOException
instead ofIOException
. - write(Path, Iterable<? extends CharSequence>, Charset, OpenOption...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.write(Path, Iterable, Charset, OpenOption...)
throwingUncheckedIOException
instead ofIOException
. - write(Path, Iterable<? extends CharSequence>, OpenOption...) - Static method in class org.apache.commons.io.file.FilesUncheck
-
Delegates to
Files.write(Path, Iterable, OpenOption...)
throwingUncheckedIOException
instead ofIOException
. - writeByteArrayToFile(File, byte[]) - Static method in class org.apache.commons.io.FileUtils
-
Writes a byte array to a file creating the file if it does not exist.
- writeByteArrayToFile(File, byte[], boolean) - Static method in class org.apache.commons.io.FileUtils
-
Writes a byte array to a file creating the file if it does not exist.
- writeByteArrayToFile(File, byte[], int, int) - Static method in class org.apache.commons.io.FileUtils
-
Writes
len
bytes from the specified byte array starting at offsetoff
to a file, creating the file if it does not exist. - writeByteArrayToFile(File, byte[], int, int, boolean) - Static method in class org.apache.commons.io.FileUtils
-
Writes
len
bytes from the specified byte array starting at offsetoff
to a file, creating the file if it does not exist. - writeChunked(byte[], OutputStream) - Static method in class org.apache.commons.io.IOUtils
-
Writes bytes from a
byte[]
to anOutputStream
using chunked writes. - writeChunked(char[], Writer) - Static method in class org.apache.commons.io.IOUtils
-
Writes chars from a
char[]
to aWriter
using chunked writes. - writeImmediately - Variable in class org.apache.commons.io.output.WriterOutputStream.Builder
- writeImmediately - Variable in class org.apache.commons.io.output.WriterOutputStream
- writeImpl(byte[], int, int) - Method in class org.apache.commons.io.output.AbstractByteArrayOutputStream
-
Writes the bytes to the byte array.
- writeImpl(int) - Method in class org.apache.commons.io.output.AbstractByteArrayOutputStream
-
Write a byte to byte array.
- writeImpl(InputStream) - Method in class org.apache.commons.io.output.AbstractByteArrayOutputStream
-
Writes the entire contents of the specified input stream to this byte stream.
- writeLines(File, String, Collection<?>) - Static method in class org.apache.commons.io.FileUtils
-
Writes the
toString()
value of each item in a collection to the specifiedFile
line by line. - writeLines(File, String, Collection<?>, boolean) - Static method in class org.apache.commons.io.FileUtils
-
Writes the
toString()
value of each item in a collection to the specifiedFile
line by line, optionally appending. - writeLines(File, String, Collection<?>, String) - Static method in class org.apache.commons.io.FileUtils
-
Writes the
toString()
value of each item in a collection to the specifiedFile
line by line. - writeLines(File, String, Collection<?>, String, boolean) - Static method in class org.apache.commons.io.FileUtils
-
Writes the
toString()
value of each item in a collection to the specifiedFile
line by line. - writeLines(File, Collection<?>) - Static method in class org.apache.commons.io.FileUtils
-
Writes the
toString()
value of each item in a collection to the specifiedFile
line by line. - writeLines(File, Collection<?>, boolean) - Static method in class org.apache.commons.io.FileUtils
-
Writes the
toString()
value of each item in a collection to the specifiedFile
line by line. - writeLines(File, Collection<?>, String) - Static method in class org.apache.commons.io.FileUtils
-
Writes the
toString()
value of each item in a collection to the specifiedFile
line by line. - writeLines(File, Collection<?>, String, boolean) - Static method in class org.apache.commons.io.FileUtils
-
Writes the
toString()
value of each item in a collection to the specifiedFile
line by line. - writeLines(Collection<?>, String, OutputStream) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.2.5 use
IOUtils.writeLines(Collection, String, OutputStream, Charset)
instead - writeLines(Collection<?>, String, OutputStream, String) - Static method in class org.apache.commons.io.IOUtils
-
Writes the
Object.toString()
value of each item in a collection to anOutputStream
line by line, using the specified character encoding and the specified line ending. - writeLines(Collection<?>, String, OutputStream, Charset) - Static method in class org.apache.commons.io.IOUtils
-
Writes the
Object.toString()
value of each item in a collection to anOutputStream
line by line, using the specified character encoding and the specified line ending. - writeLines(Collection<?>, String, Writer) - Static method in class org.apache.commons.io.IOUtils
-
Writes the
Object.toString()
value of each item in a collection to aWriter
line by line, using the specified line ending. - writeObject(ObjectOutputStream) - Method in class org.apache.commons.io.monitor.SerializableFileTime
- writer - Variable in class org.apache.commons.io.output.WriterOutputStream
- writer - Variable in class org.apache.commons.io.output.XmlStreamWriter
- writer(Appendable) - Static method in class org.apache.commons.io.IOUtils
-
Returns the given Appendable if it is already a
Writer
, otherwise creates a Writer wrapper around the given Appendable. - WriterOrigin(Writer) - Constructor for class org.apache.commons.io.build.AbstractOrigin.WriterOrigin
-
Constructs a new instance for the given origin.
- WriterOutputStream - Class in org.apache.commons.io.output
-
OutputStream
implementation that transforms a byte stream to a character stream using a specified charset encoding and writes the resulting stream to aWriter
. - WriterOutputStream(Writer) - Constructor for class org.apache.commons.io.output.WriterOutputStream
-
Deprecated.
- WriterOutputStream(Writer, String) - Constructor for class org.apache.commons.io.output.WriterOutputStream
-
Deprecated.
- WriterOutputStream(Writer, String, int, boolean) - Constructor for class org.apache.commons.io.output.WriterOutputStream
-
Deprecated.
- WriterOutputStream(Writer, Charset) - Constructor for class org.apache.commons.io.output.WriterOutputStream
-
Deprecated.
- WriterOutputStream(Writer, CharsetDecoder) - Constructor for class org.apache.commons.io.output.WriterOutputStream
-
Deprecated.
- WriterOutputStream(Writer, CharsetDecoder, int, boolean) - Constructor for class org.apache.commons.io.output.WriterOutputStream
-
Deprecated.
- WriterOutputStream(Writer, Charset, int, boolean) - Constructor for class org.apache.commons.io.output.WriterOutputStream
-
Deprecated.
- WriterOutputStream.Builder - Class in org.apache.commons.io.output
-
Builds a new
WriterOutputStream
instance. - writers - Variable in class org.apache.commons.io.output.FilterCollectionWriter
-
The underlying writers.
- writers() - Method in class org.apache.commons.io.output.FilterCollectionWriter
- writeString(Path, CharSequence, Charset, OpenOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Writes the given character sequence to a file at the given path.
- writeStringToFile(File, String) - Static method in class org.apache.commons.io.FileUtils
-
Deprecated.2.5 use
FileUtils.writeStringToFile(File, String, Charset)
instead (and specify the appropriate encoding) - writeStringToFile(File, String, boolean) - Static method in class org.apache.commons.io.FileUtils
-
Deprecated.2.5 use
FileUtils.writeStringToFile(File, String, Charset, boolean)
instead (and specify the appropriate encoding) - writeStringToFile(File, String, String) - Static method in class org.apache.commons.io.FileUtils
-
Writes a String to a file creating the file if it does not exist.
- writeStringToFile(File, String, String, boolean) - Static method in class org.apache.commons.io.FileUtils
-
Writes a String to a file creating the file if it does not exist.
- writeStringToFile(File, String, Charset) - Static method in class org.apache.commons.io.FileUtils
-
Writes a String to a file creating the file if it does not exist.
- writeStringToFile(File, String, Charset, boolean) - Static method in class org.apache.commons.io.FileUtils
-
Writes a String to a file creating the file if it does not exist.
- writeSwappedDouble(byte[], int, double) - Static method in class org.apache.commons.io.EndianUtils
-
Writes a "double" value to a byte array at a given offset.
- writeSwappedDouble(OutputStream, double) - Static method in class org.apache.commons.io.EndianUtils
-
Writes a "double" value to an OutputStream.
- writeSwappedFloat(byte[], int, float) - Static method in class org.apache.commons.io.EndianUtils
-
Writes a "float" value to a byte array at a given offset.
- writeSwappedFloat(OutputStream, float) - Static method in class org.apache.commons.io.EndianUtils
-
Writes a "float" value to an OutputStream.
- writeSwappedInteger(byte[], int, int) - Static method in class org.apache.commons.io.EndianUtils
-
Writes an "int" value to a byte array at a given offset.
- writeSwappedInteger(OutputStream, int) - Static method in class org.apache.commons.io.EndianUtils
-
Writes an "int" value to an OutputStream.
- writeSwappedLong(byte[], int, long) - Static method in class org.apache.commons.io.EndianUtils
-
Writes a "long" value to a byte array at a given offset.
- writeSwappedLong(OutputStream, long) - Static method in class org.apache.commons.io.EndianUtils
-
Writes a "long" value to an OutputStream.
- writeSwappedShort(byte[], int, short) - Static method in class org.apache.commons.io.EndianUtils
-
Writes a "short" value to a byte array at a given offset.
- writeSwappedShort(OutputStream, short) - Static method in class org.apache.commons.io.EndianUtils
-
Writes a "short" value to an OutputStream.
- writeTo(OutputStream) - Method in class org.apache.commons.io.output.AbstractByteArrayOutputStream
-
Writes the entire contents of this byte stream to the specified output stream.
- writeTo(OutputStream) - Method in class org.apache.commons.io.output.ByteArrayOutputStream
- writeTo(OutputStream) - Method in class org.apache.commons.io.output.DeferredFileOutputStream
-
Writes the data from this output stream to the specified output stream, after it has been closed.
- writeTo(OutputStream) - Method in class org.apache.commons.io.output.UnsynchronizedByteArrayOutputStream
- writeToImpl(OutputStream) - Method in class org.apache.commons.io.output.AbstractByteArrayOutputStream
-
Writes the entire contents of this byte stream to the specified output stream.
- written - Variable in class org.apache.commons.io.output.ThresholdingOutputStream
-
The number of bytes written to the output stream.
X
- XML_GUESS_BYTES - Static variable in class org.apache.commons.io.input.XmlStreamReader
-
UTF_16LE and UTF_32LE have the same two starting BOM bytes.
- xmlEncoding - Variable in exception class org.apache.commons.io.input.XmlStreamReaderException
- xmlGuessEncoding - Variable in exception class org.apache.commons.io.input.XmlStreamReaderException
- XmlStreamReader - Class in org.apache.commons.io.input
-
Character stream that handles all the necessary Voodoo to figure out the charset encoding of the XML document within the stream.
- XmlStreamReader(File) - Constructor for class org.apache.commons.io.input.XmlStreamReader
-
Deprecated.
- XmlStreamReader(InputStream) - Constructor for class org.apache.commons.io.input.XmlStreamReader
-
Deprecated.
- XmlStreamReader(InputStream, boolean) - Constructor for class org.apache.commons.io.input.XmlStreamReader
-
Deprecated.
- XmlStreamReader(InputStream, boolean, String) - Constructor for class org.apache.commons.io.input.XmlStreamReader
-
Deprecated.
- XmlStreamReader(InputStream, String) - Constructor for class org.apache.commons.io.input.XmlStreamReader
-
Deprecated.
- XmlStreamReader(InputStream, String, boolean) - Constructor for class org.apache.commons.io.input.XmlStreamReader
-
Deprecated.
- XmlStreamReader(InputStream, String, boolean, String) - Constructor for class org.apache.commons.io.input.XmlStreamReader
-
Deprecated.
- XmlStreamReader(URL) - Constructor for class org.apache.commons.io.input.XmlStreamReader
-
Constructs a Reader using the InputStream of a URL.
- XmlStreamReader(URLConnection, String) - Constructor for class org.apache.commons.io.input.XmlStreamReader
-
Constructs a Reader using the InputStream of a URLConnection.
- XmlStreamReader(Path) - Constructor for class org.apache.commons.io.input.XmlStreamReader
-
Deprecated.
- XmlStreamReader.Builder - Class in org.apache.commons.io.input
-
Builds a new
XmlStreamWriter
instance. - XmlStreamReaderException - Exception Class in org.apache.commons.io.input
-
The XmlStreamReaderException is thrown by the XmlStreamReader constructors if the charset encoding can not be determined according to the XML 1.0 specification and RFC 3023.
- XmlStreamReaderException(String, String, String, String) - Constructor for exception class org.apache.commons.io.input.XmlStreamReaderException
-
Creates an exception instance if the charset encoding could not be determined.
- XmlStreamReaderException(String, String, String, String, String, String) - Constructor for exception class org.apache.commons.io.input.XmlStreamReaderException
-
Creates an exception instance if the charset encoding could not be determined.
- XmlStreamWriter - Class in org.apache.commons.io.output
-
Character stream that handles all the necessary work to figure out the charset encoding of the XML document written to the stream.
- XmlStreamWriter(File) - Constructor for class org.apache.commons.io.output.XmlStreamWriter
-
Deprecated.
- XmlStreamWriter(File, String) - Constructor for class org.apache.commons.io.output.XmlStreamWriter
-
Deprecated.
- XmlStreamWriter(OutputStream) - Constructor for class org.apache.commons.io.output.XmlStreamWriter
-
Deprecated.
- XmlStreamWriter(OutputStream, String) - Constructor for class org.apache.commons.io.output.XmlStreamWriter
-
Deprecated.
- XmlStreamWriter(OutputStream, Charset) - Constructor for class org.apache.commons.io.output.XmlStreamWriter
-
Constructs a new XML stream writer for the specified output stream with the specified default encoding.
- XmlStreamWriter.Builder - Class in org.apache.commons.io.output
-
Builds a new
XmlStreamWriter
instance.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
FileFilterUtils.and(IOFileFilter...)