io.rsocket.util

Class EmptyPayload

java.lang.Object

io.rsocket.util.EmptyPayload

All Implemented Interfaces:

ReferenceCounted, Payload

public class EmptyPayload
extends Object
implements Payload

Field Summary

Fields

Modifier and Type	Field and Description
static EmptyPayload	INSTANCE

Method Summary

Modifier and Type	Method and Description
ByteBuf	data() Returns the Payloads' data without slicing if possible.
boolean	hasMetadata() Returns whether the payload has metadata, useful for tell if metadata is empty or not present.
ByteBuf	metadata() Returns the Payloads' metadata without slicing if possible.
int	refCnt()
boolean	release()
boolean	release(int decrement)
EmptyPayload	retain() Increases the reference count by 1.
EmptyPayload	retain(int increment) Increases the reference count by the specified increment.
ByteBuf	sliceData() Returns the Payload data.
ByteBuf	sliceMetadata() Returns a slice Payload metadata.
EmptyPayload	touch() Records the current access location of this object for debugging purposes.
EmptyPayload	touch(Object hint) Records the current access location of this object with an additional arbitrary information for debugging purposes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.rsocket.Payload

getData, getDataUtf8, getMetadata, getMetadataUtf8

Field Detail

INSTANCE

public static final EmptyPayload INSTANCE

Method Detail

hasMetadata

public boolean hasMetadata()

Description copied from interface: Payload

Returns whether the payload has metadata, useful for tell if metadata is empty or not present.

Specified by:

hasMetadata in interface Payload

Returns:

whether payload has non-null (possibly empty) metadata

sliceMetadata

public ByteBuf sliceMetadata()

Description copied from interface: Payload

Returns a slice Payload metadata. Always non-null, check Payload.hasMetadata() to differentiate null from "".

Specified by:

sliceMetadata in interface Payload

Returns:

payload metadata.

sliceData

public ByteBuf sliceData()

Description copied from interface: Payload

Returns the Payload data. Always non-null.

Specified by:

sliceData in interface Payload

Returns:

payload data.

data

public ByteBuf data()

Description copied from interface: Payload

Returns the Payloads' data without slicing if possible. This is not safe and editing this could effect the payload. It is recommended to call sliceData().

Specified by:

data in interface Payload

Returns:

data as a bytebuf or slice of the data

metadata

public ByteBuf metadata()

Description copied from interface: Payload

Returns the Payloads' metadata without slicing if possible. This is not safe and editing this could effect the payload. It is recommended to call sliceMetadata().

Specified by:

metadata in interface Payload

Returns:

metadata as a bytebuf or slice of the metadata

refCnt

public int refCnt()

Specified by:

refCnt in interface ReferenceCounted

retain

public EmptyPayload retain()

Description copied from interface: Payload

Increases the reference count by 1.

Specified by:

retain in interface ReferenceCounted

Specified by:

retain in interface Payload

retain

public EmptyPayload retain(int increment)

Description copied from interface: Payload

Increases the reference count by the specified increment.

Specified by:

retain in interface ReferenceCounted

Specified by:

retain in interface Payload

touch

public EmptyPayload touch()

Description copied from interface: Payload

Records the current access location of this object for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector. This method is a shortcut to touch(null).

Specified by:

touch in interface ReferenceCounted

Specified by:

touch in interface Payload

touch

public EmptyPayload touch(Object hint)

Description copied from interface: Payload

Records the current access location of this object with an additional arbitrary information for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector.

Specified by:

touch in interface ReferenceCounted

Specified by:

touch in interface Payload

release

public boolean release()

Specified by:

release in interface ReferenceCounted

release

public boolean release(int decrement)

Specified by:

release in interface ReferenceCounted