org.openspaces.core

Interface GigaSpaceTypeManager

All Known Implementing Classes:

DefaultGigaSpaceTypeManager

public interface GigaSpaceTypeManager

Interface encapsulating operations for getting and managing space type descriptors. Use GigaSpace.getTypeManager() to retrieve the type manager of a GigaSpace instance.

Since:

8.0

Author:

Niv Ingberg

See Also:

GigaSpace, SpaceTypeDescriptor, SpaceTypeDescriptorBuilder, SpaceIndex, SpaceIndexFactory

Method Summary

Modifier and Type	Method and Description
AsyncFuture<AddTypeIndexesResult>	asyncAddIndex(String typeName, SpaceIndex index) Adds the specified index to the specified type.
AsyncFuture<AddTypeIndexesResult>	asyncAddIndex(String typeName, SpaceIndex index, AsyncFutureListener<AddTypeIndexesResult> listener) Adds the specified index to the specified type.
AsyncFuture<AddTypeIndexesResult>	asyncAddIndexes(String typeName, SpaceIndex[] indexes, AsyncFutureListener<AddTypeIndexesResult> listener) Adds the specified indexes to the specified type.
SpaceTypeDescriptor	getTypeDescriptor(Class<?> type) Gets the space type descriptor of the specified type.
SpaceTypeDescriptor	getTypeDescriptor(String typeName) Gets the space type descriptor of the specified type.
void	registerTypeDescriptor(Class<?> type) Creates a type descriptor for the specified type and registers it in the space.
void	registerTypeDescriptor(SpaceTypeDescriptor typeDescriptor) Registers the specified space type descriptor in the space.

Method Detail

getTypeDescriptor

SpaceTypeDescriptor getTypeDescriptor(String typeName)

Gets the space type descriptor of the specified type.

Parameters:

typeName - Name of type.

Returns:

Type descriptor of the type, if available (if not, returns null).

getTypeDescriptor

SpaceTypeDescriptor getTypeDescriptor(Class<?> type)

Gets the space type descriptor of the specified type.

Parameters:

type - Java class.

Returns:

Type descriptor of the type, if available (if not, returns null).

registerTypeDescriptor

void registerTypeDescriptor(SpaceTypeDescriptor typeDescriptor)

Registers the specified space type descriptor in the space.

registerTypeDescriptor

void registerTypeDescriptor(Class<?> type)

Creates a type descriptor for the specified type and registers it in the space.

asyncAddIndex

AsyncFuture<AddTypeIndexesResult> asyncAddIndex(String typeName,
                                                SpaceIndex index)

Adds the specified index to the specified type.

Parameters:

typeName - Name of type to enhance.

index - Index to add.

Returns:

A Future to monitor completion of the operation, whose get() method will return the add index result upon completion.

asyncAddIndex

AsyncFuture<AddTypeIndexesResult> asyncAddIndex(String typeName,
                                                SpaceIndex index,
                                                AsyncFutureListener<AddTypeIndexesResult> listener)

Adds the specified index to the specified type.

Parameters:

typeName - Name of type to enhance.

index - Index to add.

listener - A listener to be notified when a result arrives

Returns:

A Future to monitor completion of the operation, whose get() method will return the add index result upon completion.

asyncAddIndexes

AsyncFuture<AddTypeIndexesResult> asyncAddIndexes(String typeName,
                                                  SpaceIndex[] indexes,
                                                  AsyncFutureListener<AddTypeIndexesResult> listener)

Adds the specified indexes to the specified type.

Parameters:

typeName - Name of type to enhance.

indexes - Indexes to add.

listener - A listener to be notified when a result arrives.

Returns:

A Future to monitor completion of the operation, whose get() method will return the add index result upon completion.