ClassDefinitionBuilder (Hazelcast Root 3.12.13 API)

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

All Methods Instance Methods Concrete Methods
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`	`addDoubleArrayField(String fieldName)`
`ClassDefinitionBuilder`	`addDoubleField(String fieldName)`
`ClassDefinitionBuilder`	`addField(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`	`addUTFArrayField(String fieldName)`
`ClassDefinitionBuilder`	`addUTFField(String fieldName)`
`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
```
public ClassDefinitionBuilder addIntField(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
```
public ClassDefinitionBuilder addLongField(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
```
public ClassDefinitionBuilder addUTFField(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
```
public ClassDefinitionBuilder addBooleanField(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
```
public ClassDefinitionBuilder addByteField(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
```
public ClassDefinitionBuilder addBooleanArrayField(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
```
public ClassDefinitionBuilder addCharField(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
```
public ClassDefinitionBuilder addDoubleField(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
```
public ClassDefinitionBuilder addFloatField(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
```
public ClassDefinitionBuilder addShortField(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()
  - addByteArrayField
```
public ClassDefinitionBuilder addByteArrayField(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
```
public ClassDefinitionBuilder addCharArrayField(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
```
public ClassDefinitionBuilder addIntArrayField(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
```
public ClassDefinitionBuilder addLongArrayField(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
```
public ClassDefinitionBuilder addDoubleArrayField(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
```
public ClassDefinitionBuilder addFloatArrayField(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
```
public ClassDefinitionBuilder addShortArrayField(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
```
public ClassDefinitionBuilder addUTFArrayField(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
```
public ClassDefinitionBuilder addPortableField(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
```
public ClassDefinitionBuilder addPortableArrayField(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()
  - addField
```
@PrivateApi
public ClassDefinitionBuilder addField(FieldDefinitionImpl fieldDefinition)
```
  - build
```
public ClassDefinition build()
```
    Returns:
    
    creates and returns a new ClassDefinition
  - getFactoryId
```
public int getFactoryId()
```
  - getClassId
```
public int getClassId()
```
  - getVersion
```
public int getVersion()
```

Class ClassDefinitionBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClassDefinitionBuilder

ClassDefinitionBuilder

Method Detail

addIntField

addLongField

addUTFField

addBooleanField

addByteField

addBooleanArrayField

addCharField

addDoubleField

addFloatField

addShortField

addByteArrayField

addCharArrayField

addIntArrayField

addLongArrayField

addDoubleArrayField

addFloatArrayField

addShortArrayField

addUTFArrayField

addPortableField

addPortableArrayField

addField

build

getFactoryId

getClassId

getVersion