org.apache.commons.io.input

Class UnsynchronizedByteArrayInputStream.Builder

java.lang.Object

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

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

org.apache.commons.io.build.AbstractStreamBuilder<UnsynchronizedByteArrayInputStream,UnsynchronizedByteArrayInputStream.Builder>

org.apache.commons.io.input.UnsynchronizedByteArrayInputStream.Builder

All Implemented Interfaces:

IOSupplier<UnsynchronizedByteArrayInputStream>

Enclosing class:

UnsynchronizedByteArrayInputStream

public static class UnsynchronizedByteArrayInputStream.Builder
extends AbstractStreamBuilder<UnsynchronizedByteArrayInputStream,UnsynchronizedByteArrayInputStream.Builder>

Builds a new UnsynchronizedByteArrayInputStream instance.

Using a Byte Array:

 UnsynchronizedByteArrayInputStream s = UnsynchronizedByteArrayInputStream.builder().setByteArray(byteArray).setOffset(0).setLength(byteArray.length)
         .get();
 
 

Using File IO:

 UnsynchronizedByteArrayInputStream s = UnsynchronizedByteArrayInputStream.builder().setFile(file).setOffset(0).setLength(byteArray.length).get();
 
 

Using NIO Path:

 UnsynchronizedByteArrayInputStream s = UnsynchronizedByteArrayInputStream.builder().setPath(path).setOffset(0).setLength(byteArray.length).get();
 
 

Field Summary

Fields

Modifier and Type	Field and Description
private int	length
private int	offset

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
UnsynchronizedByteArrayInputStream	get() Constructs a new instance.
UnsynchronizedByteArrayInputStream.Builder	setByteArray(byte[] origin) Sets a new origin.
UnsynchronizedByteArrayInputStream.Builder	setLength(int length) Sets the length.
UnsynchronizedByteArrayInputStream.Builder	setOffset(int offset) Sets the offset.

Methods inherited from class org.apache.commons.io.build.AbstractStreamBuilder

getBufferSize, getBufferSizeDefault, getCharSequence, getCharset, getCharsetDefault, getInputStream, getOpenOptions, getOutputStream, getPath, getWriter, setBufferSize, setBufferSize, setBufferSizeChecker, setBufferSizeDefault, setBufferSizeMax, setCharset, setCharset, setCharsetDefault, setOpenOptions

Methods inherited from class org.apache.commons.io.build.AbstractOriginSupplier

checkOrigin, getOrigin, hasOrigin, newByteArrayOrigin, newCharSequenceOrigin, newFileOrigin, newFileOrigin, newInputStreamOrigin, newOutputStreamOrigin, newPathOrigin, newPathOrigin, newReaderOrigin, newURIOrigin, newWriterOrigin, setCharSequence, setFile, setFile, setInputStream, setOrigin, setOutputStream, setPath, setPath, setReader, setURI, setWriter

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

Field Detail

offset

private int offset

length

private int length

Constructor Detail

Builder

public Builder()

Method Detail

get

public UnsynchronizedByteArrayInputStream get()
                                       throws java.io.IOException

Constructs a new instance.

This builder use the aspects byte[], offset and length.

You must provide an origin that can be converted to a byte[] by this builder, otherwise, this call will throw an UnsupportedOperationException.

Returns:

a new instance.

Throws:

java.lang.UnsupportedOperationException - if the origin cannot provide a byte[].

java.lang.IllegalStateException - if the origin is null.

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

See Also:

AbstractOrigin.getByteArray()

setByteArray

public UnsynchronizedByteArrayInputStream.Builder setByteArray(byte[] origin)

Description copied from class: AbstractOriginSupplier

Sets a new origin.

Overrides:

setByteArray in class AbstractOriginSupplier<UnsynchronizedByteArrayInputStream,UnsynchronizedByteArrayInputStream.Builder>

Parameters:

origin - the new origin.

Returns:

this

setLength

public UnsynchronizedByteArrayInputStream.Builder setLength(int length)

Sets the length.

Parameters:

length - Must be greater or equal to 0.

Returns:

this.

setOffset

public UnsynchronizedByteArrayInputStream.Builder setOffset(int offset)

Sets the offset.

Parameters:

offset - Must be greater or equal to 0.

Returns:

this.