Class AbstractOrigin.OutputStreamOrigin

java.lang.Object

org.apache.commons.io.build.AbstractSupplier<OutputStream, AbstractOrigin.OutputStreamOrigin>

org.apache.commons.io.build.AbstractOrigin<OutputStream, AbstractOrigin.OutputStreamOrigin>

org.apache.commons.io.build.AbstractOrigin.OutputStreamOrigin

All Implemented Interfaces:

IOSupplier<OutputStream>

Enclosing class:

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

public static class AbstractOrigin.OutputStreamOrigin
extends AbstractOrigin<OutputStream, AbstractOrigin.OutputStreamOrigin>

An OutputStream 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
OutputStreamOrigin(OutputStream 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.
OutputStream	getOutputStream(OpenOption... options)	Gets this origin as an OutputStream, if possible.
Writer	getWriter(Charset charset, OpenOption... options)	Gets a new Writer on the origin, buffered by default.

Methods inherited from class AbstractOrigin

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

OutputStreamOrigin

public OutputStreamOrigin(OutputStream 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<OutputStream, AbstractOrigin.OutputStreamOrigin>

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

getOutputStream

public OutputStream getOutputStream(OpenOption... options)

Gets this origin as an OutputStream, if possible.

The options parameter is ignored since a OutputStream does not need an OpenOption to be written.

No conversion should occur when calling this method.

Overrides:

getOutputStream in class AbstractOrigin<OutputStream, AbstractOrigin.OutputStreamOrigin>

Parameters:

options - options specifying how the file is opened

Returns:

this origin as an OutputStream, if possible.

getWriter

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

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

The options parameter is ignored since a OutputStream does not need an OpenOption to be written.

Overrides:

getWriter in class AbstractOrigin<OutputStream, AbstractOrigin.OutputStreamOrigin>

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.