blob: f7b87f065290f7efcd9087fe8df150ed3c91823a [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>org.apache.kafka.common.serialization (kafka 3.6.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.kafka.common.serialization">
<meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="package-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li class="nav-bar-cell1-rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html#package">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Package:&nbsp;</li>
<li><a href="#package-description">Description</a>&nbsp;|&nbsp;</li>
<li><a href="#related-package-summary">Related Packages</a>&nbsp;|&nbsp;</li>
<li><a href="#class-summary">Classes and Interfaces</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="Package org.apache.kafka.common.serialization" class="title">Package org.apache.kafka.common.serialization</h1>
</div>
<hr>
<div class="package-signature">package <span class="element-name">org.apache.kafka.common.serialization</span></div>
<section class="package-description" id="package-description">
<div class="block">Provides interface and some implementations of serialization/deserialization routines for various objects.</div>
</section>
<section class="summary">
<ul class="summary-list">
<li>
<div id="related-package-summary">
<div class="caption"><span>Related Packages</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.kafka.common</a></div>
<div class="col-last even-row-color">
<div class="block">Provides shared functionality for Kafka clients and servers.</div>
</div>
</div>
</div>
</li>
<li>
<div id="class-summary">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button></div>
<div id="class-summary.tabpanel" role="tabpanel">
<div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="BooleanDeserializer.html" title="class in org.apache.kafka.common.serialization">BooleanDeserializer</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="BooleanSerializer.html" title="class in org.apache.kafka.common.serialization">BooleanSerializer</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ByteArrayDeserializer.html" title="class in org.apache.kafka.common.serialization">ByteArrayDeserializer</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ByteArraySerializer.html" title="class in org.apache.kafka.common.serialization">ByteArraySerializer</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ByteBufferDeserializer.html" title="class in org.apache.kafka.common.serialization">ByteBufferDeserializer</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ByteBufferSerializer.html" title="class in org.apache.kafka.common.serialization">ByteBufferSerializer</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block"><code>ByteBufferSerializer</code> always <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html#rewind()" title="class or interface in java.nio" class="external-link"><code>rewinds</code></a> the position of the input buffer to zero for
serialization.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="BytesDeserializer.html" title="class in org.apache.kafka.common.serialization">BytesDeserializer</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="BytesSerializer.html" title="class in org.apache.kafka.common.serialization">BytesSerializer</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="Deserializer.html" title="interface in org.apache.kafka.common.serialization">Deserializer</a>&lt;T&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">An interface for converting bytes to objects.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DoubleDeserializer.html" title="class in org.apache.kafka.common.serialization">DoubleDeserializer</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DoubleSerializer.html" title="class in org.apache.kafka.common.serialization">DoubleSerializer</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="FloatDeserializer.html" title="class in org.apache.kafka.common.serialization">FloatDeserializer</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="FloatSerializer.html" title="class in org.apache.kafka.common.serialization">FloatSerializer</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="IntegerDeserializer.html" title="class in org.apache.kafka.common.serialization">IntegerDeserializer</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="IntegerSerializer.html" title="class in org.apache.kafka.common.serialization">IntegerSerializer</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ListDeserializer.html" title="class in org.apache.kafka.common.serialization">ListDeserializer</a>&lt;Inner&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ListSerializer.html" title="class in org.apache.kafka.common.serialization">ListSerializer</a>&lt;Inner&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="LongDeserializer.html" title="class in org.apache.kafka.common.serialization">LongDeserializer</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="LongSerializer.html" title="class in org.apache.kafka.common.serialization">LongSerializer</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a>&lt;T&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">The interface for wrapping a serializer and deserializer for the given data type.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Serdes.html" title="class in org.apache.kafka.common.serialization">Serdes</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Factory for creating serializers / deserializers.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Serdes.BooleanSerde.html" title="class in org.apache.kafka.common.serialization">Serdes.BooleanSerde</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Serdes.ByteArraySerde.html" title="class in org.apache.kafka.common.serialization">Serdes.ByteArraySerde</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Serdes.ByteBufferSerde.html" title="class in org.apache.kafka.common.serialization">Serdes.ByteBufferSerde</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Serdes.BytesSerde.html" title="class in org.apache.kafka.common.serialization">Serdes.BytesSerde</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Serdes.DoubleSerde.html" title="class in org.apache.kafka.common.serialization">Serdes.DoubleSerde</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Serdes.FloatSerde.html" title="class in org.apache.kafka.common.serialization">Serdes.FloatSerde</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Serdes.IntegerSerde.html" title="class in org.apache.kafka.common.serialization">Serdes.IntegerSerde</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Serdes.ListSerde.html" title="class in org.apache.kafka.common.serialization">Serdes.ListSerde</a>&lt;Inner&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Serdes.LongSerde.html" title="class in org.apache.kafka.common.serialization">Serdes.LongSerde</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Serdes.ShortSerde.html" title="class in org.apache.kafka.common.serialization">Serdes.ShortSerde</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Serdes.StringSerde.html" title="class in org.apache.kafka.common.serialization">Serdes.StringSerde</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Serdes.UUIDSerde.html" title="class in org.apache.kafka.common.serialization">Serdes.UUIDSerde</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Serdes.VoidSerde.html" title="class in org.apache.kafka.common.serialization">Serdes.VoidSerde</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Serdes.WrapperSerde.html" title="class in org.apache.kafka.common.serialization">Serdes.WrapperSerde</a>&lt;T&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Serializer.html" title="interface in org.apache.kafka.common.serialization">Serializer</a>&lt;T&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">An interface for converting objects to bytes.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ShortDeserializer.html" title="class in org.apache.kafka.common.serialization">ShortDeserializer</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ShortSerializer.html" title="class in org.apache.kafka.common.serialization">ShortSerializer</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="StringDeserializer.html" title="class in org.apache.kafka.common.serialization">StringDeserializer</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">String encoding defaults to UTF8 and can be customized by setting the property key.deserializer.encoding,
value.deserializer.encoding or deserializer.encoding.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="StringSerializer.html" title="class in org.apache.kafka.common.serialization">StringSerializer</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">String encoding defaults to UTF8 and can be customized by setting the property key.serializer.encoding,
value.serializer.encoding or serializer.encoding.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="UUIDDeserializer.html" title="class in org.apache.kafka.common.serialization">UUIDDeserializer</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">We are converting the byte array to String before deserializing to UUID.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="UUIDSerializer.html" title="class in org.apache.kafka.common.serialization">UUIDSerializer</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">We are converting UUID to String before serializing.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="VoidDeserializer.html" title="class in org.apache.kafka.common.serialization">VoidDeserializer</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="VoidSerializer.html" title="class in org.apache.kafka.common.serialization">VoidSerializer</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
</div>
</div>
</div>
</li>
</ul>
</section>
</main>
</div>
</div>
</body>
</html>