Class AbstractOrigin.URIOrigin

java.lang.Object

org.apache.commons.io.build.AbstractSupplier<URI, AbstractOrigin.URIOrigin>

org.apache.commons.io.build.AbstractOrigin<URI, AbstractOrigin.URIOrigin>

org.apache.commons.io.build.AbstractOrigin.URIOrigin

All Implemented Interfaces:

IOSupplier<URI>

Enclosing class:

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

public static class AbstractOrigin.URIOrigin
extends AbstractOrigin<URI, AbstractOrigin.URIOrigin>

A URI origin.

Since:

2.12.0

Nested Class Summary

Nested classes/interfaces inherited from class AbstractOrigin

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
URIOrigin(URI origin)	Constructs a new instance for the given origin.

Method Summary

Modifier and Type	Method	Description
protected Channel	getChannel(OpenOption... options)	Gets this origin as a Channel, if possible.
File	getFile()	Gets this origin as a File, if possible.
InputStream	getInputStream(OpenOption... options)	Gets this origin as an InputStream, if possible.
Path	getPath()	Gets this origin as a Path, if possible.

Methods inherited from class AbstractOrigin

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

Methods inherited from class AbstractSupplier

asThis

Methods inherited from class Object

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

Methods inherited from interface IOSupplier

asSupplier, getUnchecked

Constructor Details

URIOrigin

public URIOrigin(URI origin)

Constructs a new instance for the given origin.

Parameters:

origin - The origin, not null.

Throws:

NullPointerException - if origin is null.

Method Details

getChannel

protected Channel getChannel(OpenOption... options)
                      throws IOException

Description copied from class: AbstractOrigin

Gets this origin as a Channel, if possible.

Overrides:

getChannel in class AbstractOrigin<URI, AbstractOrigin.URIOrigin>

Parameters:

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

Returns:

A new Channel on the origin.

Throws:

IOException - If an I/O error occurs.

See Also:

• AbstractOrigin.getChannel(Class, OpenOption...)

getFile

public File getFile()

Description copied from class: AbstractOrigin

Gets this origin as a File, if possible.

Overrides:

getFile in class AbstractOrigin<URI, AbstractOrigin.URIOrigin>

Returns:

this origin as a File, if possible.

getInputStream

public InputStream getInputStream(OpenOption... options)
                           throws IOException

Description copied from class: AbstractOrigin

Gets this origin as an InputStream, if possible.

Overrides:

getInputStream in class AbstractOrigin<URI, AbstractOrigin.URIOrigin>

Parameters:

options - options specifying how the file is opened

Returns:

this origin as an InputStream, if possible.

Throws:

IOException - if an I/O error occurs.

getPath

public Path getPath()

Description copied from class: AbstractOrigin

Gets this origin as a Path, if possible.

Overrides:

getPath in class AbstractOrigin<URI, AbstractOrigin.URIOrigin>

Returns:

this origin as a Path, if possible.