com.hazelcast.nio.serialization

Interface GenericRecord.Builder

Enclosing interface:

GenericRecord

@Beta
public static interface GenericRecord.Builder

Interface for creating GenericRecord instances.

Method Summary

Modifier and Type	Method and Description
GenericRecord	build()
static GenericRecord.Builder	portable(ClassDefinition classDefinition) Creates a Builder that will build a GenericRecord in Portable format with a new class definition:
GenericRecord.Builder	writeBoolean(String fieldName, boolean value) It is legal to overwrite the field once only when Builder is created with GenericRecord.cloneWithBuilder().
GenericRecord.Builder	writeBooleanArray(String fieldName, boolean[] value) It is illegal to write to the same field twice.
GenericRecord.Builder	writeByte(String fieldName, byte value) It is illegal to write to the same field twice.
GenericRecord.Builder	writeByteArray(String fieldName, byte[] value) It is illegal to write to the same field twice.
GenericRecord.Builder	writeChar(String fieldName, char value) It is illegal to write to the same field twice.
GenericRecord.Builder	writeCharArray(String fieldName, char[] value) It is illegal to write to the same field twice.
GenericRecord.Builder	writeDouble(String fieldName, double value) It is illegal to write to the same field twice.
GenericRecord.Builder	writeDoubleArray(String fieldName, double[] value) It is illegal to write to the same field twice.
GenericRecord.Builder	writeFloat(String fieldName, float value) It is illegal to write to the same field twice.
GenericRecord.Builder	writeFloatArray(String fieldName, float[] value) It is illegal to write to the same field twice.
GenericRecord.Builder	writeGenericRecord(String fieldName, GenericRecord value) It is illegal to write to the same field twice.
GenericRecord.Builder	writeGenericRecordArray(String fieldName, GenericRecord[] value) It is illegal to write to the same field twice.
GenericRecord.Builder	writeInt(String fieldName, int value) It is illegal to write to the same field twice.
GenericRecord.Builder	writeIntArray(String fieldName, int[] value) It is illegal to write to the same field twice.
GenericRecord.Builder	writeLong(String fieldName, long value) It is illegal to write to the same field twice.
GenericRecord.Builder	writeLongArray(String fieldName, long[] value) It is illegal to write to the same field twice.
GenericRecord.Builder	writeShort(String fieldName, short value) It is illegal to write to the same field twice.
GenericRecord.Builder	writeShortArray(String fieldName, short[] value) It is illegal to write to the same field twice.
GenericRecord.Builder	writeUTF(String fieldName, String value) It is illegal to write to the same field twice.
GenericRecord.Builder	writeUTFArray(String fieldName, String[] value) It is illegal to write to the same field twice.

Method Detail

portable

@Nonnull
static GenericRecord.Builder portable(@Nonnull
                                               ClassDefinition classDefinition)

Creates a Builder that will build a GenericRecord in Portable format with a new class definition:

     ClassDefinition classDefinition =
                 new ClassDefinitionBuilder(FACTORY_ID, CLASS_ID)
                         .addUTFField("name").addIntField("id").build();

     GenericRecord genericRecord = GenericRecord.Builder.portable(classDefinition)
           .writeUTF("name", "foo")
           .writeInt("id", 123).build();
 

Parameters:

classDefinition - of the portable that we will create

Returns:

GenericRecordBuilder for Portable format

build

@Nonnull
GenericRecord build()

Returns:

a new constructed GenericRecord

Throws:

HazelcastSerializationException - when the GenericRecord cannot be build.

writeBoolean

GenericRecord.Builder writeBoolean(@Nonnull
                                   String fieldName,
                                   boolean value)

It is legal to overwrite the field once only when Builder is created with GenericRecord.cloneWithBuilder(). Otherwise, it is illegal to write to the same field twice.

Parameters:

fieldName - name of the field as it is defined in its class definition. It should be composed of only alpha-numeric characters. See ClassDefinition for Portable

value -

Returns:

itself for chaining

Throws:

HazelcastSerializationException - if the field name does not exist in the class definition or the type of the field does not match the one in the class definition or Same field is trying to be overwritten without using GenericRecord.cloneWithBuilder().

writeByte

GenericRecord.Builder writeByte(@Nonnull
                                String fieldName,
                                byte value)

It is illegal to write to the same field twice.

Parameters:

fieldName - name of the field as it is defined in its class definition. It should be composed of only alpha-numeric characters. See ClassDefinition for Portable

value -

Throws:

HazelcastSerializationException - if the field name does not exist in the class definition or the type of the field does not match the one in the class definition or Same field is trying to be overwritten without using GenericRecord.cloneWithBuilder().

writeChar

GenericRecord.Builder writeChar(@Nonnull
                                String fieldName,
                                char value)

It is illegal to write to the same field twice.

Parameters:

fieldName - name of the field as it is defined in its class definition. See ClassDefinition for Portable

value -

Throws:

HazelcastSerializationException - if the field name does not exist in the class definition or the type of the field does not match the one in the class definition or Same field is trying to be overwritten without using GenericRecord.cloneWithBuilder().

writeDouble

GenericRecord.Builder writeDouble(@Nonnull
                                  String fieldName,
                                  double value)

It is illegal to write to the same field twice.

Parameters:

fieldName - name of the field as it is defined in its class definition. See ClassDefinition for Portable

value -

Throws:

HazelcastSerializationException - if the field name does not exist in the class definition or the type of the field does not match the one in the class definition or Same field is trying to be overwritten without using GenericRecord.cloneWithBuilder().

writeFloat

GenericRecord.Builder writeFloat(@Nonnull
                                 String fieldName,
                                 float value)

It is illegal to write to the same field twice.

Parameters:

fieldName - name of the field as it is defined in its class definition. See ClassDefinition for Portable

value -

Throws:

HazelcastSerializationException - if the field name does not exist in the class definition or the type of the field does not match the one in the class definition or Same field is trying to be overwritten without using GenericRecord.cloneWithBuilder().

writeInt

GenericRecord.Builder writeInt(@Nonnull
                               String fieldName,
                               int value)

It is illegal to write to the same field twice.

Parameters:

fieldName - name of the field as it is defined in its class definition. See ClassDefinition for Portable

value -

Throws:

HazelcastSerializationException - if the field name does not exist in the class definition or the type of the field does not match the one in the class definition or Same field is trying to be overwritten without using GenericRecord.cloneWithBuilder().

writeLong

GenericRecord.Builder writeLong(@Nonnull
                                String fieldName,
                                long value)

It is illegal to write to the same field twice.

Parameters:

fieldName - name of the field as it is defined in its class definition. See ClassDefinition for Portable

value -

Throws:

HazelcastSerializationException - if the field name does not exist in the class definition or the type of the field does not match the one in the class definition or Same field is trying to be overwritten without using GenericRecord.cloneWithBuilder().

writeShort

GenericRecord.Builder writeShort(@Nonnull
                                 String fieldName,
                                 short value)

It is illegal to write to the same field twice.

Parameters:

fieldName - name of the field as it is defined in its class definition. See ClassDefinition for Portable

value -

Throws:

HazelcastSerializationException - if the field name does not exist in the class definition or the type of the field does not match the one in the class definition or Same field is trying to be overwritten without using GenericRecord.cloneWithBuilder().

writeUTF

GenericRecord.Builder writeUTF(@Nonnull
                               String fieldName,
                               @Nullable
                               String value)

It is illegal to write to the same field twice.

Parameters:

fieldName - name of the field as it is defined in its class definition. See ClassDefinition for Portable

value -

Throws:

HazelcastSerializationException - if the field name does not exist in the class definition or the type of the field does not match the one in the class definition or Same field is trying to be overwritten without using GenericRecord.cloneWithBuilder().

writeGenericRecord

GenericRecord.Builder writeGenericRecord(@Nonnull
                                         String fieldName,
                                         @Nullable
                                         GenericRecord value)

It is illegal to write to the same field twice. This method allows nested structures. Subclass should also created as `GenericRecord`

Parameters:

fieldName - name of the field as it is defined in its class definition. See ClassDefinition for Portable

value -

Throws:

HazelcastSerializationException - if the field name does not exist in the class definition or the type of the field does not match the one in the class definition or Same field is trying to be overwritten without using GenericRecord.cloneWithBuilder().

writeBooleanArray

GenericRecord.Builder writeBooleanArray(@Nonnull
                                        String fieldName,
                                        @Nullable
                                        boolean[] value)

It is illegal to write to the same field twice.

Parameters:

fieldName - name of the field as it is defined in its class definition. See ClassDefinition for Portable

value -

Throws:

HazelcastSerializationException - if the field name does not exist in the class definition or the type of the field does not match the one in the class definition or Same field is trying to be overwritten without using GenericRecord.cloneWithBuilder().

writeByteArray

GenericRecord.Builder writeByteArray(@Nonnull
                                     String fieldName,
                                     @Nullable
                                     byte[] value)

It is illegal to write to the same field twice.

Parameters:

fieldName - name of the field as it is defined in its class definition. See ClassDefinition for Portable

value -

Throws:

HazelcastSerializationException - if the field name does not exist in the class definition or the type of the field does not match the one in the class definition or Same field is trying to be overwritten without using GenericRecord.cloneWithBuilder().

writeCharArray

GenericRecord.Builder writeCharArray(@Nonnull
                                     String fieldName,
                                     @Nullable
                                     char[] value)

It is illegal to write to the same field twice.

Parameters:

fieldName - name of the field as it is defined in its class definition. See ClassDefinition for Portable

value -

Throws:

HazelcastSerializationException - if the field name does not exist in the class definition or the type of the field does not match the one in the class definition or Same field is trying to be overwritten without using GenericRecord.cloneWithBuilder().

writeFloatArray

GenericRecord.Builder writeFloatArray(@Nonnull
                                      String fieldName,
                                      @Nullable
                                      float[] value)

It is illegal to write to the same field twice.

Parameters:

fieldName - name of the field as it is defined in its class definition. See ClassDefinition for Portable

value -

Throws:

HazelcastSerializationException - if the field name does not exist in the class definition or the type of the field does not match the one in the class definition or Same field is trying to be overwritten without using GenericRecord.cloneWithBuilder().

writeIntArray

GenericRecord.Builder writeIntArray(@Nonnull
                                    String fieldName,
                                    @Nullable
                                    int[] value)

It is illegal to write to the same field twice.

Parameters:

fieldName - name of the field as it is defined in its class definition. See ClassDefinition for Portable

value -

Throws:

HazelcastSerializationException - if the field name does not exist in the class definition or the type of the field does not match the one in the class definition or Same field is trying to be overwritten without using GenericRecord.cloneWithBuilder().

writeDoubleArray

GenericRecord.Builder writeDoubleArray(@Nonnull
                                       String fieldName,
                                       @Nullable
                                       double[] value)

It is illegal to write to the same field twice.

Parameters:

fieldName - name of the field as it is defined in its class definition. See ClassDefinition for Portable

value -

Throws:

HazelcastSerializationException - if the field name does not exist in the class definition or the type of the field does not match the one in the class definition or Same field is trying to be overwritten without using GenericRecord.cloneWithBuilder().

writeLongArray

GenericRecord.Builder writeLongArray(@Nonnull
                                     String fieldName,
                                     @Nullable
                                     long[] value)

It is illegal to write to the same field twice.

Parameters:

fieldName - name of the field as it is defined in its class definition. See ClassDefinition for Portable

value -

Throws:

HazelcastSerializationException - if the field name does not exist in the class definition or the type of the field does not match the one in the class definition or Same field is trying to be overwritten without using GenericRecord.cloneWithBuilder().

writeShortArray

GenericRecord.Builder writeShortArray(@Nonnull
                                      String fieldName,
                                      @Nullable
                                      short[] value)

It is illegal to write to the same field twice.

Parameters:

fieldName - name of the field as it is defined in its class definition. See ClassDefinition for Portable

value -

Throws:

HazelcastSerializationException - if the field name does not exist in the class definition or the type of the field does not match the one in the class definition or Same field is trying to be overwritten without using GenericRecord.cloneWithBuilder().

writeUTFArray

GenericRecord.Builder writeUTFArray(@Nonnull
                                    String fieldName,
                                    @Nullable
                                    String[] value)

It is illegal to write to the same field twice.

Array items can not be null

Parameters:

fieldName - name of the field as it is defined in its class definition. See ClassDefinition for Portable

value -

Throws:

HazelcastSerializationException - if the field name does not exist in the class definition or the type of the field does not match the one in the class definition or Same field is trying to be overwritten without using GenericRecord.cloneWithBuilder().

writeGenericRecordArray

GenericRecord.Builder writeGenericRecordArray(@Nonnull
                                              String fieldName,
                                              @Nullable
                                              GenericRecord[] value)

It is illegal to write to the same field twice. This method allows nested structures. Subclasses should also created as `GenericRecord`

Array items can not be null

Parameters:

fieldName - name of the field as it is defined in its class definition. See ClassDefinition for Portable

value -

Throws:

HazelcastSerializationException - if the field name does not exist in the class definition or the type of the field does not match the one in the class definition or Same field is trying to be overwritten without using GenericRecord.cloneWithBuilder().