Package io.pravega.common.util

Class BufferViewBuilder

java.lang.Object

io.pravega.common.util.BufferViewBuilder

@NotThreadSafe
public class BufferViewBuilder
extends java.lang.Object

Builder for BufferView instances.

Method Summary

Modifier and Type	Method	Description
BufferViewBuilder	add(@NonNull BufferView bufferView)	Includes the given BufferView in the builder.
BufferView	build()	Generates a BufferView with the current contents of this BufferViewBuilder instance.
int	getLength()	The length, in bytes, of the accumulated BufferView.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

add

public BufferViewBuilder add(@NonNull
                             @NonNull BufferView bufferView)

Includes the given BufferView in the builder.

Parameters:

bufferView - The BufferView to include. If empty, it will be ignored; if a CompositeBufferView, its components will be added; otherwise the buffer itself will be added. No data copies are being made as part of this process; the resulting BufferView after invoking build() will contain references to the BufferViews passed via this method and not contain copies of their data. Any modifications made to this BufferView will be reflected in the resulting BufferView and viceversa.

Returns:

This instance.

build

public BufferView build()

Generates a BufferView with the current contents of this BufferViewBuilder instance.

Returns:

A BufferView. If getLength() is 0, returns BufferView.empty(); otherwise returns either a CompositeBufferView (if the number of components is greater than 1), or the single BufferView that it contains (if the number of components equals 1).

getLength

public int getLength()

The length, in bytes, of the accumulated BufferView.