Package org.apache.commons.io.build
Class AbstractOriginSupplier<T,B extends AbstractOriginSupplier<T,B>>
- java.lang.Object
-
- org.apache.commons.io.build.AbstractSupplier<T,B>
-
- org.apache.commons.io.build.AbstractOriginSupplier<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:
AbstractStreamBuilder
public abstract class AbstractOriginSupplier<T,B extends AbstractOriginSupplier<T,B>> extends AbstractSupplier<T,B>
Abstracts building an instance ofT
.- Since:
- 2.12.0
-
-
Field Summary
Fields Modifier and Type Field Description private AbstractOrigin<?,?>
origin
The underlying origin.
-
Constructor Summary
Constructors Constructor Description AbstractOriginSupplier()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected AbstractOrigin<?,?>
checkOrigin()
Checks whether the origin is null.protected AbstractOrigin<?,?>
getOrigin()
Gets the origin.protected boolean
hasOrigin()
Tests whether the origin is null.protected static AbstractOrigin.ByteArrayOrigin
newByteArrayOrigin(byte[] origin)
Creates a new byte array origin for a byte array.protected static AbstractOrigin.CharSequenceOrigin
newCharSequenceOrigin(java.lang.CharSequence origin)
Creates a new CharSequence origin for a CharSequence.protected static AbstractOrigin.FileOrigin
newFileOrigin(java.io.File origin)
Creates a new file origin for a file.protected static AbstractOrigin.FileOrigin
newFileOrigin(java.lang.String origin)
Creates a new file origin for a file path.protected static AbstractOrigin.InputStreamOrigin
newInputStreamOrigin(java.io.InputStream origin)
Creates a new input stream origin for a file.protected static AbstractOrigin.OutputStreamOrigin
newOutputStreamOrigin(java.io.OutputStream origin)
Creates a new output stream origin for a file.protected static AbstractOrigin.PathOrigin
newPathOrigin(java.lang.String origin)
Creates a new path name origin for a path name.protected static AbstractOrigin.PathOrigin
newPathOrigin(java.nio.file.Path origin)
Creates a new path origin for a file.protected static AbstractOrigin.ReaderOrigin
newReaderOrigin(java.io.Reader origin)
Creates a new reader origin for a reader.protected static AbstractOrigin.URIOrigin
newURIOrigin(java.net.URI origin)
Creates a new reader origin for a URI.protected static AbstractOrigin.WriterOrigin
newWriterOrigin(java.io.Writer origin)
Creates a new writer origin for a file.B
setByteArray(byte[] origin)
Sets a new origin.B
setCharSequence(java.lang.CharSequence origin)
Sets a new origin.B
setFile(java.io.File origin)
Sets a new origin.B
setFile(java.lang.String origin)
Sets a new origin.B
setInputStream(java.io.InputStream origin)
Sets a new origin.protected B
setOrigin(AbstractOrigin<?,?> origin)
Sets a new origin.B
setOutputStream(java.io.OutputStream origin)
Sets a new origin.B
setPath(java.lang.String origin)
Sets a new origin.B
setPath(java.nio.file.Path origin)
Sets a new origin.B
setReader(java.io.Reader origin)
Sets a new origin.B
setURI(java.net.URI origin)
Sets a new origin.B
setWriter(java.io.Writer origin)
Sets a new origin.-
Methods inherited from class org.apache.commons.io.build.AbstractSupplier
asThis
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.commons.io.function.IOSupplier
asSupplier, get
-
-
-
-
Field Detail
-
origin
private AbstractOrigin<?,?> origin
The underlying origin.
-
-
Method Detail
-
newByteArrayOrigin
protected static AbstractOrigin.ByteArrayOrigin newByteArrayOrigin(byte[] origin)
Creates a new byte array origin for a byte array.- Parameters:
origin
- the byte array.- Returns:
- a new byte array origin.
-
newCharSequenceOrigin
protected static AbstractOrigin.CharSequenceOrigin newCharSequenceOrigin(java.lang.CharSequence origin)
Creates a new CharSequence origin for a CharSequence.- Parameters:
origin
- the CharSequence.- Returns:
- a new file origin.
- Since:
- 2.13.0
-
newFileOrigin
protected static AbstractOrigin.FileOrigin newFileOrigin(java.io.File origin)
Creates a new file origin for a file.- Parameters:
origin
- the file.- Returns:
- a new file origin.
-
newFileOrigin
protected static AbstractOrigin.FileOrigin newFileOrigin(java.lang.String origin)
Creates a new file origin for a file path.- Parameters:
origin
- the file path.- Returns:
- a new file origin.
-
newInputStreamOrigin
protected static AbstractOrigin.InputStreamOrigin newInputStreamOrigin(java.io.InputStream origin)
Creates a new input stream origin for a file.- Parameters:
origin
- the input stream.- Returns:
- a new input stream origin.
-
newOutputStreamOrigin
protected static AbstractOrigin.OutputStreamOrigin newOutputStreamOrigin(java.io.OutputStream origin)
Creates a new output stream origin for a file.- Parameters:
origin
- the output stream.- Returns:
- a new output stream origin.
-
newPathOrigin
protected static AbstractOrigin.PathOrigin newPathOrigin(java.nio.file.Path origin)
Creates a new path origin for a file.- Parameters:
origin
- the path.- Returns:
- a new path origin.
-
newPathOrigin
protected static AbstractOrigin.PathOrigin newPathOrigin(java.lang.String origin)
Creates a new path name origin for a path name.- Parameters:
origin
- the path name.- Returns:
- a new path name origin.
-
newReaderOrigin
protected static AbstractOrigin.ReaderOrigin newReaderOrigin(java.io.Reader origin)
Creates a new reader origin for a reader.- Parameters:
origin
- the reader.- Returns:
- a new reader origin.
-
newURIOrigin
protected static AbstractOrigin.URIOrigin newURIOrigin(java.net.URI origin)
Creates a new reader origin for a URI.- Parameters:
origin
- the URI.- Returns:
- a new URI origin.
-
newWriterOrigin
protected static AbstractOrigin.WriterOrigin newWriterOrigin(java.io.Writer origin)
Creates a new writer origin for a file.- Parameters:
origin
- the writer.- Returns:
- a new writer .
-
checkOrigin
protected AbstractOrigin<?,?> checkOrigin()
Checks whether the origin is null.- Returns:
- the origin.
- Throws:
java.lang.IllegalStateException
- if theorigin
isnull
.
-
getOrigin
protected AbstractOrigin<?,?> getOrigin()
Gets the origin.- Returns:
- the origin.
-
hasOrigin
protected boolean hasOrigin()
Tests whether the origin is null.- Returns:
- whether the origin is null.
-
setByteArray
public B setByteArray(byte[] origin)
Sets a new origin.- Parameters:
origin
- the new origin.- Returns:
- this
-
setCharSequence
public B setCharSequence(java.lang.CharSequence origin)
Sets a new origin.- Parameters:
origin
- the new origin.- Returns:
- this
- Since:
- 2.13.0
-
setFile
public B setFile(java.io.File origin)
Sets a new origin.- Parameters:
origin
- the new origin.- Returns:
- this
-
setFile
public B setFile(java.lang.String origin)
Sets a new origin.- Parameters:
origin
- the new origin.- Returns:
- this
-
setInputStream
public B setInputStream(java.io.InputStream origin)
Sets a new origin.- Parameters:
origin
- the new origin.- Returns:
- this
-
setOrigin
protected B setOrigin(AbstractOrigin<?,?> origin)
Sets a new origin.- Parameters:
origin
- the new origin.- Returns:
- this
-
setOutputStream
public B setOutputStream(java.io.OutputStream origin)
Sets a new origin.- Parameters:
origin
- the new origin.- Returns:
- this
-
setPath
public B setPath(java.nio.file.Path origin)
Sets a new origin.- Parameters:
origin
- the new origin.- Returns:
- this
-
setPath
public B setPath(java.lang.String origin)
Sets a new origin.- Parameters:
origin
- the new origin.- Returns:
- this
-
setReader
public B setReader(java.io.Reader origin)
Sets a new origin.- Parameters:
origin
- the new origin.- Returns:
- this
-
setURI
public B setURI(java.net.URI origin)
Sets a new origin.- Parameters:
origin
- the new origin.- Returns:
- this
-
setWriter
public B setWriter(java.io.Writer origin)
Sets a new origin.- Parameters:
origin
- the new origin.- Returns:
- this
-
-