org.apache.pulsar.client.impl.schema

Class ByteSchema

java.lang.Object

org.apache.pulsar.client.impl.schema.ByteSchema

All Implemented Interfaces:

Schema<Byte>

public class ByteSchema
extends Object

A schema for 'Byte'.

Field Summary

Fields inherited from interface org.apache.pulsar.client.api.Schema

BOOL, BYTEBUFFER, BYTES, DATE, DOUBLE, FLOAT, INT16, INT32, INT64, INT8, STRING, TIME, TIMESTAMP

Constructor Summary

Constructors

Constructor and Description
ByteSchema()

Method Summary

Modifier and Type	Method and Description
Byte	decode(byte[] bytes)
Byte	decode(io.netty.buffer.ByteBuf byteBuf) Decode a byteBuf into an object using the schema definition and deserializer implementation
byte[]	encode(Byte message)
SchemaInfo	getSchemaInfo()
static ByteSchema	of()
void	validate(byte[] message)
void	validate(io.netty.buffer.ByteBuf message) Check if the message read able length length is a valid object for this schema.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.pulsar.client.api.Schema

AUTO_CONSUME, AUTO_PRODUCE_BYTES, AUTO_PRODUCE_BYTES, AUTO, AVRO, AVRO, configureSchemaInfo, decode, generic, getSchema, JSON, JSON, KeyValue, KeyValue, KeyValue, KeyValue, KV_BYTES, PROTOBUF, PROTOBUF, requireFetchingSchemaInfo, setSchemaInfoProvider, supportSchemaVersioning

Constructor Detail

ByteSchema

public ByteSchema()

Method Detail

of

public static ByteSchema of()

validate

public void validate(byte[] message)

validate

public void validate(io.netty.buffer.ByteBuf message)

Check if the message read able length length is a valid object for this schema.

The implementation can choose what its most efficient approach to validate the schema. If the implementation doesn't provide it, it will attempt to use decode(ByteBuf) to see if this schema can decode this message or not as a validation mechanism to verify the bytes.

Parameters:

message - the messages to verify

encode

public byte[] encode(Byte message)

decode

public Byte decode(byte[] bytes)

decode

public Byte decode(io.netty.buffer.ByteBuf byteBuf)

Decode a byteBuf into an object using the schema definition and deserializer implementation

Parameters:

byteBuf - the byte buffer to decode

Returns:

the deserialized object

getSchemaInfo

public SchemaInfo getSchemaInfo()