Class AbstractOrigin.InputStreamOrigin
java.lang.Object
org.apache.commons.io.build.AbstractSupplier<InputStream, AbstractOrigin.InputStreamOrigin>
org.apache.commons.io.build.AbstractOrigin<InputStream, AbstractOrigin.InputStreamOrigin>
org.apache.commons.io.build.AbstractOrigin.InputStreamOrigin
- All Implemented Interfaces:
IOSupplier<InputStream>
- Enclosing class:
AbstractOrigin<T, B extends AbstractOrigin<T,B>>
public static class AbstractOrigin.InputStreamOrigin
extends AbstractOrigin<InputStream, AbstractOrigin.InputStreamOrigin>
An
InputStream 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
ConstructorsConstructorDescriptionInputStreamOrigin(InputStream origin) Constructs a new instance for the given origin. -
Method Summary
Modifier and TypeMethodDescriptionbyte[]Gets this origin as a byte array, if possible.protected ChannelgetChannel(OpenOption... options) Gets this origin as a Channel, if possible.getInputStream(OpenOption... options) Gets this origin as an InputStream, if possible.Gets a new Reader on the origin, buffered by default.longsize()Gets the size of the origin, if possible.Methods inherited from class AbstractOrigin
get, getByteArray, getChannel, getCharSequence, getFile, getOutputStream, getPath, getRandomAccessFile, getWriter, toStringMethods inherited from class AbstractSupplier
asThisMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface IOSupplier
asSupplier, getUnchecked
-
Constructor Details
-
InputStreamOrigin
Constructs a new instance for the given origin.- Parameters:
origin- The origin, not null.- Throws:
NullPointerException- iforiginisnull.
-
-
Method Details
-
getByteArray
Description copied from class:AbstractOriginGets this origin as a byte array, if possible.- Overrides:
getByteArrayin classAbstractOrigin<InputStream, AbstractOrigin.InputStreamOrigin>- Returns:
- this origin as a byte array, if possible.
- Throws:
IOException- if an I/O error occurs.
-
getChannel
Description copied from class:AbstractOriginGets this origin as a Channel, if possible.- Overrides:
getChannelin classAbstractOrigin<InputStream, AbstractOrigin.InputStreamOrigin>- 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:
-
getInputStream
Gets this origin as an InputStream, if possible.The
optionsparameter is ignored since aInputStreamdoes not need anOpenOptionto be read.No conversion should occur when calling this method.
- Overrides:
getInputStreamin classAbstractOrigin<InputStream, AbstractOrigin.InputStreamOrigin>- Parameters:
options- options specifying how the file is opened- Returns:
- this origin as an InputStream, if possible.
-
getReader
Description copied from class:AbstractOriginGets a new Reader on the origin, buffered by default.- Overrides:
getReaderin classAbstractOrigin<InputStream, AbstractOrigin.InputStreamOrigin>- 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.
-
size
Description copied from class:AbstractOriginGets the size of the origin, if possible.- Overrides:
sizein classAbstractOrigin<InputStream, AbstractOrigin.InputStreamOrigin>- Returns:
- the size of the origin in bytes or characters.
- Throws:
IOException- if an I/O error occurs.
-