DefaultPayload (rsocket-core 1.1.1 API)

java.lang.Object
- io.rsocket.util.DefaultPayload

All Implemented Interfaces:

ReferenceCounted, Payload
```
public final class DefaultPayload
extends Object
implements Payload
```
An implementation of Payload. This implementation is not thread-safe, and hence any method can not be invoked concurrently.

Field Summary

Fields
Modifier and Type Field and Description

static ByteBuffer EMPTY_BUFFER

Fields
Modifier and Type	Field and Description
`static ByteBuffer`	`EMPTY_BUFFER`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Payload`	`create(byte[] data)`
`static Payload`	`create(byte[] data, byte[] metadata)`
`static Payload`	`create(ByteBuf data)`
`static Payload`	`create(ByteBuf data, ByteBuf metadata)`
`static Payload`	`create(ByteBuffer data)`
`static Payload`	`create(ByteBuffer data, ByteBuffer metadata)`
`static Payload`	`create(CharSequence data)` Static factory method for a text payload.
`static Payload`	`create(CharSequence data, CharSequence metadata)` Static factory method for a text payload.
`static Payload`	`create(CharSequence data, Charset dataCharset)`
`static Payload`	`create(CharSequence data, Charset dataCharset, CharSequence metadata, Charset metadataCharset)`
`static Payload`	`create(Payload payload)`
`ByteBuf`	`data()` Returns the Payloads' data without slicing if possible.
`ByteBuffer`	`getData()`
`ByteBuffer`	`getMetadata()`
`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)`
`DefaultPayload`	`retain()` Increases the reference count by `1`.
`DefaultPayload`	`retain(int increment)` Increases the reference count by the specified `increment`.
`ByteBuf`	`sliceData()` Returns the Payload data.
`ByteBuf`	`sliceMetadata()` Returns a slice Payload metadata.
`DefaultPayload`	`touch()` Records the current access location of this object for debugging purposes.
`DefaultPayload`	`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
getDataUtf8, getMetadataUtf8

- Field Detail
  - EMPTY_BUFFER
```
public static final ByteBuffer EMPTY_BUFFER
```
- Method Detail
  - create
```
public static Payload create(CharSequence data)
```
    Static factory method for a text payload. Mainly looks better than "new DefaultPayload(data)"
    
    Parameters:
    
    data - the data of the payload.
    
    Returns:
    
    a payload.
  - create
```
public static Payload create(CharSequence data,
                             @Nullable
                             CharSequence metadata)
```
    Static factory method for a text payload. Mainly looks better than "new DefaultPayload(data, metadata)"
    
    Parameters:
    
    data - the data of the payload.
    
    metadata - the metadata for the payload.
    
    Returns:
    
    a payload.
  - create
```
public static Payload create(CharSequence data,
                             Charset dataCharset)
```
  - create
```
public static Payload create(CharSequence data,
                             Charset dataCharset,
                             @Nullable
                             CharSequence metadata,
                             Charset metadataCharset)
```
  - create
```
public static Payload create(byte[] data)
```
  - create
```
public static Payload create(byte[] data,
                             @Nullable
                             byte[] metadata)
```
  - create
```
public static Payload create(ByteBuffer data)
```
  - create
```
public static Payload create(ByteBuffer data,
                             @Nullable
                             ByteBuffer metadata)
```
  - create
```
public static Payload create(ByteBuf data)
```
  - create
```
public static Payload create(ByteBuf data,
                             @Nullable
                             ByteBuf metadata)
```
  - create
```
public static Payload create(Payload payload)
```
  - 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.
  - getMetadata
```
public ByteBuffer getMetadata()
```
    Specified by:
    
    getMetadata in interface Payload
  - getData
```
public ByteBuffer getData()
```
    Specified by:
    
    getData in interface Payload
  - 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 DefaultPayload 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 DefaultPayload 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 DefaultPayload 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 DefaultPayload 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

Class DefaultPayload

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.rsocket.Payload

Field Detail

EMPTY_BUFFER

Method Detail

create

create

create

create

create

create

create

create

create

create

create

hasMetadata

sliceMetadata

sliceData

getMetadata

getData

data

metadata

refCnt

retain

retain

touch

touch

release

release