Package org.springframework.data.gemfire.util

Class RegionUtils

java.lang.Object

org.springframework.data.gemfire.util.SpringUtils

org.springframework.data.gemfire.util.DistributedSystemUtils

org.springframework.data.gemfire.util.CacheUtils

org.springframework.data.gemfire.util.RegionUtils

Direct Known Subclasses:

GemfireUtils

public abstract class RegionUtils
extends CacheUtils

The RegionUtils class is an abstract utility class for working with Regions.

Since:

2.0.0

Author:

John Blum

See Also:

• Region
• RegionAttributes

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.data.gemfire.util.SpringUtils

SpringUtils.OrderedBeanWrapper<T>, SpringUtils.ValueReturningThrowableOperation<T>, SpringUtils.VoidReturningThrowableOperation

Field Summary

Fields inherited from class org.springframework.data.gemfire.util.CacheUtils

DEFAULT_POOL_NAME

Fields inherited from class org.springframework.data.gemfire.util.DistributedSystemUtils

DEFAULT_CACHE_SERVER_PORT, DEFAULT_LOCATOR_PORT, DURABLE_CLIENT_ID_PROPERTY_NAME, DURABLE_CLIENT_TIMEOUT_PROPERTY_NAME, GEMFIRE_PREFIX, NAME_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
RegionUtils()

Method Summary

Modifier and Type	Method	Description
static void	assertClientRegionShortcutAndPersistentAttributeAreCompatible(ClientRegionShortcut clientRegionShortcut, Boolean persistent)	Assert that the configuration settings for ClientRegionShortcut and the persistent attribute in <gfe:*-region> elements are compatible.
static void	assertDataPolicyAndPersistentAttributeAreCompatible(DataPolicy dataPolicy, Boolean persistent)	Assert that the configuration settings for DataPolicy and the persistent attribute in <gfe:*-region> elements are compatible.
static boolean	close(Region<?,?> region)	Safely closes the target Region.
static boolean	isClient(Region<?,?> region)	Determines whether the target Region is a client Region.
static boolean	isCloseable(Region<?,?> region)	Determines whether the given Region is closeable.
static boolean	isLocal(Region<?,?> region)	Determines whether the given Region is a non-distributed, local Region.
static boolean	isServer(Region<?,?> region)	Determines whether the target Region is a server-side Region.
static String	toRegionName(String regionPath)
static String	toRegionName(Region<?,?> region)
static String	toRegionPath(String regionName)
static String	toRegionPath(Region<?,?> region)

Methods inherited from class org.springframework.data.gemfire.util.CacheUtils

close, close, close, closeCache, closeClientCache, getCache, getClientCache, isClient, isDefaultPool, isDefaultPool, isDurable, isNotDefaultPool, isNotDefaultPool, isPeer, resolveGemFireCache

Methods inherited from class org.springframework.data.gemfire.util.DistributedSystemUtils

configureDurableClient, getDistributedSystem, getDistributedSystem, getLocator, isConnected, isNotConnected

Methods inherited from class org.springframework.data.gemfire.util.SpringUtils

addDependsOn, areNotNull, defaultIfEmpty, defaultIfEmpty, defaultIfNull, defaultIfNull, dereferenceBean, equalsIgnoreNull, getBeansOfTypeOrdered, getBeansOfTypeOrdered, getOrder, getOrderedStreamOfBeansByType, getPropertyValue, isMatchingBean, nullOrEquals, nullSafeEquals, nullSafeName, nullSafeSimpleName, nullSafeType, nullSafeType, requireObject, requireObject, safeDoOperation, safeDoOperation, safeGetValue, safeGetValue, safeGetValue, safeGetValue, safeRunOperation, safeRunOperation, setPropertyReference, setPropertyValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RegionUtils

public RegionUtils()

Method Details

assertClientRegionShortcutAndPersistentAttributeAreCompatible

public static void assertClientRegionShortcutAndPersistentAttributeAreCompatible(ClientRegionShortcut clientRegionShortcut,
 Boolean persistent)

Assert that the configuration settings for ClientRegionShortcut and the persistent attribute in <gfe:*-region> elements are compatible.

Parameters:

clientRegionShortcut - ClientRegionShortcut resolved from the SDG XML namespace.

persistent - boolean indicating the value of the persistent configuration attribute.

See Also:

• ClientRegionShortcutWrapper
• ClientRegionShortcut

assertDataPolicyAndPersistentAttributeAreCompatible

public static void assertDataPolicyAndPersistentAttributeAreCompatible(DataPolicy dataPolicy,
 Boolean persistent)

Assert that the configuration settings for DataPolicy and the persistent attribute in <gfe:*-region> elements are compatible.

Parameters:

dataPolicy - DataPolicy resolved from the SDG XML namespace.

persistent - boolean indicating the value of the persistent configuration attribute.

See Also:

• DataPolicy

close

public static boolean close(Region<?,?> region)

Safely closes the target Region.

Parameters:

region - Region to close

Returns:

a boolean indicating whether the Region was successfully closed or not.

See Also:

• Region.close()

isClient

public static boolean isClient(@Nullable
 Region<?,?> region)

Determines whether the target Region is a client Region.

Parameters:

region - Region to evaluate.

Returns:

a boolean indicating whether the target Region is a client Region.

See Also:

• Region

isCloseable

public static boolean isCloseable(Region<?,?> region)

Determines whether the given Region is closeable.

Parameters:

region - Region to evaluate.

Returns:

a boolean value indicating whether the Region is closeable or not.

See Also:

• Region

isLocal

public static boolean isLocal(@Nullable
 Region<?,?> region)

Determines whether the given Region is a non-distributed, local Region.

Parameters:

region - Region to evaluate.

Returns:

a boolean value indicating whether the given Region is a non-distributed, local Region.

See Also:

• Region

toRegionName

@Nullable
public static String toRegionName(@Nullable
 Region<?,?> region)

toRegionName

@Nullable
public static String toRegionName(String regionPath)

toRegionPath

@Nullable
public static String toRegionPath(@Nullable
 Region<?,?> region)

toRegionPath

@NonNull
public static String toRegionPath(String regionName)

isServer

public static boolean isServer(@Nullable
 Region<?,?> region)

Determines whether the target Region is a server-side Region.

Parameters:

region - Region to evaluate.

Returns:

a boolean indicating whether the target Region is a server-side Region.

See Also:

• Region