Package org.apache.commons.io.build

Class AbstractOrigin.FileOrigin

java.lang.Object

org.apache.commons.io.build.AbstractSupplier<T,B>

org.apache.commons.io.build.AbstractOrigin<java.io.File,AbstractOrigin.FileOrigin>

org.apache.commons.io.build.AbstractOrigin.FileOrigin

All Implemented Interfaces:

IOSupplier<java.io.File>

Enclosing class:

AbstractOrigin<T,B extends AbstractOrigin<T,B>>

public static class AbstractOrigin.FileOrigin
extends AbstractOrigin<java.io.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 java.io.RandomAccessFile,B extends AbstractOrigin.AbstractRandomAccessFileOrigin<T,B>>, AbstractOrigin.ByteArrayOrigin, AbstractOrigin.ChannelOrigin, AbstractOrigin.CharSequenceOrigin, AbstractOrigin.FileOrigin, AbstractOrigin.InputStreamOrigin, AbstractOrigin.IORandomAccessFileOrigin, AbstractOrigin.OutputStreamOrigin, AbstractOrigin.PathOrigin, AbstractOrigin.RandomAccessFileOrigin, AbstractOrigin.ReaderOrigin, AbstractOrigin.URIOrigin, AbstractOrigin.WriterOrigin

Constructor Summary

Constructors

Constructor	Description
FileOrigin(java.io.File origin)	Constructs a new instance for the given origin.

Method Summary

Modifier and Type	Method	Description
byte[]	getByteArray(long position, int length)	Gets a portion of this origin as a byte array, if possible.
protected java.nio.channels.Channel	getChannel(java.nio.file.OpenOption... options)	Gets this origin as a Channel, if possible.
java.io.File	getFile()	Gets this origin as a File, if possible.
java.nio.file.Path	getPath()	Gets this origin as a Path, if possible.

Methods inherited from class org.apache.commons.io.build.AbstractOrigin

get, getByteArray, getChannel, getCharSequence, getInputStream, getOutputStream, getRandomAccessFile, getReader, getWriter, size, toString

Methods inherited from class org.apache.commons.io.build.AbstractSupplier

asThis

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.commons.io.function.IOSupplier

asSupplier, getUnchecked

Constructor Detail

FileOrigin

public FileOrigin(java.io.File origin)

Constructs a new instance for the given origin.

Parameters:

origin - The origin, not null.

Throws:

java.lang.NullPointerException - if origin is null.

Method Detail

getByteArray

public byte[] getByteArray(long position,
                           int length)
                    throws java.io.IOException

Description copied from class: AbstractOrigin

Gets a portion of this origin as a byte array, if possible.

Overrides:

getByteArray in class AbstractOrigin<java.io.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:

java.io.IOException - if an I/O error occurs.

getChannel

protected java.nio.channels.Channel getChannel(java.nio.file.OpenOption... options)
                                        throws java.io.IOException

Description copied from class: AbstractOrigin

Gets this origin as a Channel, if possible.

Overrides:

getChannel in class AbstractOrigin<java.io.File,AbstractOrigin.FileOrigin>

Parameters:

options - Options specifying how a file-based origin is opened, ignored otherwise.

Returns:

A new Channel on the origin.

Throws:

java.io.IOException - If an I/O error occurs.

See Also:

AbstractOrigin.getChannel(Class, OpenOption...)

getFile

public java.io.File getFile()

Gets this origin as a File, if possible.

No conversion should occur when calling this method.

Overrides:

getFile in class AbstractOrigin<java.io.File,AbstractOrigin.FileOrigin>

Returns:

this origin as a File, if possible.

getPath

public java.nio.file.Path getPath()

Description copied from class: AbstractOrigin

Gets this origin as a Path, if possible.

Overrides:

getPath in class AbstractOrigin<java.io.File,AbstractOrigin.FileOrigin>

Returns:

this origin as a Path, if possible.