org.apache.ignite.internal.binary

Class BinaryUtils

java.lang.Object

org.apache.ignite.internal.binary.BinaryUtils

public class BinaryUtils
extends Object

Binary utils.

Field Summary

Fields

Modifier and Type	Field and Description
static int	FIELD_ID_LEN Field ID length.
static short	FLAG_COMPACT_FOOTER Flag: compact footer, no field IDs.
static short	FLAG_HAS_RAW Flag indicating that object has raw data.
static short	FLAG_HAS_SCHEMA Flag: only raw data exists.
static short	FLAG_OFFSET_ONE_BYTE Flag: offsets take 1 byte.
static short	FLAG_OFFSET_TWO_BYTES Flag: offsets take 2 bytes.
static Map<Byte,Class<?>>	FLAG_TO_CLASS
static short	FLAG_USR_TYP Flag: user type.
static int	OFFSET_1 Offset which fits into 1 byte.
static int	OFFSET_2 Offset which fits into 2 bytes.
static int	OFFSET_4 Offset which fits into 4 bytes.
static Map<Class<?>,Byte>	PLAIN_CLASS_TO_FLAG

Constructor Summary

Constructors

Constructor and Description
BinaryUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static void	checkProtocolVersion(byte protoVer) Check protocol version.
static BinaryObject	doReadBinaryObject(BinaryInputStream in, BinaryContext ctx)
static boolean[]	doReadBooleanArray(BinaryInputStream in)
static byte[]	doReadByteArray(BinaryInputStream in)
static char[]	doReadCharArray(BinaryInputStream in)
static Class	doReadClass(BinaryInputStream in, BinaryContext ctx, ClassLoader ldr)
static Class	doReadClass(BinaryInputStream in, BinaryContext ctx, ClassLoader ldr, int typeId)
static Collection<?>	doReadCollection(BinaryInputStream in, BinaryContext ctx, ClassLoader ldr, BinaryReaderHandlesHolder handles, boolean deserialize, BinaryCollectionFactory factory)
static Date	doReadDate(BinaryInputStream in)
static Date[]	doReadDateArray(BinaryInputStream in)
static BigDecimal	doReadDecimal(BinaryInputStream in)
static BigDecimal[]	doReadDecimalArray(BinaryInputStream in)
static double[]	doReadDoubleArray(BinaryInputStream in)
static Enum<?>	doReadEnum(BinaryInputStream in, Class<?> cls) Having target class in place we simply read ordinal and create final representation.
static Object[]	doReadEnumArray(BinaryInputStream in, BinaryContext ctx, ClassLoader ldr, Class<?> cls)
static float[]	doReadFloatArray(BinaryInputStream in)
static int[]	doReadIntArray(BinaryInputStream in)
static long[]	doReadLongArray(BinaryInputStream in)
static Map<?,?>	doReadMap(BinaryInputStream in, BinaryContext ctx, ClassLoader ldr, BinaryReaderHandlesHolder handles, boolean deserialize, BinaryMapFactory factory)
static Object	doReadObject(BinaryInputStream in, BinaryContext ctx, ClassLoader ldr, BinaryReaderHandlesHolder handles)
static Object[]	doReadObjectArray(BinaryInputStream in, BinaryContext ctx, ClassLoader ldr, BinaryReaderHandlesHolder handles, boolean deserialize)
static Object	doReadOptimized(BinaryInputStream in, BinaryContext ctx, ClassLoader clsLdr) Read object serialized using optimized marshaller.
static short[]	doReadShortArray(BinaryInputStream in)
static String	doReadString(BinaryInputStream in)
static String[]	doReadStringArray(BinaryInputStream in)
static Timestamp	doReadTimestamp(BinaryInputStream in)
static Timestamp[]	doReadTimestampArray(BinaryInputStream in)
static UUID	doReadUuid(BinaryInputStream in)
static UUID[]	doReadUuidArray(BinaryInputStream in)
static int	fieldIdLength(short flags) Get field ID length.
static int	fieldOffsetLength(short flags) Get offset length for the given flags.
static int	fieldOffsetRelative(BinaryPositionReadable stream, int pos, int fieldOffsetSize) Get relative field offset.
static int	fieldTypeId(String typeName)
static String	fieldTypeName(int typeId)
static IgniteBiTuple<Integer,Integer>	footerAbsolute(BinaryPositionReadable in, int start) Get object's footer.
static int	footerStartAbsolute(BinaryPositionReadable in, int start) Get object's footer.
static int	footerStartRelative(BinaryPositionReadable in, int start) Get footer start of the object.
static boolean	hasRaw(short flags) Check if raw-only flag is set.
static boolean	hasSchema(short flags) Check if raw-only flag is set.
static boolean	isBinarylizable(Class cls) Check if class is binarylizable.
static boolean	isBinaryType(Class<?> cls) Tells whether provided type is binary.
static boolean	isCompactFooter(short flags) Check if "no-field-ids" flag is set.
static boolean	isCustomJavaSerialization(Class cls) Determines whether class contains custom Java serialization logic.
static boolean	isPlainArrayType(int type) Checks whether an array type values can or can not contain references to other object.
static boolean	isPlainType(int type)
static boolean	isUserType(short flags) Check if user type flag is set.
static int	length(BinaryPositionReadable in, int start) Get binary object length.
static BinaryMetadata	mergeMetadata(BinaryMetadata oldMeta, BinaryMetadata newMeta) Merge old and new metas.
static BinaryWriteMode	mode(Class<?> cls)
static <K,V> Map<K,V>	newMap(Map<K,V> map) Attempts to create a new map of the same type as map has.
static <V> Set<V>	newSet(Set<V> set) Attempts to create a new set of the same type as set has.
static int	positionForHandle(BinaryInputStream in) Get position to be used for handle.
static String	qualifiedFieldName(Class cls, String fieldName) Create qualified field name.
static int	rawOffsetAbsolute(BinaryPositionReadable in, int start) Get absolute raw offset of the object.
static int	rawOffsetRelative(BinaryPositionReadable in, int start) Get relative raw offset of the object.
static Class	resolveClass(BinaryContext ctx, int typeId, String clsName, ClassLoader ldr, boolean deserialize) Resolve the class.
static int	schemaInitialId() Schema initial ID.
static byte	typeByClass(Class<?> cls)
static Object	unmarshal(BinaryInputStream in, BinaryContext ctx, ClassLoader ldr)
static Object	unmarshal(BinaryInputStream in, BinaryContext ctx, ClassLoader ldr, BinaryReaderHandlesHolder handles)
static Object	unmarshal(BinaryInputStream in, BinaryContext ctx, ClassLoader ldr, BinaryReaderHandlesHolder handles, boolean detach)
static Object	unwrapLazy(Object obj)
static Iterator<Object>	unwrapLazyIterator(Iterator<Object> delegate)
static int	updateSchemaId(int schemaId, int fieldId) Update schema ID when new field is added.
static void	writePlainObject(BinaryWriterExImpl writer, Object val) Write value with flag. e.g. writePlainObject(writer, (byte)77) will write two byte: {BYTE, 77}.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PLAIN_CLASS_TO_FLAG

public static final Map<Class<?>,Byte> PLAIN_CLASS_TO_FLAG

FLAG_TO_CLASS

public static final Map<Byte,Class<?>> FLAG_TO_CLASS

FLAG_USR_TYP

public static final short FLAG_USR_TYP

Flag: user type.

See Also:

Constant Field Values

FLAG_HAS_SCHEMA

public static final short FLAG_HAS_SCHEMA

Flag: only raw data exists.

See Also:

Constant Field Values

FLAG_HAS_RAW

public static final short FLAG_HAS_RAW

Flag indicating that object has raw data.

See Also:

Constant Field Values

FLAG_OFFSET_ONE_BYTE

public static final short FLAG_OFFSET_ONE_BYTE

Flag: offsets take 1 byte.

See Also:

Constant Field Values

FLAG_OFFSET_TWO_BYTES

public static final short FLAG_OFFSET_TWO_BYTES

Flag: offsets take 2 bytes.

See Also:

Constant Field Values

FLAG_COMPACT_FOOTER

public static final short FLAG_COMPACT_FOOTER

Flag: compact footer, no field IDs.

See Also:

Constant Field Values

OFFSET_1

public static final int OFFSET_1

Offset which fits into 1 byte.

See Also:

Constant Field Values

OFFSET_2

public static final int OFFSET_2

Offset which fits into 2 bytes.

See Also:

Constant Field Values

OFFSET_4

public static final int OFFSET_4

Offset which fits into 4 bytes.

See Also:

Constant Field Values

FIELD_ID_LEN

public static final int FIELD_ID_LEN

Field ID length.

See Also:

Constant Field Values

Constructor Detail

BinaryUtils

public BinaryUtils()

Method Detail

isUserType

public static boolean isUserType(short flags)

Check if user type flag is set.

Parameters:

flags - Flags.

Returns:

True if set.

hasSchema

public static boolean hasSchema(short flags)

Check if raw-only flag is set.

Parameters:

flags - Flags.

Returns:

True if set.

hasRaw

public static boolean hasRaw(short flags)

Check if raw-only flag is set.

Parameters:

flags - Flags.

Returns:

True if set.

isCompactFooter

public static boolean isCompactFooter(short flags)

Check if "no-field-ids" flag is set.

Parameters:

flags - Flags.

Returns:

True if set.

schemaInitialId

public static int schemaInitialId()

Schema initial ID.

Returns:

ID.

updateSchemaId

public static int updateSchemaId(int schemaId,
                 int fieldId)

Update schema ID when new field is added.

Parameters:

schemaId - Current schema ID.

fieldId - Field ID.

Returns:

New schema ID.

fieldTypeId

public static int fieldTypeId(String typeName)

Parameters:

typeName - Field type name.

Returns:

Field type ID;

fieldTypeName

public static String fieldTypeName(int typeId)

Parameters:

typeId - Field type ID.

Returns:

Field type name.

writePlainObject

public static void writePlainObject(BinaryWriterExImpl writer,
                    Object val)

Write value with flag. e.g. writePlainObject(writer, (byte)77) will write two byte: {BYTE, 77}.

Parameters:

writer - W

val - Value.

unwrapLazy

public static Object unwrapLazy(@Nullable
                Object obj)

Parameters:

obj - Value to unwrap.

Returns:

Unwrapped value.

unwrapLazyIterator

public static Iterator<Object> unwrapLazyIterator(Iterator<Object> delegate)

Parameters:

delegate - Iterator to delegate.

Returns:

New iterator.

isPlainType

public static boolean isPlainType(int type)

Returns:

true if content of serialized value cannot contain references to other object.

isPlainArrayType

public static boolean isPlainArrayType(int type)

Checks whether an array type values can or can not contain references to other object.

Parameters:

type - Array type.

Returns:

true if content of serialized array value cannot contain references to other object.

typeByClass

public static byte typeByClass(Class<?> cls)

Parameters:

cls - Class.

Returns:

Binary field type.

isBinaryType

public static boolean isBinaryType(Class<?> cls)

Tells whether provided type is binary.

Parameters:

cls - Class to check.

Returns:

Whether type is binary.

newMap

public static <K,V> Map<K,V> newMap(Map<K,V> map)

Attempts to create a new map of the same type as map has. Otherwise returns new HashMap instance.

Parameters:

map - Original map.

Returns:

New map.

newSet

public static <V> Set<V> newSet(Set<V> set)

Attempts to create a new set of the same type as set has. Otherwise returns new HashSet instance.

Parameters:

set - Original set.

Returns:

New set.

checkProtocolVersion

public static void checkProtocolVersion(byte protoVer)

Check protocol version.

Parameters:

protoVer - Protocol version.

length

public static int length(BinaryPositionReadable in,
         int start)

Get binary object length.

Parameters:

in - Input stream.

start - Start position.

Returns:

Length.

footerStartRelative

public static int footerStartRelative(BinaryPositionReadable in,
                      int start)

Get footer start of the object.

Parameters:

in - Input stream.

start - Object start position inside the stream.

Returns:

Footer start.

footerStartAbsolute

public static int footerStartAbsolute(BinaryPositionReadable in,
                      int start)

Get object's footer.

Parameters:

in - Input stream.

start - Start position.

Returns:

Footer start.

footerAbsolute

public static IgniteBiTuple<Integer,Integer> footerAbsolute(BinaryPositionReadable in,
                                            int start)

Get object's footer.

Parameters:

in - Input stream.

start - Start position.

Returns:

Footer.

rawOffsetRelative

public static int rawOffsetRelative(BinaryPositionReadable in,
                    int start)

Get relative raw offset of the object.

Parameters:

in - Input stream.

start - Object start position inside the stream.

Returns:

Raw offset.

rawOffsetAbsolute

public static int rawOffsetAbsolute(BinaryPositionReadable in,
                    int start)

Get absolute raw offset of the object.

Parameters:

in - Input stream.

start - Object start position inside the stream.

Returns:

Raw offset.

fieldOffsetLength

public static int fieldOffsetLength(short flags)

Get offset length for the given flags.

Parameters:

flags - Flags.

Returns:

Offset size.

fieldIdLength

public static int fieldIdLength(short flags)

Get field ID length.

Parameters:

flags - Flags.

Returns:

Field ID length.

fieldOffsetRelative

public static int fieldOffsetRelative(BinaryPositionReadable stream,
                      int pos,
                      int fieldOffsetSize)

Get relative field offset.

Parameters:

stream - Stream.

pos - Position.

fieldOffsetSize - Field offset size.

Returns:

Relative field offset.

mergeMetadata

public static BinaryMetadata mergeMetadata(@Nullable
                           BinaryMetadata oldMeta,
                           BinaryMetadata newMeta)

Merge old and new metas.

Parameters:

oldMeta - Old meta.

newMeta - New meta.

Returns:

New meta if old meta was null, old meta if no changes detected, merged meta otherwise.

Throws:

BinaryObjectException - If merge failed due to metadata conflict.

mode

public static BinaryWriteMode mode(Class<?> cls)

Parameters:

cls - Class.

Returns:

Mode.

doReadByteArray

public static byte[] doReadByteArray(BinaryInputStream in)

Returns:

Value.

doReadBooleanArray

public static boolean[] doReadBooleanArray(BinaryInputStream in)

Returns:

Value.

doReadShortArray

public static short[] doReadShortArray(BinaryInputStream in)

Returns:

Value.

doReadCharArray

public static char[] doReadCharArray(BinaryInputStream in)

Returns:

Value.

doReadIntArray

public static int[] doReadIntArray(BinaryInputStream in)

Returns:

Value.

doReadLongArray

public static long[] doReadLongArray(BinaryInputStream in)

Returns:

Value.

doReadFloatArray

public static float[] doReadFloatArray(BinaryInputStream in)

Returns:

Value.

doReadDoubleArray

public static double[] doReadDoubleArray(BinaryInputStream in)

Returns:

Value.

doReadDecimal

public static BigDecimal doReadDecimal(BinaryInputStream in)

Returns:

Value.

doReadString

public static String doReadString(BinaryInputStream in)

Returns:

Value.

doReadUuid

public static UUID doReadUuid(BinaryInputStream in)

Returns:

Value.

doReadDate

public static Date doReadDate(BinaryInputStream in)

Returns:

Value.

doReadTimestamp

public static Timestamp doReadTimestamp(BinaryInputStream in)

Returns:

Value.

doReadDecimalArray

public static BigDecimal[] doReadDecimalArray(BinaryInputStream in)
                                       throws BinaryObjectException

Returns:

Value.

Throws:

BinaryObjectException - In case of error.

doReadStringArray

public static String[] doReadStringArray(BinaryInputStream in)
                                  throws BinaryObjectException

Returns:

Value.

Throws:

BinaryObjectException - In case of error.

doReadUuidArray

public static UUID[] doReadUuidArray(BinaryInputStream in)
                              throws BinaryObjectException

Returns:

Value.

Throws:

BinaryObjectException - In case of error.

doReadDateArray

public static Date[] doReadDateArray(BinaryInputStream in)
                              throws BinaryObjectException

Returns:

Value.

Throws:

BinaryObjectException - In case of error.

doReadTimestampArray

public static Timestamp[] doReadTimestampArray(BinaryInputStream in)
                                        throws BinaryObjectException

Returns:

Value.

Throws:

BinaryObjectException - In case of error.

doReadBinaryObject

public static BinaryObject doReadBinaryObject(BinaryInputStream in,
                              BinaryContext ctx)

Returns:

Value.

doReadClass

public static Class doReadClass(BinaryInputStream in,
                BinaryContext ctx,
                ClassLoader ldr)
                         throws BinaryObjectException

Returns:

Value.

Throws:

BinaryObjectException

doReadClass

public static Class doReadClass(BinaryInputStream in,
                BinaryContext ctx,
                ClassLoader ldr,
                int typeId)
                         throws BinaryObjectException

Parameters:

typeId - Type id.

Returns:

Value.

Throws:

BinaryObjectException

resolveClass

public static Class resolveClass(BinaryContext ctx,
                 int typeId,
                 @Nullable
                 String clsName,
                 @Nullable
                 ClassLoader ldr,
                 boolean deserialize)

Resolve the class.

Parameters:

ctx - Binary context.

typeId - Type ID.

clsName - Class name.

ldr - Class loaded.

Returns:

Resovled class.

doReadEnum

public static Enum<?> doReadEnum(BinaryInputStream in,
                 Class<?> cls)
                          throws BinaryObjectException

Having target class in place we simply read ordinal and create final representation.

Parameters:

cls - Enum class.

Returns:

Value.

Throws:

BinaryObjectException

doReadEnumArray

public static Object[] doReadEnumArray(BinaryInputStream in,
                       BinaryContext ctx,
                       ClassLoader ldr,
                       Class<?> cls)
                                throws BinaryObjectException

Parameters:

cls - Enum class.

Returns:

Value.

Throws:

BinaryObjectException

doReadOptimized

public static Object doReadOptimized(BinaryInputStream in,
                     BinaryContext ctx,
                     @Nullable
                     ClassLoader clsLdr)

Read object serialized using optimized marshaller.

Returns:

Result.

doReadObject

@Nullable
public static Object doReadObject(BinaryInputStream in,
                           BinaryContext ctx,
                           ClassLoader ldr,
                           BinaryReaderHandlesHolder handles)
                           throws BinaryObjectException

Returns:

Object.

Throws:

BinaryObjectException - In case of error.

unmarshal

@Nullable
public static Object unmarshal(BinaryInputStream in,
                        BinaryContext ctx,
                        ClassLoader ldr)
                        throws BinaryObjectException

Returns:

Unmarshalled value.

Throws:

BinaryObjectException - In case of error.

unmarshal

@Nullable
public static Object unmarshal(BinaryInputStream in,
                        BinaryContext ctx,
                        ClassLoader ldr,
                        BinaryReaderHandlesHolder handles)
                        throws BinaryObjectException

Returns:

Unmarshalled value.

Throws:

BinaryObjectException - In case of error.

unmarshal

@Nullable
public static Object unmarshal(BinaryInputStream in,
                        BinaryContext ctx,
                        ClassLoader ldr,
                        BinaryReaderHandlesHolder handles,
                        boolean detach)
                        throws BinaryObjectException

Returns:

Unmarshalled value.

Throws:

BinaryObjectException - In case of error.

doReadObjectArray

public static Object[] doReadObjectArray(BinaryInputStream in,
                         BinaryContext ctx,
                         ClassLoader ldr,
                         BinaryReaderHandlesHolder handles,
                         boolean deserialize)
                                  throws BinaryObjectException

Parameters:

deserialize - Deep flag.

Returns:

Value.

Throws:

BinaryObjectException - In case of error.

doReadCollection

public static Collection<?> doReadCollection(BinaryInputStream in,
                             BinaryContext ctx,
                             ClassLoader ldr,
                             BinaryReaderHandlesHolder handles,
                             boolean deserialize,
                             BinaryCollectionFactory factory)
                                      throws BinaryObjectException

Parameters:

deserialize - Deep flag.

factory - Collection factory.

Returns:

Value.

Throws:

BinaryObjectException - In case of error.

doReadMap

public static Map<?,?> doReadMap(BinaryInputStream in,
                 BinaryContext ctx,
                 ClassLoader ldr,
                 BinaryReaderHandlesHolder handles,
                 boolean deserialize,
                 BinaryMapFactory factory)
                          throws BinaryObjectException

Parameters:

deserialize - Deep flag.

factory - Map factory.

Returns:

Value.

Throws:

BinaryObjectException - In case of error.

positionForHandle

public static int positionForHandle(BinaryInputStream in)

Get position to be used for handle. We assume here that the hdr byte was read, hence subtract -1.

Returns:

Position for handle.

isBinarylizable

public static boolean isBinarylizable(Class cls)

Check if class is binarylizable.

Parameters:

cls - Class.

Returns:

True if binarylizable.

isCustomJavaSerialization

public static boolean isCustomJavaSerialization(Class cls)

Determines whether class contains custom Java serialization logic.

Parameters:

cls - Class.

Returns:

true if custom Java serialization logic exists, false otherwise.

qualifiedFieldName

public static String qualifiedFieldName(Class cls,
                        String fieldName)

Create qualified field name.

Parameters:

cls - Class.

fieldName - Field name.

Returns:

Qualified field name.