You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kylin.apache.org by li...@apache.org on 2015/12/31 04:06:34 UTC

kylin git commit: KYLIN-976 Minor document enhancement

Repository: kylin
Updated Branches:
  refs/heads/1.x-HBase1.1.3 a3b8eb049 -> bf8f51ae2


KYLIN-976 Minor document enhancement


Project: http://git-wip-us.apache.org/repos/asf/kylin/repo
Commit: http://git-wip-us.apache.org/repos/asf/kylin/commit/bf8f51ae
Tree: http://git-wip-us.apache.org/repos/asf/kylin/tree/bf8f51ae
Diff: http://git-wip-us.apache.org/repos/asf/kylin/diff/bf8f51ae

Branch: refs/heads/1.x-HBase1.1.3
Commit: bf8f51ae2c5b4474f9bf4e22e083c98701b64fff
Parents: a3b8eb0
Author: Li, Yang <ya...@ebay.com>
Authored: Thu Dec 31 11:05:49 2015 +0800
Committer: Li, Yang <ya...@ebay.com>
Committed: Thu Dec 31 11:05:49 2015 +0800

----------------------------------------------------------------------
 .../kylin/metadata/datatype/DataTypeSerializer.java     | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/kylin/blob/bf8f51ae/metadata/src/main/java/org/apache/kylin/metadata/datatype/DataTypeSerializer.java
----------------------------------------------------------------------
diff --git a/metadata/src/main/java/org/apache/kylin/metadata/datatype/DataTypeSerializer.java b/metadata/src/main/java/org/apache/kylin/metadata/datatype/DataTypeSerializer.java
index 601925b..af4f97f 100644
--- a/metadata/src/main/java/org/apache/kylin/metadata/datatype/DataTypeSerializer.java
+++ b/metadata/src/main/java/org/apache/kylin/metadata/datatype/DataTypeSerializer.java
@@ -66,21 +66,23 @@ abstract public class DataTypeSerializer<T> implements BytesSerializer<T> {
         }
     }
 
-    /** peek into buffer and return the length of serialization */
+    /** Peek into buffer and return the length of serialization which is previously written by this.serialize().
+     *  The current position of input buffer is guaranteed to be at the beginning of the serialization.
+     *  The implementation must not alter the buffer position by its return. */
     abstract public int peekLength(ByteBuffer in);
 
-    /** return the max number of bytes to the longest serialization */
+    /** Return the max number of bytes to the longest possible serialization */
     abstract public int maxLength();
 
-    /** get an estimate of size in bytes of the serialized data */
+    /** Get an estimate of size in bytes of the serialized data */
     abstract public int getStorageBytesEstimate();
 
-    /** an optional convenient method that converts a string to this data type (for dimensions) */
+    /** An optional convenient method that converts a string to this data type (for dimensions) */
     public T valueOf(String str) {
         throw new UnsupportedOperationException();
     }
 
-    /** convert from obj to string */
+    /** Convert from obj to string */
     public String toString(T value) {
         if (value == null)
             return "NULL";