SpaceTypeDescriptorBuilder (GigaSpaces 16.1.0 API)

java.lang.Object
- com.gigaspaces.metadata.SpaceTypeDescriptorBuilder

```
public class SpaceTypeDescriptorBuilder
extends Object
```
A builder class for creating SpaceTypeDescriptor instances. For example, to create a type descriptor with type name 'foo' and id property 'bar' use the following code: new SpaceTypeDescriptorBuilder("foo").setIdProperty("bar").create()

Since:

8.0

Author:

Niv Ingberg

See Also:

SpaceTypeDescriptor

Constructor Summary

Constructors
Constructor and Description
`SpaceTypeDescriptorBuilder(Class<?> type, SpaceTypeDescriptor superTypeDescriptor)`
`SpaceTypeDescriptorBuilder(String typeName)` Initialize a type descriptor builder using the specified type name.
`SpaceTypeDescriptorBuilder(String typeName, SpaceTypeDescriptor superTypeDescriptor)` Initialize a type descriptor builder using the specified type name and super type descriptor.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`SpaceTypeDescriptorBuilder`	`addCompoundIndex(String[] paths)` Adds an index of the specified type for the specified path.
`SpaceTypeDescriptorBuilder`	`addCompoundIndex(String[] paths, boolean unique)` Adds an index of the specified type for the specified path.
`SpaceTypeDescriptorBuilder`	`addCompoundIndex(String[] paths, SpaceIndexType indexType)` Deprecated.
`SpaceTypeDescriptorBuilder`	`addCompoundIndex(String[] paths, SpaceIndexType indexType, boolean unique)` Deprecated.
`SpaceTypeDescriptorBuilder`	`addFifoGroupingIndex(String fifoGroupingIndexPath)` Sets a fifo grouping index
`SpaceTypeDescriptorBuilder`	`addFixedProperty(String propertyName, Class<?> propertyType)` Adds a property to the fixed properties set.
`SpaceTypeDescriptorBuilder`	`addFixedProperty(String propertyName, Class<?> propertyType, Class<? extends PropertyStorageAdapter> propertyStorageAdapter)` Adds a property to the fixed properties set.
`SpaceTypeDescriptorBuilder`	`addFixedProperty(String propertyName, Class<?> propertyType, SpaceDocumentSupport documentSupport)` Adds a property to the fixed properties set.
`SpaceTypeDescriptorBuilder`	`addFixedProperty(String propertyName, Class<?> propertyType, SpaceDocumentSupport documentSupport, Class<? extends PropertyStorageAdapter> propertyStorageAdapter)` Adds a property to the fixed properties set.
`SpaceTypeDescriptorBuilder`	`addFixedProperty(String propertyName, Class<?> propertyType, SpaceDocumentSupport documentSupport, StorageType storageType)` Adds a property to the fixed properties set.
`SpaceTypeDescriptorBuilder`	`addFixedProperty(String propertyName, Class<?> propertyType, StorageType storageType)` Adds a property to the fixed properties set.
`SpaceTypeDescriptorBuilder`	`addFixedProperty(String propertyName, String propertyTypeName)` Adds a property to the fixed properties set.
`SpaceTypeDescriptorBuilder`	`addFixedProperty(String propertyName, String propertyTypeName, SpaceDocumentSupport documentSupport)`
`SpaceTypeDescriptorBuilder`	`addFixedProperty(String propertyName, String propertyTypeName, SpaceDocumentSupport documentSupport, Class<? extends PropertyStorageAdapter> propertyStorageAdapter)`
`SpaceTypeDescriptorBuilder`	`addFixedProperty(String propertyName, String propertyTypeName, SpaceDocumentSupport documentSupport, StorageType storageType)`
`SpaceTypeDescriptorBuilder`	`addIndex(SpaceIndex index)` Adds the specified index to the type's index set.
`SpaceTypeDescriptorBuilder`	`addPathIndex(String path, SpaceIndexType indexType)` Adds an index of the specified type for the specified path.
`SpaceTypeDescriptorBuilder`	`addPathIndex(String path, SpaceIndexType indexType, boolean unique)` Adds an index of the specified type for the specified path.
`SpaceTypeDescriptorBuilder`	`addPropertyIndex(String propertyName, SpaceIndexType indexType)` Adds an index of the specified type for the specified property.
`SpaceTypeDescriptorBuilder`	`addPropertyIndex(String propertyName, SpaceIndexType indexType, boolean unique)` Adds an index of the specified type for the specified property.
`SpaceTypeDescriptorBuilder`	`addQueryExtensionInfo(String path, Class<? extends Annotation> queryExtensionAnnotation)` Adds a QueryExtension information for the specified path
`SpaceTypeDescriptorBuilder`	`addQueryExtensionInfo(String path, QueryExtensionPathInfo pathInfo)` Adds a QueryExtension information for the specified path
`SpaceTypeDescriptorBuilder`	`binaryStorage()`
`SpaceTypeDescriptorBuilder`	`binaryStorage(ClassBinaryStorageLayout layout)`
`SpaceTypeDescriptorBuilder`	`broadcast(boolean broadcast)` Sets whether this type should be distributed across partitions.
`SpaceTypeDescriptor`	`create()` Create the space type descriptor using the gathered information.
`SpaceTypeDescriptorBuilder`	`documentWrapperClass(Class<? extends SpaceDocument> documentWrapperClass)` Sets the document wrapper class for this type.
`SpaceTypeDescriptorBuilder`	`fifoGroupingProperty(String fifoGroupingPropertyPath)` Sets the fifo grouping property
`SpaceTypeDescriptorBuilder`	`fifoSupport(FifoSupport fifoSupport)` Sets this type FIFO support.
`SpaceTypeDescriptorBuilder`	`idProperty(String idPropertyName)` Sets the ID property.
`SpaceTypeDescriptorBuilder`	`idProperty(String idPropertyName, boolean autoGenerateId)` Sets the ID property.
`SpaceTypeDescriptorBuilder`	`idProperty(String idPropertyName, boolean autoGenerateId, SpaceIndexType indexType)` Sets the ID property.
`SpaceTypeDescriptorBuilder`	`replicable(boolean replicable)` Sets whether this type is replicable or not.
`SpaceTypeDescriptorBuilder`	`routingProperty(String routingPropertyName)` Sets the routing property.
`SpaceTypeDescriptorBuilder`	`routingProperty(String routingPropertyName, SpaceIndexType indexType)` Sets the routing property.
`SpaceTypeDescriptorBuilder`	`sequenceNumberProperty(String sequenceNumberPropertyName, boolean sequenceNumberFromDocumentBuilder)`
`SpaceTypeDescriptorBuilder`	`setBlobstoreEnabled(boolean blobstoreEnabled)` Sets whether for this type blobstore data is enabled when cache policy is set for blobstore.
`SpaceTypeDescriptorBuilder`	`storageType(StorageType storageType)` Sets type's storage type
`SpaceTypeDescriptorBuilder`	`supportsDynamicProperties(boolean supportsDynamicProperties)` Sets whether or not this type supports dynamic properties.
`SpaceTypeDescriptorBuilder`	`supportsOptimisticLocking(boolean supportsOptimisticLocking)` Sets whether or not this type supports optimistic locking.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpaceTypeDescriptorBuilder
```
public SpaceTypeDescriptorBuilder(String typeName)
```
Initialize a type descriptor builder using the specified type name.

Parameters:

typeName - Name of type.

SpaceTypeDescriptorBuilder
```
public SpaceTypeDescriptorBuilder(String typeName,
                                  SpaceTypeDescriptor superTypeDescriptor)
```
Initialize a type descriptor builder using the specified type name and super type descriptor.

Parameters:

typeName - Name of type.

superTypeDescriptor - Type descriptor of super type.

SpaceTypeDescriptorBuilder

public SpaceTypeDescriptorBuilder(Class<?> type,
                                  SpaceTypeDescriptor superTypeDescriptor)

Method Detail

documentWrapperClass
```
public SpaceTypeDescriptorBuilder documentWrapperClass(Class<? extends SpaceDocument> documentWrapperClass)
```
Sets the document wrapper class for this type. A document wrapper class is a java class which extends SpaceDocument and can be used as a surrogate for a specific type.

Parameters:

documentWrapperClass - The document wrapper class for this type.

binaryStorage

public SpaceTypeDescriptorBuilder binaryStorage()

Since:: 15.8
See Also:: SpaceClassBinaryStorage

binaryStorage

public SpaceTypeDescriptorBuilder binaryStorage(ClassBinaryStorageLayout layout)

Since:: 15.8
See Also:: SpaceClassBinaryStorage

fifoSupport
```
public SpaceTypeDescriptorBuilder fifoSupport(FifoSupport fifoSupport)
```
Sets this type FIFO support.

Parameters:

fifoSupport - Desired FIFO support.

replicable
```
public SpaceTypeDescriptorBuilder replicable(boolean replicable)
```
Sets whether this type is replicable or not.

Parameters:

replicable - true if this type is replicable, false otherwise.

setBlobstoreEnabled
```
public SpaceTypeDescriptorBuilder setBlobstoreEnabled(boolean blobstoreEnabled)
```
Sets whether for this type blobstore data is enabled when cache policy is set for blobstore.

Parameters:

blobstoreEnabled - true if this type blobstore data is enabled, false otherwise.

broadcast
```
public SpaceTypeDescriptorBuilder broadcast(boolean broadcast)
```
Sets whether this type should be distributed across partitions.

Parameters:

broadcast - true if this type is broadcast, false otherwise.

supportsDynamicProperties
```
public SpaceTypeDescriptorBuilder supportsDynamicProperties(boolean supportsDynamicProperties)
```
Sets whether or not this type supports dynamic properties.

Parameters:

supportsDynamicProperties - true if this type supports dynamic properties, false otherwise.

supportsOptimisticLocking
```
public SpaceTypeDescriptorBuilder supportsOptimisticLocking(boolean supportsOptimisticLocking)
```
Sets whether or not this type supports optimistic locking.

Parameters:

supportsOptimisticLocking - true if this type supports optimistic locking, false otherwise.

storageType

public SpaceTypeDescriptorBuilder storageType(StorageType storageType)

Sets type's storage type