Class AbstractOrigin.InputStreamOrigin

java.lang.Object

org.apache.commons.io.build.AbstractSupplier<InputStream, AbstractOrigin.InputStreamOrigin>

org.apache.commons.io.build.AbstractOrigin<InputStream, AbstractOrigin.InputStreamOrigin>

org.apache.commons.io.build.AbstractOrigin.InputStreamOrigin

All Implemented Interfaces:

IOSupplier<InputStream>

Enclosing class:

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

public static class AbstractOrigin.InputStreamOrigin
extends AbstractOrigin<InputStream, AbstractOrigin.InputStreamOrigin>

An InputStream origin.

This origin cannot provide some of the other aspects.

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

Method Summary

Modifier and Type	Method	Description
byte[]	getByteArray()	Gets this origin as a byte array, if possible.
protected Channel	getChannel(OpenOption... options)	Gets this origin as a Channel, if possible.
InputStream	getInputStream(OpenOption... options)	Gets this origin as an InputStream, if possible.
Reader	getReader(Charset charset)	Gets a new Reader on the origin, buffered by default.
long	size()	Gets the size of the origin, if possible.

Methods inherited from class AbstractOrigin

get, getByteArray, getChannel, getCharSequence, getFile, getOutputStream, getPath, getRandomAccessFile, getWriter, 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

InputStreamOrigin

public InputStreamOrigin(InputStream origin)

Constructs a new instance for the given origin.

Parameters:

origin - The origin, not null.

Throws:

NullPointerException - if origin is null.

Method Details

getByteArray

public byte[] getByteArray()
                    throws IOException

Description copied from class: AbstractOrigin

Gets this origin as a byte array, if possible.

Overrides:

getByteArray in class AbstractOrigin<InputStream, AbstractOrigin.InputStreamOrigin>

Returns:

this origin as a byte array, if possible.

Throws:

IOException - if an I/O error occurs.

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<InputStream, AbstractOrigin.InputStreamOrigin>

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...)

getInputStream

public InputStream getInputStream(OpenOption... options)

Gets this origin as an InputStream, if possible.

The options parameter is ignored since a InputStream does not need an OpenOption to be read.

No conversion should occur when calling this method.

Overrides:

getInputStream in class AbstractOrigin<InputStream, AbstractOrigin.InputStreamOrigin>

Parameters:

options - options specifying how the file is opened

Returns:

this origin as an InputStream, if possible.

getReader

public Reader getReader(Charset charset)
                 throws IOException

Description copied from class: AbstractOrigin

Gets a new Reader on the origin, buffered by default.

Overrides:

getReader in class AbstractOrigin<InputStream, AbstractOrigin.InputStreamOrigin>

Parameters:

charset - the charset to use for decoding, null maps to the default Charset.

Returns:

a new Reader on the origin.

Throws:

IOException - if an I/O error occurs opening the file.

size

public long size()
          throws IOException

Description copied from class: AbstractOrigin

Gets the size of the origin, if possible.

Overrides:

size in class AbstractOrigin<InputStream, AbstractOrigin.InputStreamOrigin>

Returns:

the size of the origin in bytes or characters.

Throws:

IOException - if an I/O error occurs.