Return-Path: X-Original-To: apmail-kafka-commits-archive@www.apache.org Delivered-To: apmail-kafka-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 5D77318233 for ; Fri, 2 Oct 2015 19:19:07 +0000 (UTC) Received: (qmail 42993 invoked by uid 500); 2 Oct 2015 19:19:01 -0000 Delivered-To: apmail-kafka-commits-archive@kafka.apache.org Received: (qmail 42942 invoked by uid 500); 2 Oct 2015 19:19:01 -0000 Mailing-List: contact commits-help@kafka.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@kafka.apache.org Delivered-To: mailing list commits@kafka.apache.org Received: (qmail 40632 invoked by uid 99); 2 Oct 2015 19:19:00 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 02 Oct 2015 19:19:00 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id CDA51E1577; Fri, 2 Oct 2015 19:18:59 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: gwenshap@apache.org To: commits@kafka.apache.org Date: Fri, 02 Oct 2015 19:19:32 -0000 Message-Id: In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [34/51] [partial] kafka-site git commit: KAFKA-2425: Initial upload of Kafka documentation to git repository with intent to replace SVN http://git-wip-us.apache.org/repos/asf/kafka-site/blob/ba6c994c/082/javadoc/org/apache/kafka/common/serialization/ByteArrayDeserializer.html ---------------------------------------------------------------------- diff --git a/082/javadoc/org/apache/kafka/common/serialization/ByteArrayDeserializer.html b/082/javadoc/org/apache/kafka/common/serialization/ByteArrayDeserializer.html new file mode 100644 index 0000000..31b2a3d --- /dev/null +++ b/082/javadoc/org/apache/kafka/common/serialization/ByteArrayDeserializer.html @@ -0,0 +1,311 @@ + + + + + + +ByteArrayDeserializer (clients 0.8.2.0 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.apache.kafka.common.serialization +
+Class ByteArrayDeserializer

+
+java.lang.Object
+  extended by org.apache.kafka.common.serialization.ByteArrayDeserializer
+
+
+
All Implemented Interfaces:
Deserializer<byte[]>
+
+
+
+
public class ByteArrayDeserializer
extends java.lang.Object
implements Deserializer<byte[]>
+ + +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
ByteArrayDeserializer() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidclose() + +
+          Close this deserializer
+ voidconfigure(java.util.Map<java.lang.String,?> configs, + boolean isKey) + +
+          Configure this class.
+ byte[]deserialize(java.lang.String topic, + byte[] data) + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ByteArrayDeserializer

+
+public ByteArrayDeserializer()
+
+
+ + + + + + + + +
+Method Detail
+ +

+configure

+
+public void configure(java.util.Map<java.lang.String,?> configs,
+                      boolean isKey)
+
+
Description copied from interface: Deserializer
+
Configure this class. +

+

+
Specified by:
configure in interface Deserializer<byte[]>
+
+
+
Parameters:
configs - configs in key/value pairs
isKey - whether is for key or value
+
+
+
+ +

+deserialize

+
+public byte[] deserialize(java.lang.String topic,
+                          byte[] data)
+
+
+
Specified by:
deserialize in interface Deserializer<byte[]>
+
+
+
Parameters:
topic - topic associated with the data
data - serialized bytes +
Returns:
deserialized object
+
+
+
+ +

+close

+
+public void close()
+
+
Description copied from interface: Deserializer
+
Close this deserializer +

+

+
Specified by:
close in interface Deserializer<byte[]>
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + http://git-wip-us.apache.org/repos/asf/kafka-site/blob/ba6c994c/082/javadoc/org/apache/kafka/common/serialization/ByteArraySerializer.html ---------------------------------------------------------------------- diff --git a/082/javadoc/org/apache/kafka/common/serialization/ByteArraySerializer.html b/082/javadoc/org/apache/kafka/common/serialization/ByteArraySerializer.html new file mode 100644 index 0000000..c9876e5 --- /dev/null +++ b/082/javadoc/org/apache/kafka/common/serialization/ByteArraySerializer.html @@ -0,0 +1,311 @@ + + + + + + +ByteArraySerializer (clients 0.8.2.0 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.apache.kafka.common.serialization +
+Class ByteArraySerializer

+
+java.lang.Object
+  extended by org.apache.kafka.common.serialization.ByteArraySerializer
+
+
+
All Implemented Interfaces:
Serializer<byte[]>
+
+
+
+
public class ByteArraySerializer
extends java.lang.Object
implements Serializer<byte[]>
+ + +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
ByteArraySerializer() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidclose() + +
+          Close this serializer
+ voidconfigure(java.util.Map<java.lang.String,?> configs, + boolean isKey) + +
+          Configure this class.
+ byte[]serialize(java.lang.String topic, + byte[] data) + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ByteArraySerializer

+
+public ByteArraySerializer()
+
+
+ + + + + + + + +
+Method Detail
+ +

+configure

+
+public void configure(java.util.Map<java.lang.String,?> configs,
+                      boolean isKey)
+
+
Description copied from interface: Serializer
+
Configure this class. +

+

+
Specified by:
configure in interface Serializer<byte[]>
+
+
+
Parameters:
configs - configs in key/value pairs
isKey - whether is for key or value
+
+
+
+ +

+serialize

+
+public byte[] serialize(java.lang.String topic,
+                        byte[] data)
+
+
+
Specified by:
serialize in interface Serializer<byte[]>
+
+
+
Parameters:
topic - topic associated with data
data - typed data +
Returns:
serialized bytes
+
+
+
+ +

+close

+
+public void close()
+
+
Description copied from interface: Serializer
+
Close this serializer +

+

+
Specified by:
close in interface Serializer<byte[]>
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + http://git-wip-us.apache.org/repos/asf/kafka-site/blob/ba6c994c/082/javadoc/org/apache/kafka/common/serialization/Deserializer.html ---------------------------------------------------------------------- diff --git a/082/javadoc/org/apache/kafka/common/serialization/Deserializer.html b/082/javadoc/org/apache/kafka/common/serialization/Deserializer.html new file mode 100644 index 0000000..9630202 --- /dev/null +++ b/082/javadoc/org/apache/kafka/common/serialization/Deserializer.html @@ -0,0 +1,258 @@ + + + + + + +Deserializer (clients 0.8.2.0 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.apache.kafka.common.serialization +
+Interface Deserializer<T>

+
+
Type Parameters:
T - Type to be deserialized into. + + A class that implements this interface is expected to have a constructor with no parameter.
+
+
All Known Implementing Classes:
ByteArrayDeserializer, StringDeserializer
+
+
+
+
public interface Deserializer<T>
+ + +

+

+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidclose() + +
+          Close this deserializer
+ voidconfigure(java.util.Map<java.lang.String,?> configs, + boolean isKey) + +
+          Configure this class.
+ Tdeserialize(java.lang.String topic, + byte[] data) + +
+           
+  +

+ + + + + + + + +
+Method Detail
+ +

+configure

+
+void configure(java.util.Map<java.lang.String,?> configs,
+               boolean isKey)
+
+
Configure this class. +

+

+
Parameters:
configs - configs in key/value pairs
isKey - whether is for key or value
+
+
+
+ +

+deserialize

+
+T deserialize(java.lang.String topic,
+              byte[] data)
+
+
+
Parameters:
topic - topic associated with the data
data - serialized bytes +
Returns:
deserialized object
+
+
+
+ +

+close

+
+void close()
+
+
Close this deserializer +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + http://git-wip-us.apache.org/repos/asf/kafka-site/blob/ba6c994c/082/javadoc/org/apache/kafka/common/serialization/Serializer.html ---------------------------------------------------------------------- diff --git a/082/javadoc/org/apache/kafka/common/serialization/Serializer.html b/082/javadoc/org/apache/kafka/common/serialization/Serializer.html new file mode 100644 index 0000000..a5c700b --- /dev/null +++ b/082/javadoc/org/apache/kafka/common/serialization/Serializer.html @@ -0,0 +1,258 @@ + + + + + + +Serializer (clients 0.8.2.0 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.apache.kafka.common.serialization +
+Interface Serializer<T>

+
+
Type Parameters:
T - Type to be serialized from. + + A class that implements this interface is expected to have a constructor with no parameter.
+
+
All Known Implementing Classes:
ByteArraySerializer, StringSerializer
+
+
+
+
public interface Serializer<T>
+ + +

+

+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidclose() + +
+          Close this serializer
+ voidconfigure(java.util.Map<java.lang.String,?> configs, + boolean isKey) + +
+          Configure this class.
+ byte[]serialize(java.lang.String topic, + T data) + +
+           
+  +

+ + + + + + + + +
+Method Detail
+ +

+configure

+
+void configure(java.util.Map<java.lang.String,?> configs,
+               boolean isKey)
+
+
Configure this class. +

+

+
Parameters:
configs - configs in key/value pairs
isKey - whether is for key or value
+
+
+
+ +

+serialize

+
+byte[] serialize(java.lang.String topic,
+                 T data)
+
+
+
Parameters:
topic - topic associated with data
data - typed data +
Returns:
serialized bytes
+
+
+
+ +

+close

+
+void close()
+
+
Close this serializer +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + http://git-wip-us.apache.org/repos/asf/kafka-site/blob/ba6c994c/082/javadoc/org/apache/kafka/common/serialization/StringDeserializer.html ---------------------------------------------------------------------- diff --git a/082/javadoc/org/apache/kafka/common/serialization/StringDeserializer.html b/082/javadoc/org/apache/kafka/common/serialization/StringDeserializer.html new file mode 100644 index 0000000..7901bca --- /dev/null +++ b/082/javadoc/org/apache/kafka/common/serialization/StringDeserializer.html @@ -0,0 +1,316 @@ + + + + + + +StringDeserializer (clients 0.8.2.0 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.apache.kafka.common.serialization +
+Class StringDeserializer

+
+java.lang.Object
+  extended by org.apache.kafka.common.serialization.StringDeserializer
+
+
+
All Implemented Interfaces:
Deserializer<java.lang.String>
+
+
+
+
public class StringDeserializer
extends java.lang.Object
implements Deserializer<java.lang.String>
+ + +

+String encoding defaults to UTF8 and can be customized by setting the property key.deserializer.encoding, + value.deserializer.encoding or deserializer.encoding. The first two take precedence over the last. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
StringDeserializer() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidclose() + +
+          Close this deserializer
+ voidconfigure(java.util.Map<java.lang.String,?> configs, + boolean isKey) + +
+          Configure this class.
+ java.lang.Stringdeserialize(java.lang.String topic, + byte[] data) + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+StringDeserializer

+
+public StringDeserializer()
+
+
+ + + + + + + + +
+Method Detail
+ +

+configure

+
+public void configure(java.util.Map<java.lang.String,?> configs,
+                      boolean isKey)
+
+
Description copied from interface: Deserializer
+
Configure this class. +

+

+
Specified by:
configure in interface Deserializer<java.lang.String>
+
+
+
Parameters:
configs - configs in key/value pairs
isKey - whether is for key or value
+
+
+
+ +

+deserialize

+
+public java.lang.String deserialize(java.lang.String topic,
+                                    byte[] data)
+
+
+
Specified by:
deserialize in interface Deserializer<java.lang.String>
+
+
+
Parameters:
topic - topic associated with the data
data - serialized bytes +
Returns:
deserialized object
+
+
+
+ +

+close

+
+public void close()
+
+
Description copied from interface: Deserializer
+
Close this deserializer +

+

+
Specified by:
close in interface Deserializer<java.lang.String>
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + http://git-wip-us.apache.org/repos/asf/kafka-site/blob/ba6c994c/082/javadoc/org/apache/kafka/common/serialization/StringSerializer.html ---------------------------------------------------------------------- diff --git a/082/javadoc/org/apache/kafka/common/serialization/StringSerializer.html b/082/javadoc/org/apache/kafka/common/serialization/StringSerializer.html new file mode 100644 index 0000000..5f4fb34 --- /dev/null +++ b/082/javadoc/org/apache/kafka/common/serialization/StringSerializer.html @@ -0,0 +1,316 @@ + + + + + + +StringSerializer (clients 0.8.2.0 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.apache.kafka.common.serialization +
+Class StringSerializer

+
+java.lang.Object
+  extended by org.apache.kafka.common.serialization.StringSerializer
+
+
+
All Implemented Interfaces:
Serializer<java.lang.String>
+
+
+
+
public class StringSerializer
extends java.lang.Object
implements Serializer<java.lang.String>
+ + +

+String encoding defaults to UTF8 and can be customized by setting the property key.serializer.encoding, + value.serializer.encoding or serializer.encoding. The first two take precedence over the last. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
StringSerializer() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidclose() + +
+          Close this serializer
+ voidconfigure(java.util.Map<java.lang.String,?> configs, + boolean isKey) + +
+          Configure this class.
+ byte[]serialize(java.lang.String topic, + java.lang.String data) + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+StringSerializer

+
+public StringSerializer()
+
+
+ + + + + + + + +
+Method Detail
+ +

+configure

+
+public void configure(java.util.Map<java.lang.String,?> configs,
+                      boolean isKey)
+
+
Description copied from interface: Serializer
+
Configure this class. +

+

+
Specified by:
configure in interface Serializer<java.lang.String>
+
+
+
Parameters:
configs - configs in key/value pairs
isKey - whether is for key or value
+
+
+
+ +

+serialize

+
+public byte[] serialize(java.lang.String topic,
+                        java.lang.String data)
+
+
+
Specified by:
serialize in interface Serializer<java.lang.String>
+
+
+
Parameters:
topic - topic associated with data
data - typed data +
Returns:
serialized bytes
+
+
+
+ +

+close

+
+public void close()
+
+
Description copied from interface: Serializer
+
Close this serializer +

+

+
Specified by:
close in interface Serializer<java.lang.String>
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + http://git-wip-us.apache.org/repos/asf/kafka-site/blob/ba6c994c/082/javadoc/org/apache/kafka/common/serialization/package-frame.html ---------------------------------------------------------------------- diff --git a/082/javadoc/org/apache/kafka/common/serialization/package-frame.html b/082/javadoc/org/apache/kafka/common/serialization/package-frame.html new file mode 100644 index 0000000..48decc3 --- /dev/null +++ b/082/javadoc/org/apache/kafka/common/serialization/package-frame.html @@ -0,0 +1,51 @@ + + + + + + +org.apache.kafka.common.serialization (clients 0.8.2.0 API) + + + + + + + + + + + +org.apache.kafka.common.serialization + + + + +
+Interfaces  + +
+Deserializer +
+Serializer
+ + + + + + +
+Classes  + +
+ByteArrayDeserializer +
+ByteArraySerializer +
+StringDeserializer +
+StringSerializer
+ + + +