com.hazelcast.config

Class CompactSerializationConfig

java.lang.Object

com.hazelcast.config.CompactSerializationConfig

@Beta
public class CompactSerializationConfig
extends Object

In 5.0, this feature is disabled by default and has to be enabled via configuration

Once enabled the classes which does not match to any other serialization methods will be serialized in the new format automatically via help of reflection without needing any other configuration. For this case, the class should not implement `Serializable`, `Externalizable` , `Portable` , `IdentifiedDataSerializable`, `DataSerializable` or the class should not be registered as a custom serializer.

Automatic serialization via reflection can de/serialize classes having an accessible empty constructor only. Only types in CompactWriter/CompactReader interface are supported as fields. For any other class as the field type, it will work recursively and try to de/serialize a sub-class. Thus, if any sub-fields does not have an accessible empty constructor, deserialization fails with HazelcastSerializationException.

To explicitly configure a class to be serialized via Compact format following methods can be used. register(Class) register(Class, String, CompactSerializer) }

On the last two methods listed above reflection is not utilized instead given serializer is used to serialize/deserialize users objects.

Since:

Hazelcast 5.0 as BETA. The final version will not be backward compatible with the Beta. Do not use BETA version in production

Constructor Summary

Constructors

Constructor and Description
CompactSerializationConfig()
CompactSerializationConfig(CompactSerializationConfig compactSerializationConfig)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Map<String,com.hazelcast.internal.util.TriTuple<Class,String,CompactSerializer>>	getRegistries()
int	hashCode()
boolean	isEnabled() This method will only be available during @Beta.
<T> CompactSerializationConfig	register(Class<T> clazz) Registers the class to be serialized via compact serializer.
<T> CompactSerializationConfig	register(Class<T> clazz, String typeName, CompactSerializer<T> explicitSerializer) Registers the class to be serialized via compact serializer.
CompactSerializationConfig	setEnabled(boolean enabled) Enables the Compact Format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompactSerializationConfig

public CompactSerializationConfig()

CompactSerializationConfig

public CompactSerializationConfig(CompactSerializationConfig compactSerializationConfig)

Method Detail

register

public <T> CompactSerializationConfig register(@Nonnull
                                               Class<T> clazz)

Registers the class to be serialized via compact serializer.

Overrides Portable, Identified, Java Serializable, or GlobalSerializer.

Type name is determined automatically from the class, which is its fully qualified class name.

Field types are determined automatically from the class via reflection.

Parameters:

clazz - Class to be serialized via compact serializer

Returns:

configured CompactSerializationConfig for chaining

register

public <T> CompactSerializationConfig register(@Nonnull
                                               Class<T> clazz,
                                               @Nonnull
                                               String typeName,
                                               @Nonnull
                                               CompactSerializer<T> explicitSerializer)

Registers the class to be serialized via compact serializer.

Overrides Portable, Identified, Java Serializable, or GlobalSerializer.

Parameters:

clazz - Class to be serialized via compact serializer

typeName - Type name of the class

explicitSerializer - Serializer to be used for the given class

Returns:

configured CompactSerializationConfig for chaining

getRegistries

@Nonnull
public Map<String,com.hazelcast.internal.util.TriTuple<Class,String,CompactSerializer>> getRegistries()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isEnabled

public boolean isEnabled()

This method will only be available during @Beta.

Returns:

true if compact serialization is enable.

setEnabled

public CompactSerializationConfig setEnabled(boolean enabled)

Enables the Compact Format. The Compact Format will be disabled by default during the Beta period. It will be enabled by default after the Beta. Note that this method will be deleted after the Beta.

The final version will not be backward compatible with the Beta. Do not use BETA version in production

Parameters:

enabled - Enables the Compact Format when set to true

Returns:

configured CompactSerializationConfig for chaining