Package org.apache.commons.io.build

Class AbstractOrigin.URIOrigin

java.lang.Object

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

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

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

All Implemented Interfaces:

IOSupplier<java.net.URI>

Enclosing class:

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

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

A URI origin.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractOrigin.URIOrigin.URIOpenOption	Options for connect and read from a URI.

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

Field Summary

Fields

Modifier and Type	Field	Description
private static java.lang.String	SCHEME_HTTP
private static java.lang.String	SCHEME_HTTPS

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

origin

Constructor Summary

Constructors

Constructor	Description
URIOrigin(java.net.URI origin)	Constructs a new instance for the given origin.

Method Summary

Modifier and Type	Method	Description
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.
private java.io.InputStream	getInputStream(java.net.URI uri, java.nio.file.OpenOption... options)
java.io.InputStream	getInputStream(java.nio.file.OpenOption... options)	Gets this origin as an InputStream, if possible.
java.nio.file.Path	getPath()	Gets this origin as a Path, if possible.
private int	toMillis(java.time.Duration duration)

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

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

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

Field Detail

SCHEME_HTTPS

private static final java.lang.String SCHEME_HTTPS

See Also:

Constant Field Values

SCHEME_HTTP

private static final java.lang.String SCHEME_HTTP

See Also:

Constant Field Values

Constructor Detail

URIOrigin

public URIOrigin(java.net.URI 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

getChannel

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

Gets this origin as a Channel, if possible.

Overrides:

getChannel in class AbstractOrigin<java.net.URI,AbstractOrigin.URIOrigin>

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.URIOrigin.URIOpenOption

getFile

public java.io.File getFile()

Description copied from class: AbstractOrigin

Gets this origin as a File, if possible.

Overrides:

getFile in class AbstractOrigin<java.net.URI,AbstractOrigin.URIOrigin>

Returns:

this origin as a File, if possible.

getInputStream

public java.io.InputStream getInputStream(java.nio.file.OpenOption... options)
                                   throws java.io.IOException

Gets this origin as an InputStream, if possible.

Set timeouts with a AbstractOrigin.URIOrigin.URIOpenOption.

Overrides:

getInputStream in class AbstractOrigin<java.net.URI,AbstractOrigin.URIOrigin>

Parameters:

options - options specifying how the file is opened.

Returns:

this origin as an InputStream, if possible.

Throws:

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

See Also:

AbstractOrigin.URIOrigin.URIOpenOption, URLConnection.setConnectTimeout(int), URLConnection.setReadTimeout(int)

getInputStream

private java.io.InputStream getInputStream(java.net.URI uri,
                                           java.nio.file.OpenOption... options)
                                    throws java.io.IOException

Throws:

java.io.IOException

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.net.URI,AbstractOrigin.URIOrigin>

Returns:

this origin as a Path, if possible.

toMillis

private int toMillis(java.time.Duration duration)