Repository: kylin Updated Branches: refs/heads/1.x-staging abd53e124 -> 109779a80
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/109779a8 Tree: http://git-wip-us.apache.org/repos/asf/kylin/tree/109779a8 Diff: http://git-wip-us.apache.org/repos/asf/kylin/diff/109779a8 Branch: refs/heads/1.x-staging Commit: 109779a80e5aceb452eb15d341951623f010befb Parents: abd53e1 Author: Li, Yang <yang...@ebay.com> Authored: Thu Dec 31 11:05:49 2015 +0800 Committer: Yang Li <liy...@apache.org> Committed: Sun Jan 10 07:17:06 2016 +0800 ---------------------------------------------------------------------- .../kylin/metadata/datatype/DataTypeSerializer.java | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/kylin/blob/109779a8/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";
