A B C D E F G H I L M N O P Q R S T U V W X _
All Classes All Packages
All Classes All Packages
All Classes All Packages
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 extends java.io.InputStream> - Interface in org.apache.commons.io.output
-
Constructor for an InputStream subclass.
- AbstractCharacterFilterReader - Class in org.apache.commons.io.input
-
A filter reader that filters out characters where subclasses decide which characters to filter out.
- AbstractCharacterFilterReader(Reader) - Constructor for class org.apache.commons.io.input.AbstractCharacterFilterReader
-
Constructs a new reader.
- 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
-
An abstract class which implements the Java FileFilter and FilenameFilter interfaces via the IOFileFilter interface.
- AbstractFileFilter() - Constructor for class org.apache.commons.io.filefilter.AbstractFileFilter
- AbstractPathCounters(Counters.Counter, Counters.Counter, Counters.Counter) - Constructor for class org.apache.commons.io.file.Counters.AbstractPathCounters
-
Constructs a new instance.
- 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.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.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.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.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.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(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(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.
- 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(Counters.PathCounters) - Constructor for class org.apache.commons.io.file.AccumulatorPathVisitor
-
Constructs a new instance.
- 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(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.
- 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.
- 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(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.
- and(IOFileFilter...) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that ANDs the specified filters.
- 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 instance of
AndFileFilter
. - 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, IOFileFilter) - Constructor for class org.apache.commons.io.filefilter.AndFileFilter
-
Constructs a new file filter that ANDs the result of two 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(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.IOFunction
-
Returns a composed
IOFunction
that first applies this function to its input, and then applies theafter
function to the result. - 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(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, 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
. - appendable - Variable in class org.apache.commons.io.output.AppendableOutputStream
- appendable - Variable in class org.apache.commons.io.output.AppendableWriter
- AppendableOutputStream<T extends java.lang.Appendable> - Class in org.apache.commons.io.output
-
OutputStream implementation that writes the data to an
Appendable
Object. - AppendableOutputStream(T) - Constructor for class org.apache.commons.io.output.AppendableOutputStream
-
Construct a new instance with the specified appendable.
- AppendableWriter<T extends java.lang.Appendable> - Class in org.apache.commons.io.output
-
Writer implementation that writes the data to an
Appendable
Object. - AppendableWriter(T) - Constructor for class org.apache.commons.io.output.AppendableWriter
-
Constructs a new instance with the specified appendable.
- apply(T) - Method in interface org.apache.commons.io.function.IOFunction
-
Applies this function to the given argument.
- 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. - 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
-
Creates an automatically closing proxy for the given input stream.
- 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.CharSequenceInputStream
-
Return an estimate of the number of bytes remaining in the byte stream.
- 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.UnsynchronizedByteArrayInputStream
- 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
- bbuf - 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.
- blockSize - Variable in class org.apache.commons.io.input.ReversedLinesFileReader
- bomEncoding - Variable in exception 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
-
Constructs a new BOM InputStream that excludes a
ByteOrderMark.UTF_8
BOM. - BOMInputStream(InputStream, boolean) - Constructor for class org.apache.commons.io.input.BOMInputStream
-
Constructs a new BOM InputStream that detects a a
ByteOrderMark.UTF_8
and optionally includes it. - BOMInputStream(InputStream, boolean, ByteOrderMark...) - Constructor for class org.apache.commons.io.input.BOMInputStream
-
Constructs a new BOM InputStream that detects the specified BOMs and optionally includes them.
- BOMInputStream(InputStream, ByteOrderMark...) - Constructor for class org.apache.commons.io.input.BOMInputStream
-
Constructs a new BOM InputStream that excludes the specified BOMs.
- 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
-
This is a stream that will only supply bytes up to a certain length - if its position goes above that, it will stop.
- BoundedInputStream(InputStream) - Constructor for class org.apache.commons.io.input.BoundedInputStream
-
Creates a new
BoundedInputStream
that wraps the given input stream and is unlimited. - BoundedInputStream(InputStream, long) - Constructor for class org.apache.commons.io.input.BoundedInputStream
-
Creates 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
-
Broken input stream.
- 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.
- 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.
- BrokenReader - Class in org.apache.commons.io.input
-
Broken reader.
- 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.
- BrokenWriter - Class in org.apache.commons.io.output
-
Broken writer.
- 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.
- buffer - Variable in class org.apache.commons.io.input.buffer.CircularBufferInputStream
- buffer - Variable in class org.apache.commons.io.input.buffer.CircularByteBuffer
- 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.input.CharSequenceInputStream
- BUFFER_SIZE - Static variable in class org.apache.commons.io.input.XmlStreamReader
- BUFFER_SIZE - Static variable in class org.apache.commons.io.output.WriterOutputStream
- BUFFER_SIZE - Static variable in class org.apache.commons.io.output.XmlStreamWriter
- 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.input.buffer.CircularBufferInputStream
- builder - Variable in class org.apache.commons.io.output.StringBuilderWriter
- 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.
- 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(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 - see
BOMInputStream
. - ByteOrderMark(String, int...) - Constructor for class org.apache.commons.io.ByteOrderMark
-
Construct a new BOM.
- ByteOrderMarkLengthComparator - Static variable in class org.apache.commons.io.input.BOMInputStream
-
Compares ByteOrderMark objects in descending length order.
- 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
- 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
-
Calculate 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 org.apache.commons.io.DirectoryWalker.CancelException
-
Constructs a
CancelException
with the file and depth when cancellation occurred. - CancelException(String, File, int) - Constructor for exception org.apache.commons.io.DirectoryWalker.CancelException
-
Constructs a
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
- caseSensitivity - Variable in class org.apache.commons.io.comparator.ExtensionFileComparator
-
Whether the comparison is case sensitive.
- caseSensitivity - Variable in class org.apache.commons.io.comparator.NameFileComparator
-
Whether the comparison is case sensitive.
- caseSensitivity - Variable in class org.apache.commons.io.comparator.PathFileComparator
-
Whether the comparison is case sensitive.
- caseSensitivity - Variable in class org.apache.commons.io.filefilter.NameFileFilter
-
Whether the comparison is case sensitive.
- caseSensitivity - Variable in class org.apache.commons.io.filefilter.PrefixFileFilter
-
Whether the comparison is case sensitive.
- caseSensitivity - Variable in class org.apache.commons.io.filefilter.SuffixFileFilter
-
Whether the comparison is case sensitive.
- caseSensitivity - Variable in class org.apache.commons.io.filefilter.WildcardFileFilter
-
Whether the comparison is case sensitive.
- causeList - Variable in exception org.apache.commons.io.IOExceptionList
- cbuf - Variable in class org.apache.commons.io.input.CharSequenceInputStream
- 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.
- 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, Set<Integer>) - Constructor for class org.apache.commons.io.input.CharacterSetFilterReader
-
Constructs a new reader.
- charSequence - Variable in class org.apache.commons.io.input.CharSequenceReader
- CharSequenceInputStream - Class in org.apache.commons.io.input
-
InputStream
implementation that can read from String, StringBuffer, StringBuilder or CharBuffer. - CharSequenceInputStream(CharSequence, String) - Constructor for class org.apache.commons.io.input.CharSequenceInputStream
-
Constructor, calls
CharSequenceInputStream(CharSequence, String, int)
with a buffer size of 2048. - CharSequenceInputStream(CharSequence, String, int) - Constructor for class org.apache.commons.io.input.CharSequenceInputStream
-
Constructor, calls
CharSequenceInputStream(CharSequence, Charset, int)
. - CharSequenceInputStream(CharSequence, Charset) - Constructor for class org.apache.commons.io.input.CharSequenceInputStream
-
Constructor, calls
CharSequenceInputStream(CharSequence, Charset, int)
with a buffer size of 2048. - CharSequenceInputStream(CharSequence, Charset, int) - Constructor for class org.apache.commons.io.input.CharSequenceInputStream
-
Constructor.
- 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.input.Tailer
-
The character set that will be used to read the file.
- CHARSET_PATTERN - Static variable in class org.apache.commons.io.input.XmlStreamReader
- 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.
- checkCompareTo(String, String) - Method in enum org.apache.commons.io.IOCase
-
Compares two strings using the case-sensitivity rule.
- checkDirectory(File) - Static method in class org.apache.commons.io.FileUtils
-
Checks that the given
File
exists and is a directory. - 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.
- checkEqualSizes(File, File, long, long) - Static method in class org.apache.commons.io.FileUtils
-
Checks that two file lengths are equal.
- checkFileRequirements(File, File) - Static method in class org.apache.commons.io.FileUtils
-
Checks requirements for file copy.
- checkIbmJdkWithBrokenUTF16(Charset) - Static method in class org.apache.commons.io.output.WriterOutputStream
-
Check if the JDK in use properly supports the given charset.
- checkIfCancelled(File, int, Collection<T>) - Method in class org.apache.commons.io.DirectoryWalker
-
Checks whether the walk has been cancelled by calling
DirectoryWalker.handleIsCancelled(java.io.File, int, java.util.Collection<T>)
, throwing aCancelException
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.
- 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
-
Creates a new stream that uses a chunk size of
ChunkedOutputStream.DEFAULT_CHUNK_SIZE
. - ChunkedOutputStream(OutputStream, int) - Constructor for class org.apache.commons.io.output.ChunkedOutputStream
-
Creates a new stream that uses the specified chunk size.
- 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
-
Implementation of a buffered input stream, which is internally based on the
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.
- 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 sub-directories without deleting directories.
- cleanDirectory(Path, DeleteOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Cleans a directory including sub-directories without deleting directories.
- cleanDirectoryOnExit(File) - Static method in class org.apache.commons.io.FileUtils
-
Cleans a directory without deleting it.
- 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.
- clear() - Method in class org.apache.commons.io.input.buffer.CircularByteBuffer
-
Removes all bytes from the buffer.
- 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.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.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.ReaderInputStream
-
Close 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.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.UnixLineEndingInputStream
-
Closes the 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
-
Closing a
ByteArrayOutputStream
has no effect. - 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.FileWriterWithEncoding
-
Close the stream.
- 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 lockfile (if possible).
- 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.WriterOutputStream
-
Close the stream.
- close() - Method in class org.apache.commons.io.output.XmlStreamWriter
-
Closes the underlying writer.
- 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
as a null-safe operation. - 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.
- 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.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_INPUT_STREAM - Static variable in class org.apache.commons.io.input.ClosedInputStream
-
A singleton.
- CLOSED_OUTPUT_STREAM - Static variable in class org.apache.commons.io.output.ClosedOutputStream
-
A singleton.
- CLOSED_READER - Static variable in class org.apache.commons.io.input.ClosedReader
-
A singleton.
- CLOSED_WRITER - Static variable in class org.apache.commons.io.output.ClosedWriter
-
A singleton.
- ClosedInputStream - Class in org.apache.commons.io.input
-
Closed input stream.
- ClosedInputStream() - Constructor for class org.apache.commons.io.input.ClosedInputStream
- ClosedOutputStream - Class in org.apache.commons.io.output
-
Throws an exception 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
-
Closed reader.
- ClosedReader() - Constructor for class org.apache.commons.io.input.ClosedReader
- ClosedWriter - Class in org.apache.commons.io.output
-
Throws an exception on all attempts to write with
ClosedWriter.close()
implemented as a noop. - ClosedWriter() - Constructor for class org.apache.commons.io.output.ClosedWriter
- closeOnClose - Variable in class org.apache.commons.io.input.RandomAccessFileInputStream
- closeQuietly(Closeable) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.As of 2.6 deprecated without replacement. Please use the try-with-resources statement or handle suppressed exceptions manually.
- closeQuietly(Closeable...) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.As of 2.6 deprecated without replacement. Please use the try-with-resources statement or handle suppressed exceptions manually.
- 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
-
Deprecated.As of 2.6 deprecated without replacement. Please use the try-with-resources statement or handle suppressed exceptions manually.
- closeQuietly(OutputStream) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.As of 2.6 deprecated without replacement. Please use the try-with-resources statement or handle suppressed exceptions manually.
- closeQuietly(Reader) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.As of 2.6 deprecated without replacement. Please use the try-with-resources statement or handle suppressed exceptions manually.
- closeQuietly(Writer) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.As of 2.6 deprecated without replacement. Please use the try-with-resources statement or handle suppressed exceptions manually.
- closeQuietly(ServerSocket) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.As of 2.6 deprecated without replacement. Please use the try-with-resources statement or handle suppressed exceptions manually.
- closeQuietly(Socket) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.As of 2.6 deprecated without replacement. Please use the try-with-resources statement or handle suppressed exceptions manually.
- closeQuietly(Selector) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.As of 2.6 deprecated without replacement. Please use the try-with-resources statement or handle suppressed exceptions manually.
- 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
-
Creates a proxy that shields the given input stream from being closed.
- 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
-
Creates a proxy that shields the given output stream from being closed.
- CloseShieldReader - Class in org.apache.commons.io.input
-
Proxy stream that prevents the underlying reader from being closed.
- CloseShieldReader(Reader) - Constructor for class org.apache.commons.io.input.CloseShieldReader
-
Creates a proxy that shields the given reader from being closed.
- CloseShieldWriter - Class in org.apache.commons.io.output
-
Proxy stream that prevents the underlying writer from being closed.
- CloseShieldWriter(Writer) - Constructor for class org.apache.commons.io.output.CloseShieldWriter
-
Creates a proxy that shields the given writer from being closed.
- comparator - Variable in class org.apache.commons.io.monitor.FileAlterationObserver
- compare(File, File) - Method in class org.apache.commons.io.comparator.CompositeFileComparator
-
Compare the two files using delegate comparators.
- compare(File, File) - Method in class org.apache.commons.io.comparator.DefaultFileComparator
-
Compare the two files using the
File.compareTo(File)
method. - compare(File, File) - Method in class org.apache.commons.io.comparator.DirectoryFileComparator
-
Compare the two files using the
File.isDirectory()
method. - compare(File, File) - Method in class org.apache.commons.io.comparator.ExtensionFileComparator
-
Compare the extensions of two files the specified case sensitivity.
- compare(File, File) - Method in class org.apache.commons.io.comparator.LastModifiedFileComparator
-
Compares the last the last modified date/time of two files.
- compare(File, File) - Method in class org.apache.commons.io.comparator.NameFileComparator
-
Compare the names of two files with the specified case sensitivity.
- compare(File, File) - Method in class org.apache.commons.io.comparator.PathFileComparator
-
Compare 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
-
Compare the length of two files.
- compose(Function<? super V, ? extends T>) - Method in interface org.apache.commons.io.function.IOFunction
-
Returns a composed
IOFunction
that first applies thebefore
function to its input, and then applies this function to the result. - compose(Supplier<? extends T>) - Method in interface org.apache.commons.io.function.IOFunction
-
Returns a composed
IOFunction
that first applies thebefore
function to its input, and then applies this function to the result. - compose(IOFunction<? super V, ? extends T>) - Method in interface org.apache.commons.io.function.IOFunction
-
Returns a composed
IOFunction
that first applies thebefore
function to its input, and then applies this function to the result. - compose(IOSupplier<? extends T>) - Method in interface org.apache.commons.io.function.IOFunction
-
Returns a composed
IOFunction
that first applies thebefore
function to its input, and then applies this function to the result. - CompositeFileComparator - Class in org.apache.commons.io.comparator
-
Compare two files using a set of delegate file
Comparator
. - CompositeFileComparator(Iterable<Comparator<File>>) - Constructor for class org.apache.commons.io.comparator.CompositeFileComparator
-
Create a composite comparator for the set of delegate comparators.
- CompositeFileComparator(Comparator<File>...) - Constructor for class org.apache.commons.io.comparator.CompositeFileComparator
-
Create a composite comparator for the set of delegate comparators.
- concat(String, String) - Static method in class org.apache.commons.io.FilenameUtils
-
Concatenates a fileName to a base path using normal command line style rules.
- ConditionalFileFilter - Interface in org.apache.commons.io.filefilter
-
Defines operations for conditional file filters.
- construct(byte[], int, int) - Method in interface org.apache.commons.io.output.AbstractByteArrayOutputStream.InputStreamConstructor
-
Construct 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. - contentEquals(File, File) - Static method in class org.apache.commons.io.FileUtils
-
Compares the contents of two files to determine if they are equal or not.
- 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.
- 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 org.apache.commons.io.input.XmlStreamReaderException
- contentTypeMime - Variable in exception 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 instanced into array representation.
- copy(byte[], OutputStream) - Static method in class org.apache.commons.io.CopyUtils
-
Deprecated.Copy 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.Copy and convert bytes from a
byte[]
to chars on aWriter
, using the specified encoding. - copy(InputStream, OutputStream) - Static method in class org.apache.commons.io.CopyUtils
-
Deprecated.Copy 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.Copy 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(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.Serialize chars from a
Reader
to bytes on anOutputStream
, and flush theOutputStream
. - 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 chars from a
Reader
to aWriter
. - copy(Reader, Writer) - Static method in class org.apache.commons.io.IOUtils
-
Copies chars from a
Reader
to aWriter
. - 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.Serialize chars from a
String
to bytes on anOutputStream
, and flush theOutputStream
. - copy(String, Writer) - Static method in class org.apache.commons.io.CopyUtils
-
Deprecated.Copy chars from a
String
to aWriter
. - copy(Path, Path) - Method in class org.apache.commons.io.file.CopyDirectoryVisitor
-
Copies the sourceFile to the targetFile.
- 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.
- 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 a file to a new location.
- copyFile(File, File, boolean, 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
-
Copy 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
-
Copies bytes from an
InputStream
source
to a filedestination
. - 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
-
Copies chars from a large (over 2GB)
Reader
to aWriter
. - copyLarge(Reader, Writer, char[]) - Static method in class org.apache.commons.io.IOUtils
-
Copies chars from a large (over 2GB)
Reader
to aWriter
. - 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 a filedestination
. - 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 2.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.CountingInputStream
-
The count of bytes that have passed.
- 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.
- countDirectory(Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Counts aspects of a directory including sub-directories.
- 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.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.
- create(File, Charset, TailerListener, long, boolean, boolean, int) - Static method in class org.apache.commons.io.input.Tailer
-
Creates and starts a Tailer for the given file.
- create(File, TailerListener) - Static method in class org.apache.commons.io.input.Tailer
-
Creates and starts a Tailer for the given file, starting at the beginning of the file with the default delay of 1.0s
- create(File, TailerListener, long) - Static method in class org.apache.commons.io.input.Tailer
-
Creates and starts a Tailer for the given file, starting at the beginning of the file
- create(File, TailerListener, long, boolean) - Static method in class org.apache.commons.io.input.Tailer
-
Creates and starts a Tailer for the given file with default buffer size.
- create(File, TailerListener, long, boolean, boolean) - Static method in class org.apache.commons.io.input.Tailer
-
Creates and starts a Tailer for the given file with default buffer size.
- create(File, TailerListener, long, boolean, boolean, int) - Static method in class org.apache.commons.io.input.Tailer
-
Creates and starts a Tailer for the given file.
- create(File, TailerListener, long, boolean, int) - Static method in class org.apache.commons.io.input.Tailer
-
Creates and starts a Tailer for the given file.
- 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 left over bytes.
- createLock() - Method in class org.apache.commons.io.output.LockableFileWriter
-
Creates the lock file.
- 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.
- cutoff - Variable in class org.apache.commons.io.filefilter.AgeFileFilter
-
The cutoff time threshold.
- cvsFilter - 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_BLOCK_SIZE - Static variable in class org.apache.commons.io.input.ReversedLinesFileReader
- DEFAULT_BUFFER_SIZE - Static variable in class org.apache.commons.io.CopyUtils
-
Deprecated.The default size of the buffer.
- DEFAULT_BUFFER_SIZE - Static variable in class org.apache.commons.io.input.ReaderInputStream
- 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.ChunkedOutputStream
-
The default chunk size to use, i.e.
- 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_MILLIS - Static variable in class org.apache.commons.io.input.Tailer
- 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
- defaultEncoding - Variable in class org.apache.commons.io.input.XmlStreamReader
- defaultEncoding - Variable in class org.apache.commons.io.output.XmlStreamWriter
- DefaultFileComparator - Class in org.apache.commons.io.comparator
-
Compare two files using the default
File.compareTo(File)
method. - DefaultFileComparator() - Constructor for class org.apache.commons.io.comparator.DefaultFileComparator
- 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
-
Constructs an instance of this class which will trigger an event at the specified threshold, and save data to a file beyond that point.
- DeferredFileOutputStream(int, int, String, String, File) - 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 to a temporary file beyond that point.
- DeferredFileOutputStream(int, File) - 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 to a file beyond that point.
- 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
-
Constructs an instance of this class which will trigger an event at the specified threshold, and save data to a temporary file beyond that point.
- delayMillis - 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
- 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(Path) - 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 sub-directories.
- deleteDirectory(Path, DeleteOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Deletes a directory including sub-directories.
- 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, DeleteOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Deletes the given file.
- 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, 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
- depth - Variable in exception org.apache.commons.io.DirectoryWalker.CancelException
-
The file depth when the exception was thrown.
- depthLimit - Variable in class org.apache.commons.io.DirectoryWalker
-
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
-
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.
- DirectoryWalker<T> - Class in org.apache.commons.io
-
Abstract class that walks through a directory hierarchy and provides subclasses with convenient hooks to add specific behavior.
- DirectoryWalker() - Constructor for class org.apache.commons.io.DirectoryWalker
-
Construct an instance with no filtering and unlimited depth.
- DirectoryWalker(FileFilter, int) - Constructor for class org.apache.commons.io.DirectoryWalker
-
Constructs an instance with a filter and limit the depth navigated to.
- DirectoryWalker(IOFileFilter, IOFileFilter, int) - Constructor for class org.apache.commons.io.DirectoryWalker
-
Constructs an instance with a directory and a file filter and an optional limit on the depth navigated to.
- DirectoryWalker.CancelException - Exception in org.apache.commons.io
-
CancelException is thrown in DirectoryWalker to cancel the current processing.
- dirList - Variable in class org.apache.commons.io.file.AccumulatorPathVisitor
- doCopyDirectory(File, File, FileFilter, boolean, List<String>, CopyOption...) - Static method in class org.apache.commons.io.FileUtils
-
Internal copy directory method.
- doCopyFile(File, File, boolean, CopyOption...) - Static method in class org.apache.commons.io.FileUtils
-
Internal copy file 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
-
Do 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
-
Dump an array of bytes to an OutputStream.
- dump(StringBuilder, byte) - Static method in class org.apache.commons.io.HexDump
-
Dump a byte value into a StringBuilder.
- dump(StringBuilder, long) - Static method in class org.apache.commons.io.HexDump
-
Dump a long value into a StringBuilder.
E
- EBCDIC - Static variable in class org.apache.commons.io.input.XmlStreamReader
- EMPTY - Static variable in class org.apache.commons.io.filefilter.EmptyFileFilter
-
Singleton instance of empty filter
- EMPTY_BYTE_ARRAY - Static variable in class org.apache.commons.io.IOUtils
- EMPTY_BYTE_ARRAY - Static variable in class org.apache.commons.io.output.AbstractByteArrayOutputStream
-
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.CopyDirectoryVisitor
- EMPTY_DELETE_OPTION_ARRAY - Static variable in class org.apache.commons.io.file.PathUtils
-
Empty
LinkOption
array. - EMPTY_ENTRIES - Static variable in class org.apache.commons.io.monitor.FileEntry
- EMPTY_FILE_ARRAY - Static variable in class org.apache.commons.io.FileUtils
-
An empty array of type
File
. - 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_SET - Static variable in class org.apache.commons.io.input.CharacterSetFilterReader
- 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.
- 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.
- encoder - Variable in class org.apache.commons.io.input.CharSequenceInputStream
- encoder - Variable in class org.apache.commons.io.input.ReaderInputStream
- 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.ReversedLinesFileReader
- encoding - Variable in class org.apache.commons.io.input.XmlStreamReader
- encoding - Variable in class org.apache.commons.io.output.XmlStreamWriter
- ENCODING_PATTERN - Static variable in class org.apache.commons.io.input.XmlStreamReader
-
Pattern capturing the encoding of the "xml" processing instruction.
- ENCODING_PATTERN - Static variable in class org.apache.commons.io.output.XmlStreamWriter
- 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
-
Whether to tail from the end or start of file
- 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
-
Utility code for dealing 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
- ensureLineFeedAtEndOfFile - Variable in class org.apache.commons.io.input.UnixLineEndingInputStream
- ensureLineFeedAtEndOfFile - Variable in class org.apache.commons.io.input.WindowsLineEndingInputStream
- eod - Variable in class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream
-
End Of Data.
- 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).
- eofGame() - Method in class org.apache.commons.io.input.WindowsLineEndingInputStream
-
Handles the eof-handling at the end of the stream
- eofGame(boolean) - Method in class org.apache.commons.io.input.UnixLineEndingInputStream
-
Handles the eof-handling at the end of the stream
- eofSeen - Variable in class org.apache.commons.io.input.buffer.CircularBufferInputStream
- eofSeen - Variable in class org.apache.commons.io.input.UnixLineEndingInputStream
- eofSeen - Variable in class org.apache.commons.io.input.WindowsLineEndingInputStream
- EOL - Static variable in class org.apache.commons.io.HexDump
-
The line-separator (initializes to "line.separator" system property.
- equals - Variable in class org.apache.commons.io.file.PathUtils.RelativeSortedPaths
- equals(Object) - Method in class org.apache.commons.io.ByteOrderMark
-
Indicates if this BOM's bytes equals another.
- equals(Object) - Method in class org.apache.commons.io.file.AccumulatorPathVisitor
- equals(Object) - Method in class org.apache.commons.io.file.CleaningPathVisitor
- equals(Object) - Method in class org.apache.commons.io.file.CopyDirectoryVisitor
- equals(Object) - Method in class org.apache.commons.io.file.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(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.
- error(IOException) - Method in class org.apache.commons.io.input.ObservableInputStream.Observer
-
Called to indicate that an error occurred on the underlying stream.
- exception - Variable in class org.apache.commons.io.input.BrokenInputStream
-
The exception that is thrown by all methods of this class.
- exception - Variable in class org.apache.commons.io.input.BrokenReader
-
The exception that is thrown by all methods of this class.
- exception - Variable in class org.apache.commons.io.output.BrokenOutputStream
-
The exception that is thrown by all methods of this class.
- exception - Variable in class org.apache.commons.io.output.BrokenWriter
-
The exception that is thrown by all methods of this class.
- exists - Variable in class org.apache.commons.io.monitor.FileEntry
- 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
-
Construct a case sensitive file extension comparator instance.
- ExtensionFileComparator(IOCase) - Constructor for class org.apache.commons.io.comparator.ExtensionFileComparator
-
Construct a file extension comparator instance with the specified case-sensitivity.
F
- failIfNullBytePresent(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Check the input for null bytes, a sign of unsanitized data being passed to to file level functions.
- 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 org.apache.commons.io.DirectoryWalker.CancelException
-
The file being processed when the exception was thrown.
- file - Variable in class org.apache.commons.io.input.Tailer
-
The file which will be tailed.
- file - Variable in class org.apache.commons.io.monitor.FileEntry
- FILE - Static variable in class org.apache.commons.io.filefilter.FileFileFilter
-
Singleton instance of file filter
- FileAlterationListener - Interface in org.apache.commons.io.monitor
-
A listener that 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, 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
-
Construct 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.
- 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 - 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
-
Construct a new monitor for a specified
File
. - FileEntry(FileEntry, File) - Constructor for class org.apache.commons.io.monitor.FileEntry
-
Construct a new monitor for a specified
File
. - FileExistsException - Exception in org.apache.commons.io
-
Indicates that a file already exists.
- FileExistsException() - Constructor for exception org.apache.commons.io.FileExistsException
-
Default Constructor.
- FileExistsException(File) - Constructor for exception org.apache.commons.io.FileExistsException
-
Construct an instance with the specified file.
- FileExistsException(String) - Constructor for exception org.apache.commons.io.FileExistsException
-
Construct 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.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.
- 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.
- FilePart(long, int, byte[]) - Constructor for class org.apache.commons.io.input.ReversedLinesFileReader.FilePart
-
ctor
- 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.
- 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(boolean, boolean, int, int, char[], String[]) - Constructor for enum org.apache.commons.io.FileSystem
-
Constructs a new instance.
- 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.
- FileUtils - Class in org.apache.commons.io
-
General file manipulation utilities.
- FileUtils() - Constructor for class org.apache.commons.io.FileUtils
-
Instances should NOT be constructed in standard programming.
- 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
-
Constructs a FileWriterWithEncoding with a file encoding.
- FileWriterWithEncoding(File, String, boolean) - Constructor for class org.apache.commons.io.output.FileWriterWithEncoding
-
Constructs a FileWriterWithEncoding with a file encoding.
- FileWriterWithEncoding(File, Charset) - Constructor for class org.apache.commons.io.output.FileWriterWithEncoding
-
Constructs a FileWriterWithEncoding with a file encoding.
- FileWriterWithEncoding(File, CharsetEncoder) - Constructor for class org.apache.commons.io.output.FileWriterWithEncoding
-
Constructs a FileWriterWithEncoding with a file encoding.
- FileWriterWithEncoding(File, CharsetEncoder, boolean) - Constructor for class org.apache.commons.io.output.FileWriterWithEncoding
-
Constructs a FileWriterWithEncoding with a file encoding.
- FileWriterWithEncoding(File, Charset, boolean) - Constructor for class org.apache.commons.io.output.FileWriterWithEncoding
-
Constructs a FileWriterWithEncoding with a file encoding.
- FileWriterWithEncoding(String, String) - Constructor for class org.apache.commons.io.output.FileWriterWithEncoding
-
Constructs a FileWriterWithEncoding with a file encoding.
- FileWriterWithEncoding(String, String, boolean) - Constructor for class org.apache.commons.io.output.FileWriterWithEncoding
-
Constructs a FileWriterWithEncoding with a file encoding.
- FileWriterWithEncoding(String, Charset) - Constructor for class org.apache.commons.io.output.FileWriterWithEncoding
-
Constructs a FileWriterWithEncoding with a file encoding.
- FileWriterWithEncoding(String, CharsetEncoder) - Constructor for class org.apache.commons.io.output.FileWriterWithEncoding
-
Constructs a FileWriterWithEncoding with a file encoding.
- FileWriterWithEncoding(String, CharsetEncoder, boolean) - Constructor for class org.apache.commons.io.output.FileWriterWithEncoding
-
Constructs a FileWriterWithEncoding with a file encoding.
- FileWriterWithEncoding(String, Charset, boolean) - Constructor for class org.apache.commons.io.output.FileWriterWithEncoding
-
Constructs a FileWriterWithEncoding with a file encoding.
- 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.
- 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
-
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(int) - Method in class org.apache.commons.io.input.CharacterFilterReader
- filter(int) - Method in class org.apache.commons.io.input.CharacterSetFilterReader
- 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(IOFileFilter, Iterable<File>, T) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Applies an
IOFileFilter
to the providedFile
objects and appends the accepted files to the other supplied collection. - 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
-
Overridable callback method invoked with the contents of each directory.
- filterList(IOFileFilter, File...) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Applies an
IOFileFilter
to the providedFile
objects. - filterList(IOFileFilter, Iterable<File>) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Applies an
IOFileFilter
to the providedFile
objects. - filterSet(IOFileFilter, File...) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Applies an
IOFileFilter
to the providedFile
objects. - filterSet(IOFileFilter, Iterable<File>) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Applies an
IOFileFilter
to the providedFile
objects. - finalize() - Method in class org.apache.commons.io.input.AutoCloseInputStream
-
Ensures that the stream is closed before it gets garbage-collected.
- find() - Method in class org.apache.commons.io.input.BOMInputStream
-
Find a BOM with the specified bytes.
- 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
- 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.FileWriterWithEncoding
-
Flush the stream.
- flush() - Method in class org.apache.commons.io.output.FilterCollectionWriter
-
Flushes the stream.
- flush() - Method in class org.apache.commons.io.output.LockableFileWriter
-
Flush 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.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.
- 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.
- 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
-
Makes a directory, including any necessary but nonexistent parent directories.
- forceMkdirParent(File) - Static method in class org.apache.commons.io.FileUtils
-
Makes any necessary but nonexistent parent directories for a given File.
- 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, long) - 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, long) - Method in class org.apache.commons.io.FileSystemUtils
-
Deprecated.Find free space on the *nix platform using the 'df' command.
- freeSpaceWindows(String, long) - 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 - org.apache.commons.io.FileSystem
-
Generic file system.
- 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 interface org.apache.commons.io.function.IOSupplier
-
Gets a result.
- get(int) - Method in class org.apache.commons.io.ByteOrderMark
-
The byte at the specified position.
- getAclEntryList(Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Reads the access control list from a file attribute view.
- getAdsCriticalOffset(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Special handling for NTFS ADS: Don't accept colon in the fileName.
- 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.
- 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
- getBOM() - Method in class org.apache.commons.io.input.BOMInputStream
-
Return the BOM (Byte Order Mark).
- getBOMCharsetName() - Method in class org.apache.commons.io.input.BOMInputStream
-
Return the BOM charset Name -
ByteOrderMark.getCharsetName()
. - getBomEncoding() - Method in exception org.apache.commons.io.input.XmlStreamReaderException
-
Returns the BOM encoding found in the InputStream.
- getBuilder() - Method in class org.apache.commons.io.output.StringBuilderWriter
-
Returns the underlying builder.
- getByteCount() - Method in class org.apache.commons.io.input.CountingInputStream
-
The 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
-
Return a copy of the BOM's bytes.
- getCause() - Method in exception org.apache.commons.io.TaggedIOException
-
Returns the wrapped exception.
- getCause(int) - Method in exception org.apache.commons.io.IOExceptionList
-
Gets the cause exception at the given index.
- getCause(int, Class<T>) - Method in exception org.apache.commons.io.IOExceptionList
-
Gets the cause exception at the given index.
- getCauseList() - Method in exception org.apache.commons.io.IOExceptionList
-
Gets the cause list.
- getCauseList(Class<T>) - Method in exception org.apache.commons.io.IOExceptionList
-
Works around Throwable and Generics, may fail at runtime depending on the argument value.
- getCharsetName() - Method in class org.apache.commons.io.ByteOrderMark
-
Return the name of the
Charset
the BOM represents. - getChildren() - Method in class org.apache.commons.io.monitor.FileEntry
-
Return the directory's files.
- getContentTypeEncoding() - Method in exception 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
-
Returns charset parameter value, NULL if not present, NULL if httpContentType is NULL.
- getContentTypeMime() - Method in exception 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
-
Returns 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.CountingInputStream
-
The 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
-
Returns the data for this output stream as an array of bytes, assuming that the data has been retained in memory.
- getDefaultEncoding() - Method in class org.apache.commons.io.input.XmlStreamReader
-
Returns the default encoding to use if none is set in HTTP content-type, XML prolog and the rules based on content-type are not adequate.
- getDefaultEncoding() - Method in class org.apache.commons.io.output.XmlStreamWriter
-
Returns the default encoding.
- getDelay() - Method in class org.apache.commons.io.input.Tailer
-
Return the delay in milliseconds.
- getDeleteFailures() - Method in class org.apache.commons.io.FileCleaningTracker
-
Return the file paths that failed to delete.
- getDepth() - Method in exception org.apache.commons.io.DirectoryWalker.CancelException
-
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.
- getEncoding() - Method in class org.apache.commons.io.input.XmlStreamReader
-
Returns the charset encoding of the XmlStreamReader.
- getEncoding() - Method in class org.apache.commons.io.output.XmlStreamWriter
-
Returns the detected encoding.
- getExtension(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Gets the extension of a fileName.
- getFile() - Method in exception org.apache.commons.io.DirectoryWalker.CancelException
-
Returns the file when the operation was cancelled.
- getFile() - Method in class org.apache.commons.io.input.Tailer
-
Return the file.
- getFile() - Method in class org.apache.commons.io.monitor.FileEntry
-
Return the file being monitored.
- getFile() - Method in class org.apache.commons.io.output.DeferredFileOutputStream
-
Returns 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
-
Construct a file from the set of name elements.
- getFile(String...) - Static method in class org.apache.commons.io.FileUtils
-
Construct 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
-
Returns this conditional file filter's list of file filters.
- getFileFilters() - Method in interface org.apache.commons.io.filefilter.ConditionalFileFilter
-
Returns this conditional file filter's list of file filters.
- getFileFilters() - Method in class org.apache.commons.io.filefilter.OrFileFilter
-
Returns 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.
- 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.
- getIllegalFileNameChars() - Method in enum org.apache.commons.io.FileSystem
-
Gets a cloned copy of the illegal characters for this file system.
- getIndex() - Method in exception org.apache.commons.io.IOIndexedException
-
The index of this exception.
- 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.monitor.FileEntry
-
Return the last modified time from the last time it was checked.
- getLength() - Method in class org.apache.commons.io.monitor.FileEntry
-
Return the length.
- getLevel() - Method in class org.apache.commons.io.monitor.FileEntry
-
Return 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
- getMaxFileNameLength() - Method in enum org.apache.commons.io.FileSystem
-
Gets the maximum length for file names.
- 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
-
Returns 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
-
Return the file name.
- getName(String) - Static method in class org.apache.commons.io.FilenameUtils
-
Gets the name minus the path from a full fileName.
- 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. - getOsMatchesName(String) - Static method in enum org.apache.commons.io.FileSystem
-
Decides if the operating system matches.
- getParent() - Method in class org.apache.commons.io.monitor.FileEntry
-
Return the parent entry.
- getPath() - Method in class org.apache.commons.io.FileCleaningTracker.Tracker
-
Return the path.
- 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.
- 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.
- 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.
- 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~/
. - getRandomAccessFile() - Method in class org.apache.commons.io.input.RandomAccessFileInputStream
-
Gets the underlying file.
- getReservedFileNames() - Method in enum org.apache.commons.io.FileSystem
-
Gets a cloned copy of the reserved file names.
- getRun() - Method in class org.apache.commons.io.input.Tailer
-
Gets whether to keep on running.
- getSize() - Method in class org.apache.commons.io.input.NullInputStream
-
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
-
Returns 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. - 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 org.apache.commons.io.TaggedIOException
-
Returns the serializable tag object.
- getTargetDirectory() - Method in class org.apache.commons.io.file.CopyDirectoryVisitor
-
Gets the target 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.
- getTrackCount() - Static method in class org.apache.commons.io.FileCleaner
-
Deprecated.
- getTrackCount() - Method in class org.apache.commons.io.FileCleaningTracker
-
Retrieve the number of files currently being tracked, and therefore awaiting deletion.
- getType(File) - Method in class org.apache.commons.io.comparator.DirectoryFileComparator
-
Convert type to numeric value.
- 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.
- getXmlEncoding() - Method in exception org.apache.commons.io.input.XmlStreamReaderException
-
Returns the encoding found in the XML prolog of the InputStream.
- getXmlGuessEncoding() - Method in exception 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
-
Returns the encoding declared in the , 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.
- handleCancelled(File, Collection<T>, DirectoryWalker.CancelException) - Method in class org.apache.commons.io.DirectoryWalker
-
Overridable callback method invoked when the operation is cancelled.
- handleDirectory(File, int, Collection<T>) - Method in class org.apache.commons.io.DirectoryWalker
-
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
-
Overridable callback method invoked at the end of processing each directory.
- handleDirectoryStart(File, int, Collection<T>) - Method in class org.apache.commons.io.DirectoryWalker
-
Overridable callback method invoked at the start of processing each directory.
- handleEnd(Collection<T>) - Method in class org.apache.commons.io.DirectoryWalker
-
Overridable callback method invoked at the end of processing.
- handleFile(File, int, Collection<T>) - Method in class org.apache.commons.io.DirectoryWalker
-
Overridable callback method invoked for each (non-directory) file.
- handleIOException(IOException) - Method in class org.apache.commons.io.input.ProxyInputStream
-
Handle any IOExceptions thrown.
- 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
-
Handle 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
-
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
-
Overridable callback method invoked for each restricted directory.
- handleStart(File, Collection<T>) - Method in class org.apache.commons.io.DirectoryWalker
-
Overridable callback method invoked at the start of processing.
- hasBOM() - Method in class org.apache.commons.io.input.BOMInputStream
-
Indicates whether the stream contains one of the specified BOMs.
- hasBOM(ByteOrderMark) - Method in class org.apache.commons.io.input.BOMInputStream
-
Indicates 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.
- hashCode() - Method in class org.apache.commons.io.ByteOrderMark
-
Return the hashcode for this BOM.
- hashCode() - Method in class org.apache.commons.io.file.AccumulatorPathVisitor
- hashCode() - Method in class org.apache.commons.io.file.CleaningPathVisitor
- hashCode() - Method in class org.apache.commons.io.file.CopyDirectoryVisitor
- hashCode() - Method in class org.apache.commons.io.file.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
- hasNext() - Method in class org.apache.commons.io.LineIterator
-
Indicates whether the
Reader
has more lines. - 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.
- 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
I
- identity() - Static method in interface org.apache.commons.io.function.IOFunction
-
Returns a
IOFunction
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.BoundedInputStream
-
the wrapped input stream
- in - Variable in class org.apache.commons.io.input.buffer.CircularBufferInputStream
- inbuf - Variable in class org.apache.commons.io.input.Tailer
-
Buffer on top of RandomAccessFile.
- 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
- index - Variable in exception org.apache.commons.io.IOIndexedException
- 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
-
Initialise the wrapped file writer.
- initWriter(File, Charset, boolean) - Method in class org.apache.commons.io.output.LockableFileWriter
-
Initialise the wrapped file writer.
- injectSlashN - Variable in class org.apache.commons.io.input.WindowsLineEndingInputStream
- innerListFiles(Collection<File>, File, IOFileFilter, boolean) - Static method in class org.apache.commons.io.FileUtils
-
Finds files within a given directory (and optionally its subdirectories).
- innerListFilesOrDirectories(File, IOFileFilter, IOFileFilter, boolean) - Static method in class org.apache.commons.io.FileUtils
-
Finds files within a given directory (and optionally its subdirectories).
- inputStream - Variable in class org.apache.commons.io.input.DemuxInputStream
- INSENSITIVE - org.apache.commons.io.IOCase
-
The constant for case insensitive regardless of operating system.
- 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.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.output.NullAppendable
-
A singleton.
- interval - 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. - 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.
- IOConsumer<T> - Interface in org.apache.commons.io.function
-
Like
Consumer
but throwsIOException
. - IOExceptionList - Exception in org.apache.commons.io
-
A IOException based on a list of Throwable causes.
- IOExceptionList(List<? extends Throwable>) - Constructor for exception org.apache.commons.io.IOExceptionList
-
Creates a new exception caused by a list of exceptions.
- IOExceptionWithCause - Exception in org.apache.commons.io
-
Deprecated.(since 2.5) use
IOException
instead - IOExceptionWithCause(String, Throwable) - Constructor for exception org.apache.commons.io.IOExceptionWithCause
-
Deprecated.Constructs a new instance with the given message and cause.
- IOExceptionWithCause(Throwable) - Constructor for exception org.apache.commons.io.IOExceptionWithCause
-
Deprecated.Constructs a new instance with the given cause.
- IOFileFilter - Interface in org.apache.commons.io.filefilter
-
An interface which brings the FileFilter and FilenameFilter interfaces together.
- IOFunction<T,R> - Interface in org.apache.commons.io.function
-
Like
Function
but throwsIOException
. - IOIndexedException - Exception in org.apache.commons.io
-
A IOException associated with a source index.
- IOIndexedException(int, Throwable) - Constructor for exception org.apache.commons.io.IOIndexedException
-
Creates a new exception.
- IOSupplier<T> - Interface in org.apache.commons.io.function
-
Like
Supplier
but throwsIOException
. - IOUtils - Class in org.apache.commons.io
-
General IO stream manipulation utilities.
- IOUtils() - Constructor for class org.apache.commons.io.IOUtils
-
Instances should NOT be constructed in standard programming.
- 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
-
Indicates if the MIME type belongs to the APPLICATION XML family.
- isCasePreserving() - Method in enum org.apache.commons.io.FileSystem
-
Whether this file system preserves case.
- isCaseSensitive() - Method in enum org.apache.commons.io.FileSystem
-
Whether this file system is case-sensitive.
- isCaseSensitive() - Method in enum org.apache.commons.io.IOCase
-
Does the object represent case sensitive comparison.
- 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.
- 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
-
Indicate whether the file is a directory or not.
- isEmpty(Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Returns whether the given file or directory is empty.
- isEmptyDirectory(Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Returns whether the directory is empty.
- isEmptyFile(Path) - Static method in class org.apache.commons.io.file.PathUtils
-
Returns whether the given file is empty.
- isExists() - Method in class org.apache.commons.io.monitor.FileEntry
-
Indicate 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
-
Tests if the specified
File
is newer than the referenceFile
. - isFileNewer(File, ChronoLocalDate) - Static method in class org.apache.commons.io.FileUtils
-
Tests if the specified
File
is newer than the specifiedChronoLocalDate
at the current time. - 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, 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
-
Tests if the specified
File
is newer than the specifiedInstant
. - isFileNewer(File, Date) - Static method in class org.apache.commons.io.FileUtils
-
Tests if the specified
File
is newer than the specifiedDate
. - 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
-
Tests if the specified
File
is older than the referenceFile
. - isFileOlder(File, ChronoLocalDate) - Static method in class org.apache.commons.io.FileUtils
-
Tests if the specified
File
is older than the specifiedChronoLocalDate
at the current time. - isFileOlder(File, ChronoLocalDate, LocalTime) - Static method in class org.apache.commons.io.FileUtils
-
Tests if the specified
File
is older than the specifiedChronoLocalDate
at the specifiedLocalTime
. - 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
-
Tests if the specified
File
is older than the specifiedInstant
. - isFileOlder(File, Date) - Static method in class org.apache.commons.io.FileUtils
-
Tests if the specified
File
is older than the specifiedDate
. - isIllegalFileNameChar(char) - Method in enum org.apache.commons.io.FileSystem
-
Returns
true
if the given character is illegal in a file name,false
otherwise. - isInMemory() - Method in class org.apache.commons.io.output.DeferredFileOutputStream
-
Determines 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
-
Checks if a candidate file name (without a path) such as
"filename.ext"
or"filename"
is a potentially legal file name. - ISO_8859_1 - Static variable in class org.apache.commons.io.Charsets
-
Deprecated.Use Java 7's
StandardCharsets
- isOsNameMatch(String, String) - Static method in enum org.apache.commons.io.FileSystem
-
Decides if the operating system matches.
- isPropagateClose() - Method in class org.apache.commons.io.input.BoundedInputStream
-
Indicates whether the
BoundedInputStream.close()
method should propagate to the underlingInputStream
. - isReservedFileName(CharSequence) - Method in enum org.apache.commons.io.FileSystem
-
Returns 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.
- isSeparator(char) - Static method in class org.apache.commons.io.FilenameUtils
-
Checks if the character is a separator.
- isSymlink(File) - Static method in class org.apache.commons.io.FileUtils
-
Determines 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 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
-
Indicates 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.
- 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.
- iterateFiles(File, String[], boolean) - Static method in class org.apache.commons.io.FileUtils
-
Allows iteration 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
-
Allows iteration over the files in given directory (and optionally its subdirectories).
- iterateFilesAndDirs(File, IOFileFilter, IOFileFilter) - Static method in class org.apache.commons.io.FileUtils
-
Allows iteration over the files in given directory (and optionally its subdirectories).
L
- lastCoderResult - Variable in class org.apache.commons.io.input.ReaderInputStream
- lastModified - Variable in class org.apache.commons.io.monitor.FileEntry
- 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
File.lastModified()
). - LastModifiedFileComparator() - Constructor for class org.apache.commons.io.comparator.LastModifiedFileComparator
- 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.monitor.FileEntry
- length() - Method in class org.apache.commons.io.ByteOrderMark
-
Return 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.
- LINE_SEPARATOR - Static variable in class org.apache.commons.io.IOUtils
-
Deprecated.Use
System.lineSeparator()
. - LINE_SEPARATOR_UNIX - Static variable in class org.apache.commons.io.IOUtils
-
The Unix line separator string.
- LINE_SEPARATOR_WINDOWS - Static variable in class org.apache.commons.io.IOUtils
-
The Windows line separator string.
- lineIterator(File) - Static method in class org.apache.commons.io.FileUtils
-
Returns an Iterator for the lines in a
File
using the default encoding for the VM. - lineIterator(File, String) - Static method in class org.apache.commons.io.FileUtils
-
Returns an Iterator for the lines in a
File
. - lineIterator(InputStream, String) - Static method in class org.apache.commons.io.IOUtils
-
Returns an Iterator for the lines in an
InputStream
, using the character encoding specified (or default encoding if null). - lineIterator(InputStream, Charset) - Static method in class org.apache.commons.io.IOUtils
-
Returns an Iterator for the lines in an
InputStream
, using the character encoding specified (or default encoding if null). - lineIterator(Reader) - Static method in class org.apache.commons.io.IOUtils
-
Returns an Iterator for the lines in a
Reader
. - LineIterator - Class in org.apache.commons.io
-
An Iterator over the lines in a
Reader
. - LineIterator(Reader) - Constructor for class org.apache.commons.io.LineIterator
-
Constructs an iterator of the lines for a
Reader
. - LINUX - org.apache.commons.io.FileSystem
-
Linux file system.
- 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, 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
-
Constructs a LockableFileWriter.
- LockableFileWriter(File, boolean) - Constructor for class org.apache.commons.io.output.LockableFileWriter
-
Constructs a LockableFileWriter.
- 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
-
Constructs a LockableFileWriter with a file encoding.
- LockableFileWriter(File, String, boolean, String) - Constructor for class org.apache.commons.io.output.LockableFileWriter
-
Constructs a LockableFileWriter with a file encoding.
- LockableFileWriter(File, Charset) - Constructor for class org.apache.commons.io.output.LockableFileWriter
-
Constructs a LockableFileWriter with a file encoding.
- LockableFileWriter(File, Charset, boolean, String) - Constructor for class org.apache.commons.io.output.LockableFileWriter
-
Constructs a LockableFileWriter with a file encoding.
- LockableFileWriter(String) - Constructor for class org.apache.commons.io.output.LockableFileWriter
-
Constructs a LockableFileWriter.
- LockableFileWriter(String, boolean) - Constructor for class org.apache.commons.io.output.LockableFileWriter
-
Constructs a LockableFileWriter.
- LockableFileWriter(String, boolean, String) - Constructor for class org.apache.commons.io.output.LockableFileWriter
-
Constructs a LockableFileWriter.
- 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 - 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.
- 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(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.UnixLineEndingInputStream
- mark(int) - Method in class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream
- mark(int) - Method in class org.apache.commons.io.input.WindowsLineEndingInputStream
- mark_bbuf - Variable in class org.apache.commons.io.input.CharSequenceInputStream
- mark_cbuf - Variable in class org.apache.commons.io.input.CharSequenceInputStream
- 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
- 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.UnsynchronizedByteArrayInputStream
- 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
-
Check if the bytes match a BOM.
- max - Variable in class org.apache.commons.io.input.BoundedInputStream
-
the max length to provide
- MAX_UNSIGNED_SHORT - Static variable in class org.apache.commons.io.FilenameUtils
- maxCharsFromTargetReader - Variable in class org.apache.commons.io.input.BoundedReader
- maxFileNameLength - Variable in enum org.apache.commons.io.FileSystem
- maxPathLength - Variable in enum org.apache.commons.io.FileSystem
- 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
- 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
-
Creates a new instance, which calculates a signature on the given stream, using a
MessageDigest
with the "MD5" algorithm. - MessageDigestCalculatingInputStream(InputStream, String) - Constructor for class org.apache.commons.io.input.MessageDigestCalculatingInputStream
-
Creates a new instance, which calculates a signature on the given stream, using a
MessageDigest
with the given algorithm. - MessageDigestCalculatingInputStream(InputStream, MessageDigest) - Constructor for class org.apache.commons.io.input.MessageDigestCalculatingInputStream
-
Creates a new instance, which calculates a signature on the given stream, using the given
MessageDigest
. - 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.
- 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.
- 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 the 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
-
Construct a case sensitive file name comparator instance.
- NameFileComparator(IOCase) - Constructor for class org.apache.commons.io.comparator.NameFileComparator
-
Construct 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
-
Construct 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
- 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.
- newChildInstance(File) - Method in class org.apache.commons.io.monitor.FileEntry
-
Create a new child instance.
- newLineSequences - Variable in class org.apache.commons.io.input.ReversedLinesFileReader
- next() - Method in class org.apache.commons.io.LineIterator
-
Returns the next line in the wrapped
Reader
. - 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_COMPARATORS - Static variable in class org.apache.commons.io.comparator.CompositeFileComparator
- NO_MARK - Static variable in class org.apache.commons.io.input.CharSequenceInputStream
- 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.
- 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()
. - 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.
- NULL_OUTPUT_STREAM - Static variable in class org.apache.commons.io.output.NullOutputStream
-
A singleton.
- NULL_PRINT_STREAM - Static variable in class org.apache.commons.io.output.NullPrintStream
-
The singleton instance.
- NULL_WRITER - Static variable in class org.apache.commons.io.output.NullWriter
-
A singleton.
- 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.
- 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
-
Writes all data to the famous /dev/null.
- NullOutputStream() - Constructor for class org.apache.commons.io.output.NullOutputStream
-
Deprecated.
- NullPrintStream - Class in org.apache.commons.io.output
-
Writes all data to the famous /dev/null.
- NullPrintStream() - Constructor for class org.apache.commons.io.output.NullPrintStream
-
Constructs an instance.
- 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
-
Writes all data to the famous /dev/null.
- NullWriter() - Constructor for class org.apache.commons.io.output.NullWriter
-
Constructs a new NullWriter.
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.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
- offset - Variable in class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream
-
Current offset in the data buffer.
- 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.
- onStart(FileAlterationObserver) - Method in interface org.apache.commons.io.monitor.FileAlterationListener
-
File system observer started checking event.
- onStart(FileAlterationObserver) - Method in class org.apache.commons.io.monitor.FileAlterationListenerAdaptor
-
File system observer started checking event.
- onStop(FileAlterationObserver) - Method in interface org.apache.commons.io.monitor.FileAlterationListener
-
File system observer finished checking event.
- onStop(FileAlterationObserver) - Method in class org.apache.commons.io.monitor.FileAlterationListenerAdaptor
-
File system observer finished checking event.
- openInputStream(File) - Static method in class org.apache.commons.io.FileUtils
-
Opens a
FileInputStream
for the specified file, providing better error messages than simply callingnew FileInputStream(file)
. - openOutputStream(File) - Static method in class org.apache.commons.io.FileUtils
-
Opens a
FileOutputStream
for the specified file, checking and creating the parent directory if it does not exist. - openOutputStream(File, boolean) - Static method in class org.apache.commons.io.FileUtils
-
Opens a
FileOutputStream
for the specified file, checking and creating the parent directory if it does not exist. - openProcess(String[]) - Method in class org.apache.commons.io.FileSystemUtils
-
Deprecated.Opens the process to the operating system.
- or(IOFileFilter...) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Returns a filter that ORs the specified filters.
- orFileFilter(IOFileFilter, IOFileFilter) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Deprecated.
- OrFileFilter - Class in org.apache.commons.io.filefilter
-
A
FileFilter
providing conditional OR logic across a list of file filters. - OrFileFilter() - Constructor for class org.apache.commons.io.filefilter.OrFileFilter
-
Constructs a new instance of
OrFileFilter
. - OrFileFilter(List<IOFileFilter>) - Constructor for class org.apache.commons.io.filefilter.OrFileFilter
-
Constructs a new instance of
OrFileFilter
with the specified filters. - OrFileFilter(IOFileFilter, IOFileFilter) - Constructor for class org.apache.commons.io.filefilter.OrFileFilter
-
Constructs a new file filter that ORs the result of two other filters.
- org.apache.commons.io - package org.apache.commons.io
-
This package defines utility classes for working with streams, readers, writers and files.
- org.apache.commons.io.comparator - package org.apache.commons.io.comparator
-
This package provides various
Comparator
implementations forFile
s. - org.apache.commons.io.file - package org.apache.commons.io.file
-
This package provides extensions in the realm of java.nio.file.
- org.apache.commons.io.filefilter - package org.apache.commons.io.filefilter
-
This package defines an interface (IOFileFilter) that combines both
FileFilter
andFilenameFilter
. - org.apache.commons.io.function - package org.apache.commons.io.function
-
This package defines IO-only related functional interfaces for lambda expressions and method references.
- org.apache.commons.io.input - package org.apache.commons.io.input
-
This package provides implementations of input classes, such as
InputStream
andReader
. - org.apache.commons.io.input.buffer - package org.apache.commons.io.input.buffer
-
This package provides implementations of buffered input classes, such as
CircularBufferInputStream
andPeekableInputStream
. - org.apache.commons.io.monitor - package org.apache.commons.io.monitor
-
This package 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
-
This package provides implementations of output classes, such as
OutputStream
andWriter
. - org.apache.commons.io.serialization - package org.apache.commons.io.serialization
-
This package provides a framework for controlling the deserialization of classes.
- 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.FileWriterWithEncoding
-
The writer to decorate.
- 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
-
The file to which output will be directed if the threshold is exceeded.
- outputStreamThreadLocal - Variable in class org.apache.commons.io.output.DemuxOutputStream
- OVERRIDE_READ_ONLY - org.apache.commons.io.file.StandardDeleteOption
-
Overrides the read-only attribute to allow deletion.
- 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
- 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_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
- 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
-
Construct a case sensitive file path comparator instance.
- PathFileComparator(IOCase) - Constructor for class org.apache.commons.io.comparator.PathFileComparator
-
Construct a file path comparator instance with the specified case-sensitivity.
- 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.
- 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
. - PeekableInputStream - Class in org.apache.commons.io.input.buffer
-
Implementation of 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 (8192).
- 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, long) - Method in class org.apache.commons.io.FileSystemUtils
-
Deprecated.Performs the os command.
- pos - Variable in class org.apache.commons.io.input.BoundedInputStream
-
the number of bytes already returned
- 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
- 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.DeletingPathVisitor
- 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
-
Process a HTTP stream.
- processInput(boolean) - Method in class org.apache.commons.io.output.WriterOutputStream
-
Decode the contents of the input ByteBuffer into a CharBuffer.
- propagateClose - Variable in class org.apache.commons.io.input.BoundedInputStream
-
flag if close should be propagated
- 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
Tracker
instances being watched.
R
- RAF_MODE - Static variable in class org.apache.commons.io.input.Tailer
- randomAccessFile - Variable in class org.apache.commons.io.input.RandomAccessFileInputStream
- 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
-
Constructs a new instance configured to leave the underlying file open when this stream is closed.
- RandomAccessFileInputStream(RandomAccessFile, boolean) - Constructor for class org.apache.commons.io.input.RandomAccessFileInputStream
-
Constructs a new instance.
- 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.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.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.RandomAccessFileInputStream
- read() - Method in class org.apache.commons.io.input.ReaderInputStream
-
Read 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.UnixLineEndingInputStream
- read() - Method in class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream
- 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.buffer.CircularBufferInputStream
- 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
-
Read the specified number of bytes into an array.
- 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.UnsynchronizedByteArrayInputStream
- 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.CharSequenceInputStream
- 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.ReaderInputStream
-
Read 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.UnsynchronizedByteArrayInputStream
- 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[], 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.XmlStreamReader
-
Invokes 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(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_ONLY - Static variable in class org.apache.commons.io.filefilter.CanReadFileFilter
-
Singleton instance of read-only filter
- readAheadLimit - Variable in class org.apache.commons.io.input.BoundedReader
- 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()
. - readDouble() - Method in class org.apache.commons.io.input.SwappedDataInputStream
-
Delegates to
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.2.5 use
ReaderInputStream(Reader, Charset)
instead - ReaderInputStream(Reader, String) - Constructor for class org.apache.commons.io.input.ReaderInputStream
-
Construct a new
ReaderInputStream
with a default input buffer size of 1024 characters. - ReaderInputStream(Reader, String, int) - Constructor for class org.apache.commons.io.input.ReaderInputStream
-
Construct a new
ReaderInputStream
. - ReaderInputStream(Reader, Charset) - Constructor for class org.apache.commons.io.input.ReaderInputStream
-
Construct a new
ReaderInputStream
with a default input buffer size of 1024 characters. - ReaderInputStream(Reader, CharsetEncoder) - Constructor for class org.apache.commons.io.input.ReaderInputStream
-
Construct a new
ReaderInputStream
. - ReaderInputStream(Reader, CharsetEncoder, int) - Constructor for class org.apache.commons.io.input.ReaderInputStream
-
Construct a new
ReaderInputStream
. - ReaderInputStream(Reader, Charset, int) - Constructor for class org.apache.commons.io.input.ReaderInputStream
-
Construct a new
ReaderInputStream
. - readers - Variable in class org.apache.commons.io.input.SequenceReader
- 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
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.
- readInt() - Method in class org.apache.commons.io.input.SwappedDataInputStream
-
Delegates to
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
. - 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(RandomAccessFile) - Method in class org.apache.commons.io.input.Tailer
-
Read new lines.
- 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. - readLong() - Method in class org.apache.commons.io.input.SwappedDataInputStream
-
Delegates to
readSwappedLong(InputStream)
. - 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
readSwappedShort(InputStream)
. - 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 a "int" value from a byte array at a given offset.
- readSwappedInteger(InputStream) - Static method in class org.apache.commons.io.EndianUtils
-
Reads a "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 a 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 a unsigned short (16-bit) from an InputStream.
- 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
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. - 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
-
Construct a new Reaper
- refresh(File) - Method in class org.apache.commons.io.monitor.FileEntry
-
Refresh 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
-
Construct a new regular expression filter.
- RegexFileFilter(String, int) - Constructor for class org.apache.commons.io.filefilter.RegexFileFilter
-
Construct a new regular expression filter with the specified flags.
- RegexFileFilter(String, IOCase) - Constructor for class org.apache.commons.io.filefilter.RegexFileFilter
-
Construct a new regular expression filter with the specified flags case sensitivity.
- RegexFileFilter(Pattern) - Constructor for class org.apache.commons.io.filefilter.RegexFileFilter
-
Construct 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 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
-
Whether to close and reopen the file whilst waiting for more input.
- repeatedContent - Variable in class org.apache.commons.io.input.CircularInputStream
- 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.
- reservedFileNames - Variable in enum org.apache.commons.io.FileSystem
- 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.UnsynchronizedByteArrayInputStream
- 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
-
Set 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
-
Set 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.
- resourceToByteArray(String) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents of a classpath resource as a byte array.
- resourceToByteArray(String, ClassLoader) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents of a classpath resource as a byte array.
- resourceToString(String, Charset) - Static method in class org.apache.commons.io.IOUtils
-
Gets the contents of a classpath 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 classpath 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 classpath resource.
- resourceToURL(String, ClassLoader) - Static method in class org.apache.commons.io.IOUtils
-
Gets a URL pointing to the given classpath resource.
- 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.2.5 use
ReversedLinesFileReader(File, Charset)
instead - ReversedLinesFileReader(File, int, String) - Constructor for class org.apache.commons.io.input.ReversedLinesFileReader
-
Creates a ReversedLinesFileReader with the given block size and encoding.
- ReversedLinesFileReader(File, int, Charset) - Constructor for class org.apache.commons.io.input.ReversedLinesFileReader
-
Creates a ReversedLinesFileReader with the given block size and encoding.
- ReversedLinesFileReader(File, Charset) - Constructor for class org.apache.commons.io.input.ReversedLinesFileReader
-
Creates a ReversedLinesFileReader with default block size of 4KB and the specified encoding.
- ReversedLinesFileReader(Path, int, String) - Constructor for class org.apache.commons.io.input.ReversedLinesFileReader
-
Creates a ReversedLinesFileReader with the given block size and encoding.
- ReversedLinesFileReader(Path, int, Charset) - Constructor for class org.apache.commons.io.input.ReversedLinesFileReader
-
Creates a ReversedLinesFileReader with the given block size and encoding.
- ReversedLinesFileReader(Path, Charset) - Constructor for class org.apache.commons.io.input.ReversedLinesFileReader
-
Creates a ReversedLinesFileReader with default block size of 4KB and the specified encoding.
- 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
-
Construct 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
-
Run the reaper thread that will delete files as their associated marker objects are reclaimed by the garbage collector.
- run() - Method in class org.apache.commons.io.input.Tailer
-
Follows changes in the file, calling the TailerListener's handle method for 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
-
Sleep until the specified timeout amount and then interrupt the thread being monitored.
- running - Variable in class org.apache.commons.io.monitor.FileAlterationMonitor
S
- seek(long) - Method in class org.apache.commons.io.input.RandomAccessFileInputStream
-
Delegates to the underlying file.
- sensitive - Variable in enum org.apache.commons.io.IOCase
-
The sensitivity flag.
- SENSITIVE - 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 Readers in sequence.
- SequenceReader(Reader...) - Constructor for class org.apache.commons.io.input.SequenceReader
-
Construct a new instance with readers
- SequenceReader(Iterable<? extends Reader>) - Constructor for class org.apache.commons.io.input.SequenceReader
-
Construct a new instance with readers
- 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 org.apache.commons.io.DirectoryWalker.CancelException
-
Serialization id.
- serialVersionUID - Static variable in exception 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.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 org.apache.commons.io.input.XmlStreamReaderException
- serialVersionUID - Static variable in enum org.apache.commons.io.IOCase
-
Serialization version.
- serialVersionUID - Static variable in exception org.apache.commons.io.IOExceptionList
- serialVersionUID - Static variable in exception org.apache.commons.io.IOExceptionWithCause
-
Deprecated.Defines the serial version UID.
- serialVersionUID - Static variable in exception 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.output.StringBuilderWriter
- serialVersionUID - Static variable in exception org.apache.commons.io.TaggedIOException
-
Generated serial version UID.
- setByteCount(long) - Method in class org.apache.commons.io.output.ThresholdingOutputStream
-
Sets the byteCount to count.
- setChildren(FileEntry...) - Method in class org.apache.commons.io.monitor.FileEntry
-
Set the directory's files.
- setDirectory(boolean) - Method in class org.apache.commons.io.monitor.FileEntry
-
Set whether the file is a directory or not.
- setExists(boolean) - Method in class org.apache.commons.io.monitor.FileEntry
-
Set whether the file existed the last time it was checked.
- 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.
- setLastModified(long) - Method in class org.apache.commons.io.monitor.FileEntry
-
Return the last modified time from the last time it was checked.
- setLastModified(File, File) - Static method in class org.apache.commons.io.FileUtils
-
Sets the given
targetFile
's last modified date to the value fromsourceFile
. - setLength(long) - Method in class org.apache.commons.io.monitor.FileEntry
-
Set the length.
- setName(String) - Method in class org.apache.commons.io.monitor.FileEntry
-
Set the file name.
- setPropagateClose(boolean) - Method in class org.apache.commons.io.input.BoundedInputStream
-
Set whether the
BoundedInputStream.close()
method should propagate to the underlingInputStream
. - setReadOnly(Path, boolean, LinkOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Sets the given Path to the
readOnly
value. - setThreadFactory(ThreadFactory) - Method in class org.apache.commons.io.monitor.FileAlterationMonitor
-
Sets the thread factory.
- setUpEffectiveDirFilter(IOFileFilter) - Static method in class org.apache.commons.io.FileUtils
-
Returns a filter that accepts directories in addition to the
File
objects accepted by the given filter. - setUpEffectiveFileFilter(IOFileFilter) - Static method in class org.apache.commons.io.FileUtils
-
Returns a filter that accepts files in addition to the
File
objects accepted by the given filter. - 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.
- 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.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_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
-
Construct a file size comparator instance (directories treated as zero size).
- SizeFileComparator(boolean) - Constructor for class org.apache.commons.io.comparator.SizeFileComparator
-
Construct 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.
- sizeOf0(File) - Static method in class org.apache.commons.io.FileUtils
-
the size of a file
- sizeOfAsBigInteger(File) - Static method in class org.apache.commons.io.FileUtils
-
Returns the size of the specified file or directory.
- sizeOfBig0(File) - Static method in class org.apache.commons.io.FileUtils
-
Returns the size of a file
- 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).
- sizeOfDirectory0(File) - Static method in class org.apache.commons.io.FileUtils
-
the size of a director
- 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).
- sizeOfDirectoryBig0(File) - Static method in class org.apache.commons.io.FileUtils
-
Finds the size of a directory
- 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.CharacterFilterReader
- 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.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.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.UnsynchronizedByteArrayInputStream
- 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_BYTE_BUFFER - Static variable in class org.apache.commons.io.IOUtils
-
The default buffer to use for the skip() methods.
- SKIP_CHAR_BUFFER - Static variable in class org.apache.commons.io.IOUtils
- skipBytes(int) - Method in class org.apache.commons.io.input.SwappedDataInputStream
-
Invokes the delegate's
skip(int)
method. - 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.
- skipSet - Variable in class org.apache.commons.io.input.CharacterSetFilterReader
- slashNSeen - Variable in class org.apache.commons.io.input.UnixLineEndingInputStream
- slashNSeen - Variable in class org.apache.commons.io.input.WindowsLineEndingInputStream
- slashRSeen - Variable in class org.apache.commons.io.input.UnixLineEndingInputStream
- slashRSeen - Variable in class org.apache.commons.io.input.WindowsLineEndingInputStream
- sleep(long) - Static method in class org.apache.commons.io.ThreadMonitor
-
Sleep for a guaranteed minimum number of milliseconds unless interrupted.
- sort(File...) - Method in class org.apache.commons.io.comparator.AbstractFileComparator
-
Sort an array of files.
- sort(List<File>) - Method in class org.apache.commons.io.comparator.AbstractFileComparator
-
Sort a List of files.
- sourceDirectory - Variable in class org.apache.commons.io.file.CopyDirectoryVisitor
- 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
- 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(long) - Static method in class org.apache.commons.io.ThreadMonitor
-
Start monitoring the current thread.
- start(Thread, long) - Static method in class org.apache.commons.io.ThreadMonitor
-
Start monitoring the specified thread.
- startOffset - Variable in class org.apache.commons.io.input.buffer.CircularByteBuffer
- stop() - Method in class org.apache.commons.io.input.Tailer
-
Allows the tailer to complete its current loop and return.
- 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
-
Stop monitoring the specified thread.
- 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
-
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.
- svnFilter - Static variable in class org.apache.commons.io.filefilter.FileFilterUtils
- 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 a "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.
- SYSTEM - org.apache.commons.io.IOCase
-
The constant for case sensitivity determined by the current operating system.
- SYSTEM_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 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 in org.apache.commons.io
-
An
IOException
decorator that adds a serializable tag to the wrapped exception. - TaggedIOException(IOException, Serializable) - Constructor for exception 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.
- 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
-
Creates a Tailer for the given file, with a specified buffer size.
- Tailer(File, TailerListener) - Constructor for class org.apache.commons.io.input.Tailer
-
Creates a Tailer for the given file, starting from the beginning, with the default delay of 1.0s.
- Tailer(File, TailerListener, long) - Constructor for class org.apache.commons.io.input.Tailer
-
Creates a Tailer for the given file, starting from the beginning.
- Tailer(File, TailerListener, long, boolean) - Constructor for class org.apache.commons.io.input.Tailer
-
Creates a Tailer for the given file, with a delay other than the default 1.0s.
- Tailer(File, TailerListener, long, boolean, boolean) - Constructor for class org.apache.commons.io.input.Tailer
-
Creates a Tailer for the given file, with a delay other than the default 1.0s.
- Tailer(File, TailerListener, long, 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(File, TailerListener, long, boolean, int) - Constructor for class org.apache.commons.io.input.Tailer
-
Creates a Tailer for the given file, with a specified buffer size.
- 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
- target - Variable in class org.apache.commons.io.input.UnixLineEndingInputStream
- target - Variable in class org.apache.commons.io.input.WindowsLineEndingInputStream
- 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
-
Creates a TeeReader that proxies the given
Reader
and copies all read characters to the givenWriter
. - TeeReader(Reader, Writer, boolean) - Constructor for class org.apache.commons.io.input.TeeReader
-
Creates a TeeReader that proxies the given
Reader
and copies all read characters to the givenWriter
. - 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.
- testLockDir(File) - Method in class org.apache.commons.io.output.LockableFileWriter
-
Tests that we can write to the lock directory.
- theInstance - Static variable in class org.apache.commons.io.FileCleaner
-
Deprecated.The instance to use for the deprecated, static methods.
- 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, long) - Constructor for class org.apache.commons.io.ThreadMonitor
-
Construct and new monitor.
- threshold - Variable in class org.apache.commons.io.output.ThresholdingOutputStream
-
The threshold at which the event will be triggered.
- 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.
- 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 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.ThreadMonitor
- 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[]
. - 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(Charset) - Static method in class org.apache.commons.io.Charsets
-
Returns the given Charset or the default Charset if the given Charset is null.
- toFile(URL) - Static method in class org.apache.commons.io.FileUtils
-
Convert from a
URL
to aFile
. - toFiles(URL...) - Static method in class org.apache.commons.io.FileUtils
-
Converts each of an array of
URL
to aFile
. - toFileVisitOptionSet(FileVisitOption...) - Static method in class org.apache.commons.io.file.PathUtils
-
Converts an array of
FileVisitOption
to aSet
. - toInputStream() - Method in class org.apache.commons.io.output.AbstractByteArrayOutputStream
-
Gets the current contents of this byte stream as a Input Stream.
- toInputStream() - Method in class org.apache.commons.io.output.ByteArrayOutputStream
- 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 a Input Stream.
- 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(IOFileFilter...) - Static method in class org.apache.commons.io.filefilter.FileFilterUtils
-
Create a List of file filters.
- toMessage(int, Throwable) - Static method in exception org.apache.commons.io.IOIndexedException
-
Converts input to a suitable String for exception message.
- toString() - Method in class org.apache.commons.io.ByteOrderMark
-
Provide a String representation of the BOM.
- 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.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
-
Provide 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.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.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.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 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.output.AbstractByteArrayOutputStream
-
Deprecated.2.5 use
AbstractByteArrayOutputStream.toString(String)
instead - toString() - Method in class org.apache.commons.io.output.StringBuilderWriter
-
Returns
StringBuilder.toString()
. - 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.
- toSuffixes(String...) - Static method in class org.apache.commons.io.FileUtils
-
Converts an array of file extensions to suffixes for use with IOFileFilters.
- 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 the same behavior as the "touch" utility on Unix.
- toURLs(File...) - Static method in class org.apache.commons.io.FileUtils
-
Converts each of an array of
File
to aURL
. - 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
-
Track 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
-
Track 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
-
Track 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
Tracker
instances in existence. - trailingNewlineOfFileSkipped - Variable in class org.apache.commons.io.input.ReversedLinesFileReader
- 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.
- 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
- UNIX - Static variable in class org.apache.commons.io.FileSystemUtils
-
Deprecated.Operating system state flag for Unix.
- UNIX_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
-
Create an input stream that filters another stream
- 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
-
Creates a new byte array input stream.
- UnsynchronizedByteArrayInputStream(byte[], int) - Constructor for class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream
-
Creates a new byte array input stream.
- UnsynchronizedByteArrayInputStream(byte[], int, int) - Constructor for class org.apache.commons.io.input.UnsynchronizedByteArrayInputStream
-
Creates a new byte array input stream.
- 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
-
Creates a new byte array output stream.
- UnsynchronizedByteArrayOutputStream(int) - Constructor for class org.apache.commons.io.output.UnsynchronizedByteArrayOutputStream
-
Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.
- updateFileCounters(Path, BasicFileAttributes) - Method in class org.apache.commons.io.file.CountingPathVisitor
-
Updates the counters for visiting the given file.
- 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
- 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.
- validateListFilesParameters(File, IOFileFilter) - Static method in class org.apache.commons.io.FileUtils
-
Validates the given arguments.
- 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
- 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.
- 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.
- verifiedListFiles(File) - Static method in class org.apache.commons.io.FileUtils
-
Lists files in a directory, asserting that the supplied directory satisfies exists and is a directory.
- 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.AccumulatorPathVisitor
- 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
- 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 NFS to propagate a file creation, imposing a timeout.
- walk(File, int, Collection<T>) - Method in class org.apache.commons.io.DirectoryWalker
-
Main recursive method to examine the directory hierarchy.
- walk(File, Collection<T>) - Method in class org.apache.commons.io.DirectoryWalker
-
Internal method that walks the directory hierarchy in a depth-first manner.
- 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
-
Construct a new case-sensitive wildcard filter for a single wildcard.
- WildcardFileFilter(String...) - Constructor for class org.apache.commons.io.filefilter.WildcardFileFilter
-
Construct a new case-sensitive wildcard filter for an array of wildcards.
- WildcardFileFilter(String[], IOCase) - Constructor for class org.apache.commons.io.filefilter.WildcardFileFilter
-
Construct a new wildcard filter for an array of wildcards specifying case-sensitivity.
- WildcardFileFilter(String, IOCase) - Constructor for class org.apache.commons.io.filefilter.WildcardFileFilter
-
Construct a new wildcard filter for a single wildcard specifying case-sensitivity.
- WildcardFileFilter(List<String>) - Constructor for class org.apache.commons.io.filefilter.WildcardFileFilter
-
Construct a new case-sensitive wildcard filter for a list of wildcards.
- WildcardFileFilter(List<String>, IOCase) - Constructor for class org.apache.commons.io.filefilter.WildcardFileFilter
-
Construct a new wildcard filter for a list of wildcards specifying case-sensitivity.
- 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.Construct a new case-sensitive wildcard filter for a single wildcard.
- WildcardFilter(String...) - Constructor for class org.apache.commons.io.filefilter.WildcardFilter
-
Deprecated.Construct a new case-sensitive wildcard filter for an array of wildcards.
- WildcardFilter(List<String>) - Constructor for class org.apache.commons.io.filefilter.WildcardFilter
-
Deprecated.Construct 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
-
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 - 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_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
-
Create 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
. - 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
. - 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
-
Write 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.WriterOutputStream
-
Write bytes from the specified byte array to the stream.
- write(byte[], int, int) - Method in class org.apache.commons.io.output.AbstractByteArrayOutputStream
-
Writes the bytes to the byte array.
- 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
-
Write 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.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.FileWriterWithEncoding
-
Write the characters from an array.
- write(char[]) - Method in class org.apache.commons.io.output.FilterCollectionWriter
- write(char[]) - Method in class org.apache.commons.io.output.LockableFileWriter
-
Write 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[], 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.FileWriterWithEncoding
-
Write the specified characters from an array.
- 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
-
Write 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.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 a byte to byte array.
- 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.FileWriterWithEncoding
-
Write a character.
- 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
-
Write 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.TeeOutputStream
-
Write 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.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.FileWriterWithEncoding
-
Write the characters from a string.
- write(String) - Method in class org.apache.commons.io.output.FilterCollectionWriter
- write(String) - Method in class org.apache.commons.io.output.LockableFileWriter
-
Write 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(StringBuffer, OutputStream) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.replaced by write(CharSequence, OutputStream)
- write(StringBuffer, OutputStream, String) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.replaced by write(CharSequence, OutputStream, String)
- write(StringBuffer, Writer) - Static method in class org.apache.commons.io.IOUtils
-
Deprecated.replaced by write(CharSequence, Writer)
- 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.FileWriterWithEncoding
-
Write the specified characters from a string.
- 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
-
Write 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, 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
-
Writes chars from a
String
to aWriter
. - 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
- 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
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
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
toString()
value of each item in a collection to aWriter
line by line, using the specified line ending. - 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. - 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.2.5 use
WriterOutputStream(Writer, Charset)
instead - WriterOutputStream(Writer, String) - Constructor for class org.apache.commons.io.output.WriterOutputStream
-
Constructs a new
WriterOutputStream
with a default output buffer size of 1024 characters. - WriterOutputStream(Writer, String, int, boolean) - Constructor for class org.apache.commons.io.output.WriterOutputStream
-
Constructs a new
WriterOutputStream
. - WriterOutputStream(Writer, Charset) - Constructor for class org.apache.commons.io.output.WriterOutputStream
-
Constructs a new
WriterOutputStream
with a default output buffer size of 1024 characters. - WriterOutputStream(Writer, CharsetDecoder) - Constructor for class org.apache.commons.io.output.WriterOutputStream
-
Constructs a new
WriterOutputStream
with a default output buffer size of 1024 characters. - WriterOutputStream(Writer, CharsetDecoder, int, boolean) - Constructor for class org.apache.commons.io.output.WriterOutputStream
-
Constructs a new
WriterOutputStream
. - WriterOutputStream(Writer, Charset, int, boolean) - Constructor for class org.apache.commons.io.output.WriterOutputStream
-
Constructs a new
WriterOutputStream
. - writers - Variable in class org.apache.commons.io.output.FilterCollectionWriter
-
The underlying writers.
- 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 a "int" value to a byte array at a given offset.
- writeSwappedInteger(OutputStream, int) - Static method in class org.apache.commons.io.EndianUtils
-
Writes a "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
- xmlEncoding - Variable in exception org.apache.commons.io.input.XmlStreamReaderException
- xmlGuessEncoding - Variable in exception org.apache.commons.io.input.XmlStreamReaderException
- xmlPrologWriter - Variable in class org.apache.commons.io.output.XmlStreamWriter
- 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
-
Creates a Reader for a File.
- XmlStreamReader(InputStream) - Constructor for class org.apache.commons.io.input.XmlStreamReader
-
Creates a Reader for a raw InputStream.
- XmlStreamReader(InputStream, boolean) - Constructor for class org.apache.commons.io.input.XmlStreamReader
-
Creates a Reader for a raw InputStream.
- XmlStreamReader(InputStream, boolean, String) - Constructor for class org.apache.commons.io.input.XmlStreamReader
-
Creates a Reader for a raw InputStream.
- XmlStreamReader(InputStream, String) - Constructor for class org.apache.commons.io.input.XmlStreamReader
-
Creates a Reader using an InputStream and the associated content-type header.
- XmlStreamReader(InputStream, String, boolean) - Constructor for class org.apache.commons.io.input.XmlStreamReader
-
Creates a Reader using an InputStream and the associated content-type header.
- XmlStreamReader(InputStream, String, boolean, String) - Constructor for class org.apache.commons.io.input.XmlStreamReader
-
Creates a Reader using an InputStream and the associated content-type header.
- XmlStreamReader(URL) - Constructor for class org.apache.commons.io.input.XmlStreamReader
-
Creates a Reader using the InputStream of a URL.
- XmlStreamReader(URLConnection, String) - Constructor for class org.apache.commons.io.input.XmlStreamReader
-
Creates a Reader using the InputStream of a URLConnection.
- XmlStreamReaderException - Exception 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 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 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 Voodoo 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
-
Constructs a new XML stream writer for the specified file with a default encoding of UTF-8.
- XmlStreamWriter(File, String) - Constructor for class org.apache.commons.io.output.XmlStreamWriter
-
Constructs a new XML stream writer for the specified file with the specified default encoding.
- XmlStreamWriter(OutputStream) - Constructor for class org.apache.commons.io.output.XmlStreamWriter
-
Constructs a new XML stream writer for the specified output stream with a default encoding of UTF-8.
- XmlStreamWriter(OutputStream, String) - 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.
_
- _hexcodes - Static variable in class org.apache.commons.io.HexDump
- _shifts - Static variable in class org.apache.commons.io.HexDump
All Classes All Packages