Class AbstractOrigin.ChannelOrigin

java.lang.Object

org.apache.commons.io.build.AbstractSupplier<Channel, AbstractOrigin.ChannelOrigin>

org.apache.commons.io.build.AbstractOrigin<Channel, AbstractOrigin.ChannelOrigin>

org.apache.commons.io.build.AbstractOrigin.ChannelOrigin

All Implemented Interfaces:

IOSupplier<Channel>

Enclosing class:

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

public static class AbstractOrigin.ChannelOrigin
extends AbstractOrigin<Channel, AbstractOrigin.ChannelOrigin>

A Channel origin.

Since:

2.21.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
ChannelOrigin(Channel 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.
OutputStream	getOutputStream(OpenOption... options)	Gets this origin as an OutputStream, if possible.
Reader	getReader(Charset charset)	Gets a new Reader on the origin, buffered by default.
Writer	getWriter(Charset charset, OpenOption... options)	Gets a new Writer 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, getPath, getRandomAccessFile, 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

ChannelOrigin

public ChannelOrigin(Channel 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<Channel, AbstractOrigin.ChannelOrigin>

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

Gets this origin as a Channel, if possible.

No conversion should occur when calling this method.

Overrides:

getChannel in class AbstractOrigin<Channel, AbstractOrigin.ChannelOrigin>

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)
                           throws IOException

Description copied from class: AbstractOrigin

Gets this origin as an InputStream, if possible.

Overrides:

getInputStream in class AbstractOrigin<Channel, AbstractOrigin.ChannelOrigin>

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.

getOutputStream

public OutputStream getOutputStream(OpenOption... options)
                             throws IOException

Description copied from class: AbstractOrigin

Gets this origin as an OutputStream, if possible.

Overrides:

getOutputStream in class AbstractOrigin<Channel, AbstractOrigin.ChannelOrigin>

Parameters:

options - options specifying how the file is opened

Returns:

this origin as an OutputStream, if possible.

Throws:

IOException - if an I/O error occurs.

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<Channel, AbstractOrigin.ChannelOrigin>

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.

getWriter

public Writer getWriter(Charset charset,
 OpenOption... options)
                 throws IOException

Description copied from class: AbstractOrigin

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

Overrides:

getWriter in class AbstractOrigin<Channel, AbstractOrigin.ChannelOrigin>

Parameters:

charset - the charset to use for encoding

options - options specifying how the file is opened

Returns:

a new Writer on the origin.

Throws:

IOException - if an I/O error occurs opening or creating 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<Channel, AbstractOrigin.ChannelOrigin>

Returns:

the size of the origin in bytes or characters.

Throws:

IOException - if an I/O error occurs.