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
.Region
,
RegionShortcut
,
GemfireAdminOperations
,
SchemaObjectDefinition
,
SchemaObjectType
,
Serialized FormModifier and Type | Field and Description |
---|---|
static org.apache.geode.cache.RegionShortcut |
DEFAULT_REGION_SHORTCUT |
protected static int |
ORDER |
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
Modifier | Constructor and Description |
---|---|
protected |
RegionDefinition(org.apache.geode.cache.Region<?,?> region)
Constructs a new instance of
RegionDefinition defined with the given Region . |
Modifier and Type | Method and Description |
---|---|
void |
create(GemfireAdminOperations gemfireAdminOperations)
Creates an actual schema object from this
SchemaObjectDefinition . |
static RegionDefinition |
from(org.apache.geode.cache.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 org.apache.geode.cache.Region<?,?> |
getRegion()
Returns a reference to the
Region from which this definition is defined. |
org.apache.geode.cache.RegionShortcut |
getRegionShortcut() |
SchemaObjectType |
getType()
Returns the
type of schema object defined by this SchemaObjectDefinition . |
RegionDefinition |
having(org.apache.geode.cache.RegionShortcut regionShortcut) |
RegionDefinition |
with(String name) |
equals, hashCode, toString
protected static final int ORDER
public static final org.apache.geode.cache.RegionShortcut DEFAULT_REGION_SHORTCUT
protected RegionDefinition(org.apache.geode.cache.Region<?,?> region)
RegionDefinition
defined with the given Region
.region
- Region
on which this definition is defined; must not be null.IllegalArgumentException
- if Region
is null.Region
public static RegionDefinition from(org.apache.geode.cache.Region<?,?> region)
RegionDefinition
defined from
the given Region
.region
- Region
from which the new definition will be defined.RegionDefinition
defined from the given Region
.IllegalArgumentException
- if Region
is null.Region
,
RegionDefinition(Region)
public int getOrder()
Ordered
protected org.apache.geode.cache.Region<?,?> getRegion()
Region
from which this definition is defined.Region
from which this definition is defined.Region
public String getName()
SchemaObjectDefinition
name
assigned to the schema object.getName
in class SchemaObjectDefinition
name
assigned to the schema object; name is never null.public org.apache.geode.cache.RegionShortcut getRegionShortcut()
public SchemaObjectType getType()
SchemaObjectDefinition
type
of schema object defined by this SchemaObjectDefinition
.getType
in class SchemaObjectDefinition
type
of schema object defined by this SchemaObjectDefinition
.SchemaObjectType
public void create(GemfireAdminOperations gemfireAdminOperations)
SchemaObjectDefinition
SchemaObjectDefinition
.create
in class SchemaObjectDefinition
gemfireAdminOperations
- GemfireAdminOperations
used to create an actual schema object from this
SchemaObjectDefinition
.GemfireAdminOperations
public RegionDefinition having(org.apache.geode.cache.RegionShortcut regionShortcut)
public RegionDefinition with(String name)
Copyright © 2011–2021 Pivotal Software, Inc.. All rights reserved.