Package org.apache.commons.io.build

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

java.lang.Object

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

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

Type Parameters:

T - the type of instances to build.

B - the type of builder subclass.

All Implemented Interfaces:

IOSupplier<T>

Direct Known Subclasses:

AbstractOrigin.ByteArrayOrigin, AbstractOrigin.CharSequenceOrigin, AbstractOrigin.FileOrigin, AbstractOrigin.InputStreamOrigin, AbstractOrigin.OutputStreamOrigin, AbstractOrigin.PathOrigin, AbstractOrigin.ReaderOrigin, AbstractOrigin.URIOrigin, AbstractOrigin.WriterOrigin

public abstract class AbstractOrigin<T,B extends AbstractOrigin<T,B>>
extends AbstractSupplier<T,B>

Abstracts the origin of data for builders like a File, Path, Reader, Writer, InputStream, OutputStream, and URI.

Some methods may throw UnsupportedOperationException if that method is not implemented in a concrete subclass, see getFile() and getPath().

Since:

2.12.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractOrigin.ByteArrayOrigin	A byte[] origin.
static class	AbstractOrigin.CharSequenceOrigin	A CharSequence origin.
static class	AbstractOrigin.FileOrigin	A File origin.
static class	AbstractOrigin.InputStreamOrigin	An InputStream origin.
static class	AbstractOrigin.OutputStreamOrigin	An OutputStream origin.
static class	AbstractOrigin.PathOrigin	A Path origin.
static class	AbstractOrigin.ReaderOrigin	An Reader origin.
static class	AbstractOrigin.URIOrigin	A URI origin.
static class	AbstractOrigin.WriterOrigin	An Writer origin.

Method Summary

Modifier and Type	Method	Description
T	get()	Gets the origin.
byte[]	getByteArray()	Gets this origin as a byte array, if possible.
byte[]	getByteArray(long position, int length)	Gets this origin as a byte array, if possible.
java.lang.CharSequence	getCharSequence(java.nio.charset.Charset charset)	Gets this origin as a byte array, if possible.
java.io.File	getFile()	Gets this origin as a Path, if possible.
java.io.InputStream	getInputStream(java.nio.file.OpenOption... options)	Gets this origin as an InputStream, if possible.
java.io.OutputStream	getOutputStream(java.nio.file.OpenOption... options)	Gets this origin as an OutputStream, if possible.
java.nio.file.Path	getPath()	Gets this origin as a Path, if possible.
java.io.Reader	getReader(java.nio.charset.Charset charset)	Gets a new Reader on the origin, buffered by default.
java.io.Writer	getWriter(java.nio.charset.Charset charset, java.nio.file.OpenOption... options)	Gets a new Writer on the origin, buffered by default.
long	size()	Gets the size of the origin, if possible.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.commons.io.function.IOSupplier

asSupplier

Method Detail

get

public T get()

Gets the origin.

Returns:

the origin.

getByteArray

public byte[] getByteArray()
                    throws java.io.IOException

Gets this origin as a byte array, if possible.

Returns:

this origin as a byte array, if possible.

Throws:

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

java.lang.UnsupportedOperationException - if the origin cannot be converted to a Path.

getByteArray

public byte[] getByteArray(long position,
                           int length)
                    throws java.io.IOException

Gets this origin as a byte array, if possible.

Parameters:

position - the initial index of the range to be copied, inclusive.

length - How many bytes to copy.

Returns:

this origin as a byte array, if possible.

Throws:

java.lang.UnsupportedOperationException - if the origin cannot be converted to a Path.

java.lang.ArithmeticException - if the position overflows an int

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

Since:

2.13.0

getCharSequence

public java.lang.CharSequence getCharSequence(java.nio.charset.Charset charset)
                                       throws java.io.IOException

Gets this origin as a byte array, if possible.

Parameters:

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

Returns:

this origin as a byte array, if possible.

Throws:

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

java.lang.UnsupportedOperationException - if the origin cannot be converted to a Path.

getFile

public java.io.File getFile()

Gets this origin as a Path, if possible.

Returns:

this origin as a Path, if possible.

Throws:

java.lang.UnsupportedOperationException - if this method is not implemented in a concrete subclass.

getInputStream

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

Gets this origin as an InputStream, if possible.

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.

java.lang.UnsupportedOperationException - if the origin cannot be converted to a Path.

getOutputStream

public java.io.OutputStream getOutputStream(java.nio.file.OpenOption... options)
                                     throws java.io.IOException

Gets this origin as an OutputStream, if possible.

Parameters:

options - options specifying how the file is opened

Returns:

this origin as an OutputStream, if possible.

Throws:

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

java.lang.UnsupportedOperationException - if the origin cannot be converted to a Path.

getPath

public java.nio.file.Path getPath()

Gets this origin as a Path, if possible.

Returns:

this origin as a Path, if possible.

Throws:

java.lang.UnsupportedOperationException - if this method is not implemented in a concrete subclass.

getReader

public java.io.Reader getReader(java.nio.charset.Charset charset)
                         throws java.io.IOException

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

Parameters:

charset - the charset to use for decoding

Returns:

a new Reader on the origin.

Throws:

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

getWriter

public java.io.Writer getWriter(java.nio.charset.Charset charset,
                                java.nio.file.OpenOption... options)
                         throws java.io.IOException

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

Parameters:

charset - the charset to use for encoding

options - options specifying how the file is opened

Returns:

a new Writer on the origin.

Throws:

java.io.IOException - if an I/O error occurs opening or creating the file.

java.lang.UnsupportedOperationException - if the origin cannot be converted to a Path.

size

public long size()
          throws java.io.IOException

Gets the size of the origin, if possible.

Returns:

the size of the origin in bytes or characters.

Throws:

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

Since:

2.13.0

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object