Package org.springframework.data.gemfire.mapping

Class Regions

java.lang.Object

org.springframework.data.gemfire.mapping.Regions

All Implemented Interfaces:

Iterable<Region<?,?>>

public class Regions
extends Object
implements Iterable<Region<?,?>>

Simple value object to abstract access to Regions by name and mapped type.

Author:

Oliver Gierke, John Blum

See Also:

• Iterable
• Region

Constructor Summary

Constructors

Constructor	Description
Regions(Iterable<Region<?,?>> regions, MappingContext<? extends GemfirePersistentEntity<?>,?> mappingContext)	Constructs a new instance of the Regions wrapper for the given Regions and MappingContext.

Method Summary

Modifier and Type	Method	Description
<T> Region<?,T>	getRegion(Class<T> entityType)	Returns the Region the given type is mapped to.
<S, T> Region<S,T>	getRegion(String namePath)	Returns the Region with the given name or path.
Iterator<Region<?,?>>	iterator()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

Regions

public Regions(@NonNull
 Iterable<Region<?,?>> regions,
 @NonNull
 MappingContext<? extends GemfirePersistentEntity<?>,?> mappingContext)

Constructs a new instance of the Regions wrapper for the given Regions and MappingContext.

Parameters:

regions - Iterable of cache Regions; must not be null.

mappingContext - Spring Data MappingContext used for data mapping; must not be null.

See Also:

• MappingContext
• Region
• Iterable

Method Details

getRegion

public <T> Region<?,T> getRegion(Class<T> entityType)

Returns the Region the given type is mapped to. Will try to find a Region with the simple class name in case no mapping information is found.

Type Parameters:

T - the Region value class type.

Parameters:

entityType - must not be null.

Returns:

the Region the given type is mapped to.

getRegion

public <S,
T> Region<S,T> getRegion(String namePath)

Returns the Region with the given name or path.

Type Parameters:

S - the Region key class type.

T - the Region value class type.

Parameters:

namePath - must not be null, and either identifies the Region by name or the fully-qualified path.

Returns:

the Region with the given name or path.

iterator

public Iterator<Region<?,?>> iterator()

Specified by:

iterator in interface Iterable<Region<?,?>>