Repository: kylin Updated Branches: refs/heads/2.x-staging a95cef67d -> 95d952da5
KYLIN-976 Minor document enrichment. Project: http://git-wip-us.apache.org/repos/asf/kylin/repo Commit: http://git-wip-us.apache.org/repos/asf/kylin/commit/95d952da Tree: http://git-wip-us.apache.org/repos/asf/kylin/tree/95d952da Diff: http://git-wip-us.apache.org/repos/asf/kylin/diff/95d952da Branch: refs/heads/2.x-staging Commit: 95d952da5b9d8dbb60005235c5c2b42c13a29c78 Parents: a95cef6 Author: Li, Yang <yang...@ebay.com> Authored: Thu Dec 31 10:53:47 2015 +0800 Committer: Li, Yang <yang...@ebay.com> Committed: Thu Dec 31 10:54:23 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/95d952da/core-metadata/src/main/java/org/apache/kylin/metadata/datatype/DataTypeSerializer.java ---------------------------------------------------------------------- diff --git a/core-metadata/src/main/java/org/apache/kylin/metadata/datatype/DataTypeSerializer.java b/core-metadata/src/main/java/org/apache/kylin/metadata/datatype/DataTypeSerializer.java index a66776c..df5513c 100644 --- a/core-metadata/src/main/java/org/apache/kylin/metadata/datatype/DataTypeSerializer.java +++ b/core-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";