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

Class RegionDefinition

java.lang.Object

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

org.springframework.data.gemfire.config.schema.definitions.RegionDefinition

All Implemented Interfaces:

Serializable, Ordered

public class RegionDefinition
extends SchemaObjectDefinition

RegionDefinition is an Abstract Data Type (ADT) encapsulating the configuration meta-data used to define a new Apache Geode / Pivotal GemFire cache Region.

Since:

2.0.0

Author:

John Blum

See Also:

• Region
• RegionShortcut
• GemfireAdminOperations
• SchemaObjectDefinition
• SchemaObjectType
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final RegionShortcut	DEFAULT_REGION_SHORTCUT
protected static final int	ORDER

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RegionDefinition(Region<?,?> region)	Constructs a new instance of RegionDefinition defined with the given Region.

Method Summary

Modifier and Type	Method	Description
void	create(GemfireAdminOperations gemfireAdminOperations)	Creates an actual schema object from this SchemaObjectDefinition.
static RegionDefinition	from(Region<?,?> region)	Factory method used to construct a new instance of RegionDefinition defined from the given Region.
String	getName()	Returns the name assigned to the schema object.
int	getOrder()	Get the order value of this object.
protected Region<?,?>	getRegion()	Returns a reference to the Region from which this definition is defined.
RegionShortcut	getRegionShortcut()
SchemaObjectType	getType()	Returns the type of schema object defined by this SchemaObjectDefinition.
RegionDefinition	having(RegionShortcut regionShortcut)
RegionDefinition	with(String name)

Methods inherited from class org.springframework.data.gemfire.config.schema.SchemaObjectDefinition

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Field Details

ORDER

protected static final int ORDER

See Also:

• Constant Field Values

DEFAULT_REGION_SHORTCUT

public static final RegionShortcut DEFAULT_REGION_SHORTCUT

Constructor Details

RegionDefinition

protected RegionDefinition(Region<?,?> region)

Constructs a new instance of RegionDefinition defined with the given Region.

Parameters:

region - Region on which this definition is defined; must not be null.

Throws:

IllegalArgumentException - if Region is null.

See Also:

• Region

Method Details

from

public static RegionDefinition from(Region<?,?> region)

Factory method used to construct a new instance of RegionDefinition defined from the given Region.

Parameters:

region - Region from which the new definition will be defined.

Returns:

a new instance of RegionDefinition defined from the given Region.

Throws:

IllegalArgumentException - if Region is null.

See Also:

• Region
• RegionDefinition(Region)

getOrder

public int getOrder()

Get the order value of this object.

Returns:

the order value of this object.

See Also:

• Ordered

getRegion

protected Region<?,?> getRegion()

Returns a reference to the Region from which this definition is defined.

Returns:

a reference to the Region from which this definition is defined.

See Also:

• Region

getName

public String getName()

Description copied from class: SchemaObjectDefinition

Returns the name assigned to the schema object.

Overrides:

getName in class SchemaObjectDefinition

Returns:

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

getRegionShortcut

public RegionShortcut getRegionShortcut()

getType

public SchemaObjectType getType()

Description copied from class: SchemaObjectDefinition

Returns the type of schema object defined by this SchemaObjectDefinition.

Specified by:

getType in class SchemaObjectDefinition

Returns:

the type of schema object defined by this SchemaObjectDefinition.

See Also:

• SchemaObjectType

create

public void create(GemfireAdminOperations gemfireAdminOperations)

Description copied from class: SchemaObjectDefinition

Creates an actual schema object from this SchemaObjectDefinition.

Overrides:

create in class SchemaObjectDefinition

Parameters:

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

See Also:

• GemfireAdminOperations

having

public RegionDefinition having(RegionShortcut regionShortcut)

with

public RegionDefinition with(String name)