Package org.apache.commons.io.build
Class AbstractOrigin.FileOrigin
java.lang.Object
org.apache.commons.io.build.AbstractSupplier<File,AbstractOrigin.FileOrigin>
org.apache.commons.io.build.AbstractOrigin<File,AbstractOrigin.FileOrigin>
org.apache.commons.io.build.AbstractOrigin.FileOrigin
- All Implemented Interfaces:
IOSupplier<File>
- Enclosing class:
AbstractOrigin<T,B extends AbstractOrigin<T, B>>
public static class AbstractOrigin.FileOrigin
extends AbstractOrigin<File,AbstractOrigin.FileOrigin>
A
File origin.
Starting from this origin, you can get a byte array, a file, an input stream, an output stream, a path, a reader, and a writer.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.commons.io.build.AbstractOrigin
AbstractOrigin.AbstractRandomAccessFileOrigin<T extends RandomAccessFile,B extends AbstractOrigin.AbstractRandomAccessFileOrigin<T, B>>, AbstractOrigin.ByteArrayOrigin, AbstractOrigin.CharSequenceOrigin, AbstractOrigin.FileOrigin, AbstractOrigin.InputStreamOrigin, AbstractOrigin.IORandomAccessFileOrigin, AbstractOrigin.OutputStreamOrigin, AbstractOrigin.PathOrigin, AbstractOrigin.RandomAccessFileOrigin, AbstractOrigin.ReaderOrigin, AbstractOrigin.URIOrigin, AbstractOrigin.WriterOrigin -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbyte[]getByteArray(long position, int length) Gets a portion of this origin as a byte array, if possible.getFile()Gets this origin as a Path, if possible.getPath()Gets this origin as a Path, if possible.Methods inherited from class org.apache.commons.io.build.AbstractOrigin
get, getByteArray, getCharSequence, getInputStream, getOutputStream, getRandomAccessFile, getReader, getWriter, size, toStringMethods inherited from class org.apache.commons.io.build.AbstractSupplier
asThisMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.commons.io.function.IOSupplier
asSupplier, getUnchecked
-
Constructor Details
-
FileOrigin
Constructs a new instance for the given origin.- Parameters:
origin- The origin, not null.
-
-
Method Details
-
getByteArray
Description copied from class:AbstractOriginGets a portion of this origin as a byte array, if possible.- Overrides:
getByteArrayin classAbstractOrigin<File,AbstractOrigin.FileOrigin> - Parameters:
position- the initial index of the range to be copied, inclusive.length- How many bytes to copy.- Returns:
- this origin as a byte array, if possible.
- Throws:
IOException- if an I/O error occurs.
-
getFile
Description copied from class:AbstractOriginGets this origin as a Path, if possible.- Overrides:
getFilein classAbstractOrigin<File,AbstractOrigin.FileOrigin> - Returns:
- this origin as a Path, if possible.
-
getPath
Description copied from class:AbstractOriginGets this origin as a Path, if possible.- Overrides:
getPathin classAbstractOrigin<File,AbstractOrigin.FileOrigin> - Returns:
- this origin as a Path, if possible.
-