com.hazelcast.nio.serialization

Class ClassDefinitionBuilder

java.lang.Object

com.hazelcast.nio.serialization.ClassDefinitionBuilder

public final class ClassDefinitionBuilder
extends Object

ClassDefinitionBuilder is used to build and register ClassDefinitions manually.

See Also:

ClassDefinition, Portable, SerializationConfig.addClassDefinition(ClassDefinition)

Constructor Summary

Constructors

Constructor and Description
ClassDefinitionBuilder(int factoryId, int classId) IMPORTANT: It uses a default portableVersion (0) for non-versioned classes.
ClassDefinitionBuilder(int factoryId, int classId, int version) IMPORTANT: Make sure that the version matches the portableVersion in the SerializationService

Method Summary

Modifier and Type	Method and Description
ClassDefinitionBuilder	addBooleanArrayField(String fieldName)
ClassDefinitionBuilder	addBooleanField(String fieldName)
ClassDefinitionBuilder	addByteArrayField(String fieldName)
ClassDefinitionBuilder	addByteField(String fieldName)
ClassDefinitionBuilder	addCharArrayField(String fieldName)
ClassDefinitionBuilder	addCharField(String fieldName)
ClassDefinitionBuilder	addDateArrayField(String fieldName) Adds an array of Date's to the class definition
ClassDefinitionBuilder	addDateField(String fieldName) Adds a date field consisting of year, month of the year and day of the month to the class definition
ClassDefinitionBuilder	addDecimalArrayField(String fieldName) Adds an array of Decimal's to the class definition
ClassDefinitionBuilder	addDecimalField(String fieldName) Adds a decimal which is arbitrary precision and scale floating-point number to the class definition
ClassDefinitionBuilder	addDoubleArrayField(String fieldName)
ClassDefinitionBuilder	addDoubleField(String fieldName)
void	addField(com.hazelcast.internal.serialization.impl.portable.FieldDefinitionImpl fieldDefinition)
ClassDefinitionBuilder	addFloatArrayField(String fieldName)
ClassDefinitionBuilder	addFloatField(String fieldName)
ClassDefinitionBuilder	addIntArrayField(String fieldName)
ClassDefinitionBuilder	addIntField(String fieldName)
ClassDefinitionBuilder	addLongArrayField(String fieldName)
ClassDefinitionBuilder	addLongField(String fieldName)
ClassDefinitionBuilder	addPortableArrayField(String fieldName, ClassDefinition classDefinition)
ClassDefinitionBuilder	addPortableField(String fieldName, ClassDefinition def)
ClassDefinitionBuilder	addShortArrayField(String fieldName)
ClassDefinitionBuilder	addShortField(String fieldName)
ClassDefinitionBuilder	addStringArrayField(String fieldName)
ClassDefinitionBuilder	addStringField(String fieldName)
ClassDefinitionBuilder	addTimeArrayField(String fieldName) Adds an array of Time's to the class definition
ClassDefinitionBuilder	addTimeField(String fieldName) Adds a time field consisting of hour, minute, seconds and nanos parts to the class definition
ClassDefinitionBuilder	addTimestampArrayField(String fieldName) Adds an array of Timestamp's to the class definition
ClassDefinitionBuilder	addTimestampField(String fieldName) Adds a timestamp field consisting of year, month of the year, day of the month, hour, minute, seconds, nanos parts to the class definition
ClassDefinitionBuilder	addTimestampWithTimezoneArrayField(String fieldName) Adds an array of TimestampWithTimezone's to the class definition
ClassDefinitionBuilder	addTimestampWithTimezoneField(String fieldName) Adds a timestamp with timezone field consisting of year, month of the year, day of the month, offset seconds, hour, minute, seconds, nanos parts to the class definition
ClassDefinitionBuilder	addUTFArrayField(String fieldName) Deprecated. for the sake of better naming. Use addStringArrayField(String) instead.
ClassDefinitionBuilder	addUTFField(String fieldName) Deprecated. for the sake of better naming. Use addStringField(String) instead.
ClassDefinition	build()
int	getClassId()
int	getFactoryId()
int	getVersion()

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassDefinitionBuilder

public ClassDefinitionBuilder(int factoryId,
                              int classId)

IMPORTANT: It uses a default portableVersion (0) for non-versioned classes. Make sure to specify the portableVersion in the constructor if you override the default portableVersion in the SerializationService

Parameters:

factoryId - factoryId to use

classId - classId to use

ClassDefinitionBuilder

public ClassDefinitionBuilder(int factoryId,
                              int classId,
                              int version)

IMPORTANT: Make sure that the version matches the portableVersion in the SerializationService

Parameters:

factoryId - factoryId to use

classId - classId to use

version - portableVersion to use

Method Detail

addIntField

@Nonnull
public ClassDefinitionBuilder addIntField(@Nonnull
                                                   String fieldName)

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

addLongField

@Nonnull
public ClassDefinitionBuilder addLongField(@Nonnull
                                                    String fieldName)

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

addUTFField

@Nonnull
 @Deprecated
public ClassDefinitionBuilder addUTFField(@Nonnull
                                                                String fieldName)

Deprecated. for the sake of better naming. Use addStringField(String) instead.

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

addStringField

@Nonnull
public ClassDefinitionBuilder addStringField(@Nonnull
                                                      String fieldName)

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

addBooleanField

@Nonnull
public ClassDefinitionBuilder addBooleanField(@Nonnull
                                                       String fieldName)

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

addByteField

@Nonnull
public ClassDefinitionBuilder addByteField(@Nonnull
                                                    String fieldName)

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

addBooleanArrayField

@Nonnull
public ClassDefinitionBuilder addBooleanArrayField(@Nonnull
                                                            String fieldName)

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

addCharField

@Nonnull
public ClassDefinitionBuilder addCharField(@Nonnull
                                                    String fieldName)

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

addDoubleField

@Nonnull
public ClassDefinitionBuilder addDoubleField(@Nonnull
                                                      String fieldName)

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

addFloatField

@Nonnull
public ClassDefinitionBuilder addFloatField(@Nonnull
                                                     String fieldName)

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

addShortField

@Nonnull
public ClassDefinitionBuilder addShortField(@Nonnull
                                                     String fieldName)

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

addDecimalField

@Nonnull
public ClassDefinitionBuilder addDecimalField(@Nonnull
                                                       String fieldName)

Adds a decimal which is arbitrary precision and scale floating-point number to the class definition

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

addTimeField

@Nonnull
public ClassDefinitionBuilder addTimeField(@Nonnull
                                                    String fieldName)

Adds a time field consisting of hour, minute, seconds and nanos parts to the class definition

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

addDateField

@Nonnull
public ClassDefinitionBuilder addDateField(@Nonnull
                                                    String fieldName)

Adds a date field consisting of year, month of the year and day of the month to the class definition

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

addTimestampField

@Nonnull
public ClassDefinitionBuilder addTimestampField(@Nonnull
                                                         String fieldName)

Adds a timestamp field consisting of year, month of the year, day of the month, hour, minute, seconds, nanos parts to the class definition

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

addTimestampWithTimezoneField

@Nonnull
public ClassDefinitionBuilder addTimestampWithTimezoneField(@Nonnull
                                                                     String fieldName)

Adds a timestamp with timezone field consisting of year, month of the year, day of the month, offset seconds, hour, minute, seconds, nanos parts to the class definition

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

addByteArrayField

@Nonnull
public ClassDefinitionBuilder addByteArrayField(@Nonnull
                                                         String fieldName)

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

addCharArrayField

@Nonnull
public ClassDefinitionBuilder addCharArrayField(@Nonnull
                                                         String fieldName)

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

addIntArrayField

@Nonnull
public ClassDefinitionBuilder addIntArrayField(@Nonnull
                                                        String fieldName)

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

addLongArrayField

@Nonnull
public ClassDefinitionBuilder addLongArrayField(@Nonnull
                                                         String fieldName)

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

addDoubleArrayField

@Nonnull
public ClassDefinitionBuilder addDoubleArrayField(@Nonnull
                                                           String fieldName)

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

addFloatArrayField

@Nonnull
public ClassDefinitionBuilder addFloatArrayField(@Nonnull
                                                          String fieldName)

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

addShortArrayField

@Nonnull
public ClassDefinitionBuilder addShortArrayField(@Nonnull
                                                          String fieldName)

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

addUTFArrayField

@Nonnull
 @Deprecated
public ClassDefinitionBuilder addUTFArrayField(@Nonnull
                                                                     String fieldName)

Deprecated. for the sake of better naming. Use addStringArrayField(String) instead.

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

addStringArrayField

@Nonnull
public ClassDefinitionBuilder addStringArrayField(@Nonnull
                                                           String fieldName)

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

addPortableField

@Nonnull
public ClassDefinitionBuilder addPortableField(@Nonnull
                                                        String fieldName,
                                                        ClassDefinition def)

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

addPortableArrayField

@Nonnull
public ClassDefinitionBuilder addPortableArrayField(@Nonnull
                                                             String fieldName,
                                                             ClassDefinition classDefinition)

Parameters:

fieldName - name of the field that will be add to this class definition

classDefinition - class definition of the nested portable that will be add to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

addDecimalArrayField

@Nonnull
public ClassDefinitionBuilder addDecimalArrayField(@Nonnull
                                                            String fieldName)

Adds an array of Decimal's to the class definition

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

See Also:

addDecimalField(String)

addTimeArrayField

@Nonnull
public ClassDefinitionBuilder addTimeArrayField(@Nonnull
                                                         String fieldName)

Adds an array of Time's to the class definition

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

See Also:

addTimeField(String)

addDateArrayField

@Nonnull
public ClassDefinitionBuilder addDateArrayField(@Nonnull
                                                         String fieldName)

Adds an array of Date's to the class definition

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

See Also:

addDateField(String)

addTimestampArrayField

@Nonnull
public ClassDefinitionBuilder addTimestampArrayField(@Nonnull
                                                              String fieldName)

Adds an array of Timestamp's to the class definition

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

See Also:

addTimestampField(String)

addTimestampWithTimezoneArrayField

@Nonnull
public ClassDefinitionBuilder addTimestampWithTimezoneArrayField(@Nonnull
                                                                          String fieldName)

Adds an array of TimestampWithTimezone's to the class definition

Parameters:

fieldName - name of the field that will be added to this class definition

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if a field with same name already exists or if this method is called after build()

See Also:

addTimestampWithTimezoneField(String)

addField

@PrivateApi
public void addField(com.hazelcast.internal.serialization.impl.portable.FieldDefinitionImpl fieldDefinition)

build

@Nonnull
public ClassDefinition build()

Returns:

creates and returns a new ClassDefinition

getFactoryId

public int getFactoryId()

getClassId

public int getClassId()

getVersion

public int getVersion()