Record Class ByteBodyFactory.StreamingBody

java.lang.Object

java.lang.Record

io.micronaut.http.body.ByteBodyFactory.StreamingBody

Record Components:

sharedBuffer - The shared buffer to write data to

rootBody - The root body to read data from

Enclosing class:

ByteBodyFactory

@Internal
public static record ByteBodyFactory.StreamingBody(BaseSharedBuffer sharedBuffer, BaseStreamingByteBody<?> rootBody)
extends Record

Return type for ByteBodyFactory.createStreamingBody(BodySizeLimits, BufferConsumer.Upstream). Internal API.

Since:

4.8.0

Author:

Jonas Konrad

Constructor Summary

Constructors

Constructor	Description
StreamingBody(BaseSharedBuffer sharedBuffer, BaseStreamingByteBody<?> rootBody)	Creates an instance of a StreamingBody record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
BaseStreamingByteBody<?>	rootBody()	Returns the value of the rootBody record component.
BaseSharedBuffer	sharedBuffer()	Returns the value of the sharedBuffer record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

StreamingBody

public StreamingBody(BaseSharedBuffer sharedBuffer,
 BaseStreamingByteBody<?> rootBody)

Creates an instance of a StreamingBody record class.

Parameters:

sharedBuffer - the value for the sharedBuffer record component

rootBody - the value for the rootBody record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

sharedBuffer

public BaseSharedBuffer sharedBuffer()

Returns the value of the sharedBuffer record component.

Returns:

the value of the sharedBuffer record component

rootBody

public BaseStreamingByteBody<?> rootBody()

Returns the value of the rootBody record component.

Returns:

the value of the rootBody record component