Spring Data for VMware GemFire

IndexDefiner (Spring Data for VMware GemFire Java API Reference)

java.lang.Object

org.springframework.data.gemfire.config.schema.support.IndexDefiner

All Implemented Interfaces:: SchemaObjectDefiner

public class IndexDefiner extends Object implements SchemaObjectDefiner

The {@link {{@link IndexDefiner }} class is responsible for defining an Index given a reference to an Index instance.

Since:

2.0.0

See Also:

Constructor Summary

Constructors

Constructor

Description

IndexDefiner()
Method Summary

Modifier and Type

Method

Description

Optional<IndexDefinition>

define(Object schemaObject)

Returns an Optional definition for the given schema object instance.

Set<SchemaObjectType>

getSchemaObjectTypes()

Returns a Set of schema object types definable by this definer.

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

Methods inherited from interface org.springframework.data.gemfire.config.schema.SchemaObjectDefiner
canDefine, canDefine, canDefine

Constructor Details
- IndexDefiner
  
  public IndexDefiner()
Method Details
- getSchemaObjectTypes
  
  public Set<SchemaObjectType> getSchemaObjectTypes()
  
  Description copied from interface: SchemaObjectDefiner
  
  Returns a Set of schema object types definable by this definer.
  Specified by:
  
  getSchemaObjectTypes in interface SchemaObjectDefiner
  
  Returns:
  
  a Set of schema object types definable by this definer.
  
  See Also:
  
  SchemaObjectType
  
  Set
- define
  
  public Optional<IndexDefinition> define(Object schemaObject)
  
  Description copied from interface: SchemaObjectDefiner
  
  Returns an Optional definition for the given schema object instance.
  Specified by:
  
  define in interface SchemaObjectDefiner
  
  Parameters:
  
  schemaObject - schema object to define.
  
  Returns:
  
  an Optional definition for the given schema object instance.
  
  See Also:
  
  SchemaObjectDefinition