Class FullBulkStringRedisMessage

java.lang.Object

io.netty.buffer.DefaultByteBufHolder

io.netty.handler.codec.redis.FullBulkStringRedisMessage

All Implemented Interfaces:

ByteBufHolder, BulkStringRedisContent, LastBulkStringRedisContent, RedisMessage, ReferenceCounted

@UnstableApi
public class FullBulkStringRedisMessage
extends DefaultByteBufHolder
implements LastBulkStringRedisContent

An aggregated bulk string of RESP.

Field Summary

Fields

Modifier and Type	Field	Description
static final FullBulkStringRedisMessage	EMPTY_INSTANCE	A predefined empty instance of FullBulkStringRedisMessage.
static final FullBulkStringRedisMessage	NULL_INSTANCE	A predefined null instance of FullBulkStringRedisMessage.

Fields inherited from interface LastBulkStringRedisContent

EMPTY_LAST_CONTENT

Modifier and Type	Field	Description
static final LastBulkStringRedisContent	EMPTY_LAST_CONTENT	The 'end of content' marker in chunked encoding.

Constructor Summary

Constructors

Constructor	Description
FullBulkStringRedisMessage(ByteBuf content)	Creates a FullBulkStringRedisMessage for the given content.

Method Summary

Modifier and Type	Method	Description
FullBulkStringRedisMessage	copy()	Creates a deep copy of this ByteBufHolder.
FullBulkStringRedisMessage	duplicate()	Duplicates this ByteBufHolder.
boolean	isNull()	Returns whether the content of this message is null.
FullBulkStringRedisMessage	replace(ByteBuf content)	Returns a new ByteBufHolder which contains the specified content.
FullBulkStringRedisMessage	retain()	Increases the reference count by 1.
FullBulkStringRedisMessage	retain(int increment)	Increases the reference count by the specified increment.
FullBulkStringRedisMessage	retainedDuplicate()	Duplicates this ByteBufHolder.
String	toString()
FullBulkStringRedisMessage	touch()	Records the current access location of this object for debugging purposes.
FullBulkStringRedisMessage	touch(Object hint)	Records the current access location of this object with an additional arbitrary information for debugging purposes.

Methods inherited from class DefaultByteBufHolder

content, contentToString, equals, hashCode, refCnt, release, release

Modifier and Type	Method	Description
ByteBuf	content()	Return the data which is held by this ByteBufHolder.
protected final String	contentToString()	Return ByteBuf.toString() without checking the reference count first.
boolean	equals(Object o)	This implementation of the equals operation is restricted to work only with instances of the same class.
int	hashCode()
int	refCnt()	Returns the reference count of this object.
boolean	release()	Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.
boolean	release(int decrement)	Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.

Methods inherited from class Object

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

Field Details

NULL_INSTANCE

public static final FullBulkStringRedisMessage NULL_INSTANCE

A predefined null instance of FullBulkStringRedisMessage.

EMPTY_INSTANCE

public static final FullBulkStringRedisMessage EMPTY_INSTANCE

A predefined empty instance of FullBulkStringRedisMessage.

Constructor Details

FullBulkStringRedisMessage

public FullBulkStringRedisMessage(ByteBuf content)

Creates a FullBulkStringRedisMessage for the given content.

Parameters:

content - the content, must not be null. If content is null or empty, use NULL_INSTANCE or EMPTY_INSTANCE instead of constructor.

Method Details

isNull

public boolean isNull()

Returns whether the content of this message is null.

Returns:

indicates whether the content of this message is null.

toString

public String toString()

Overrides:

toString in class DefaultByteBufHolder

copy

public FullBulkStringRedisMessage copy()

Description copied from class: DefaultByteBufHolder

Creates a deep copy of this ByteBufHolder.

This method calls replace(content().copy()) by default.

Specified by:

copy in interface BulkStringRedisContent

Specified by:

copy in interface ByteBufHolder

Specified by:

copy in interface LastBulkStringRedisContent

Overrides:

copy in class DefaultByteBufHolder

duplicate

public FullBulkStringRedisMessage duplicate()

Description copied from class: DefaultByteBufHolder

Duplicates this ByteBufHolder. Be aware that this will not automatically call ByteBufHolder.retain().

This method calls replace(content().duplicate()) by default.

Specified by:

duplicate in interface BulkStringRedisContent

Specified by:

duplicate in interface ByteBufHolder

Specified by:

duplicate in interface LastBulkStringRedisContent

Overrides:

duplicate in class DefaultByteBufHolder

retainedDuplicate

public FullBulkStringRedisMessage retainedDuplicate()

Description copied from class: DefaultByteBufHolder

Duplicates this ByteBufHolder. This method returns a retained duplicate unlike ByteBufHolder.duplicate().

This method calls replace(content().retainedDuplicate()) by default.

Specified by:

retainedDuplicate in interface BulkStringRedisContent

Specified by:

retainedDuplicate in interface ByteBufHolder

Specified by:

retainedDuplicate in interface LastBulkStringRedisContent

Overrides:

retainedDuplicate in class DefaultByteBufHolder

See Also:

• ByteBuf.retainedDuplicate()

replace

public FullBulkStringRedisMessage replace(ByteBuf content)

Description copied from class: DefaultByteBufHolder

Returns a new ByteBufHolder which contains the specified content.

Override this method to return a new instance of this object whose content is set to the specified content. The default implementation of DefaultByteBufHolder.copy(), DefaultByteBufHolder.duplicate() and DefaultByteBufHolder.retainedDuplicate() invokes this method to create a copy.

Specified by:

replace in interface BulkStringRedisContent

Specified by:

replace in interface ByteBufHolder

Specified by:

replace in interface LastBulkStringRedisContent

Overrides:

replace in class DefaultByteBufHolder

retain

public FullBulkStringRedisMessage retain()

Description copied from interface: ReferenceCounted

Increases the reference count by 1.

Specified by:

retain in interface BulkStringRedisContent

Specified by:

retain in interface ByteBufHolder

Specified by:

retain in interface LastBulkStringRedisContent

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class DefaultByteBufHolder

retain

public FullBulkStringRedisMessage retain(int increment)

Description copied from interface: ReferenceCounted

Increases the reference count by the specified increment.

Specified by:

retain in interface BulkStringRedisContent

Specified by:

retain in interface ByteBufHolder

Specified by:

retain in interface LastBulkStringRedisContent

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class DefaultByteBufHolder

touch

public FullBulkStringRedisMessage touch()

Description copied from interface: ReferenceCounted

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 BulkStringRedisContent

Specified by:

touch in interface ByteBufHolder

Specified by:

touch in interface LastBulkStringRedisContent

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class DefaultByteBufHolder

touch

public FullBulkStringRedisMessage touch(Object hint)

Description copied from interface: ReferenceCounted

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 BulkStringRedisContent

Specified by:

touch in interface ByteBufHolder

Specified by:

touch in interface LastBulkStringRedisContent

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class DefaultByteBufHolder