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

Class SchemaObjectDefinition

java.lang.Object

org.springframework.data.gemfire.config.schema.SchemaObjectDefinition

All Implemented Interfaces:

Serializable, org.springframework.core.Ordered

Direct Known Subclasses:

IndexDefinition, RegionDefinition

public abstract class SchemaObjectDefinition
extends Object
implements Serializable, org.springframework.core.Ordered

SchemaObjectDefinition is an Abstract Data Type (ADT) encapsulating the definition of a single Apache Geode or Pivotal GemFire schema object (e.g. Region or Index).

Since:

2.0.0

See Also:

• Serializable
• Ordered
• SchemaObjectDefiner
• SchemaObjectType
• Serialized Form

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
SchemaObjectDefinition(String name)	Constructs a new instance of SchemaObjectDefinition initialized with the specified name.

Method Summary

Modifier and Type	Method	Description
void	create(GemfireAdminOperations gemfireAdminOperations)	Creates an actual schema object from this SchemaObjectDefinition.
boolean	equals(Object obj)
String	getName()	Returns the name assigned to the schema object.
abstract SchemaObjectType	getType()	Returns the type of schema object defined by this SchemaObjectDefinition.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.core.Ordered

getOrder

Constructor Details

SchemaObjectDefinition

public SchemaObjectDefinition(String name)

Constructs a new instance of SchemaObjectDefinition initialized with the specified name.

Parameters:

name - name given to the GemFire/Geode schema object; must not be null.

Throws:

IllegalArgumentException - if name is not specified.

Method Details

getName

public String getName()

Returns the name assigned to the schema object.

Returns:

the name assigned to the schema object; name is never null.

getType

public abstract SchemaObjectType getType()

Returns the type of schema object defined by this SchemaObjectDefinition.

Returns:

the type of schema object defined by this SchemaObjectDefinition.

See Also:

• SchemaObjectType

create

public void create(GemfireAdminOperations gemfireAdminOperations)

Creates an actual schema object from this SchemaObjectDefinition.

Parameters:

gemfireAdminOperations - GemfireAdminOperations used to create an actual schema object from this SchemaObjectDefinition.

See Also:

• GemfireAdminOperations

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object