Package org.springframework.data.gemfire.config.schema

Interface SchemaObjectDefiner

All Known Implementing Classes:

ComposableSchemaObjectDefiner, IndexDefiner, RegionDefiner

public interface SchemaObjectDefiner

The SchemaObjectDefiner interface defines a contract for implementing objects that can reverse engineer a schema object instance back into a definition of the schema object.

Since:

2.0.0

See Also:

• SchemaObjectDefinition
• SchemaObjectType

Method Summary

Modifier and Type	Method	Description
default boolean	canDefine(Class<?> schemaObjectType)	Determines whether this definer is able to define schema objects of the given type.
default boolean	canDefine(Object schemaObject)	Determines whether this definer is able to define the given schema object instance.
default boolean	canDefine(SchemaObjectType schemaObjectType)	Determines whether this definer is able to define schema objects of the given enumerated schema object type.
Optional<? extends SchemaObjectDefinition>	define(Object schemaObject)	Returns an Optional definition for the given schema object instance.
default Set<SchemaObjectType>	getSchemaObjectTypes()	Returns a Set of schema object types definable by this definer.

Method Details

getSchemaObjectTypes

default Set<SchemaObjectType> getSchemaObjectTypes()

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

Returns:

a Set of schema object types definable by this definer.

See Also:

• SchemaObjectType
• Set

canDefine

default boolean canDefine(Object schemaObject)

Determines whether this definer is able to define the given schema object instance.

Parameters:

schemaObject - Object to evaluate.

Returns:

a boolean value indicating whether this definer is able to define the given schema object instance.

See Also:

• Object.getClass()
• canDefine(Class)

canDefine

default boolean canDefine(Class<?> schemaObjectType)

Determines whether this definer is able to define schema objects of the given type.

Parameters:

schemaObjectType - type of the schema object instance to evaluate.

Returns:

a boolean value indicating whether this definer is able to define schema objects of the given type.

See Also:

• SchemaObjectType.from(Class)
• canDefine(SchemaObjectType)

canDefine

default boolean canDefine(SchemaObjectType schemaObjectType)

Determines whether this definer is able to define schema objects of the given enumerated schema object type.

Parameters:

schemaObjectType - SchemaObjectType to evaluate.

Returns:

a boolean value indicating whether this handler is able to handle schema objects of the given enumerated schema object type.

See Also:

• SchemaObjectType

define

Optional<? extends SchemaObjectDefinition> define(Object schemaObject)

Returns an Optional definition for the given schema object instance.

Parameters:

schemaObject - schema object to define.

Returns:

an Optional definition for the given schema object instance.

See Also:

• SchemaObjectDefinition