Class AbstractOrigin.ReaderOrigin

java.lang.Object

org.apache.commons.io.build.AbstractSupplier<Reader, AbstractOrigin.ReaderOrigin>

org.apache.commons.io.build.AbstractOrigin<Reader, AbstractOrigin.ReaderOrigin>

org.apache.commons.io.build.AbstractOrigin.ReaderOrigin

All Implemented Interfaces:

IOSupplier<Reader>

Enclosing class:

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

public static class AbstractOrigin.ReaderOrigin
extends AbstractOrigin<Reader, AbstractOrigin.ReaderOrigin>

A Reader origin.

This origin cannot provide conversions to 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
ReaderOrigin(Reader 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.
CharSequence	getCharSequence(Charset charset)	Gets this origin as a byte array, 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.

Methods inherited from class AbstractOrigin

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

ReaderOrigin

public ReaderOrigin(Reader 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<Reader, AbstractOrigin.ReaderOrigin>

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<Reader, AbstractOrigin.ReaderOrigin>

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

getCharSequence

public CharSequence getCharSequence(Charset charset)
                             throws IOException

Gets this origin as a byte array, if possible.

The charset parameter is ignored since a Reader does not need a Charset to be read.

Overrides:

getCharSequence in class AbstractOrigin<Reader, AbstractOrigin.ReaderOrigin>

Parameters:

charset - The charset to use if conversion from bytes is needed.

Returns:

this origin as a byte array, if possible.

Throws:

IOException - if an I/O error occurs.

getInputStream

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

Gets this origin as an InputStream, if possible.

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

Overrides:

getInputStream in class AbstractOrigin<Reader, AbstractOrigin.ReaderOrigin>

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.

getReader

public Reader getReader(Charset charset)
                 throws IOException

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

The charset parameter is ignored since a Reader does not need a Charset to be read.

No conversion should occur when calling this method.

Overrides:

getReader in class AbstractOrigin<Reader, AbstractOrigin.ReaderOrigin>

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.