Package org.gridgain.structure

Class MapConfiguration

java.lang.Object

org.gridgain.structure.MapConfiguration

public class MapConfiguration
extends Object

Configuration for a IgniteMap structure.
If keyClass or valueClass is not natively supported, falls back to byte[] with corresponding marshaller.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MapConfiguration.Builder	Builder for MapConfiguration.

Method Summary

Modifier and Type	Method	Description
static MapConfiguration.Builder	builder(String mapName, Class<?> keyClass, Class<?> valueClass)	Creates a new builder for map with the specified name.
static MapConfiguration.Builder	builder(String mapName, Marshaller<?,byte[]> keyMarshaller, Marshaller<?,byte[]> valueMarshaller)	Creates a new builder for map with the specified name.
@Nullable String	getDistributionZone()	Returns map distribution zone.
Class<?>	getKeyClass()	Returns map key class.
Marshaller<?,byte[]>	getKeyMarshaller()	Returns map key marshaller.
QualifiedName	getName()	Returns map name.
@Nullable String	getStorageProfile()	Returns map storage profile.
Class<?>	getValueClass()	Returns map value class.
Marshaller<?,byte[]>	getValueMarshaller()	Returns map value marshaller.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static MapConfiguration.Builder builder(String mapName,
 Class<?> keyClass,
 Class<?> valueClass)

Creates a new builder for map with the specified name.
If keyClass or valueClass is not natively supported, falls back to byte[] with corresponding marshaller.

Parameters:

mapName - The IgniteMap's name.

keyClass - The IgniteMap's key type.

valueClass - The IgniteMap's value type.

Returns:

Builder.

builder

public static MapConfiguration.Builder builder(String mapName,
 Marshaller<?,byte[]> keyMarshaller,
 Marshaller<?,byte[]> valueMarshaller)

Creates a new builder for map with the specified name.

Parameters:

mapName - The IgniteMap's name.

keyMarshaller - The IgniteMap's key marshaller.

valueMarshaller - The IgniteMap's value marshaller.

Returns:

Builder.

getName

public QualifiedName getName()

Returns map name.

Returns:

The IgniteMap's name.

getKeyClass

public Class<?> getKeyClass()

Returns map key class.

Returns:

The IgniteMap's key class.

getValueClass

public Class<?> getValueClass()

Returns map value class.

Returns:

The IgniteMap's value class.

getKeyMarshaller

public Marshaller<?,byte[]> getKeyMarshaller()

Returns map key marshaller.

Returns:

The IgniteMap's key marshaller.

getValueMarshaller

public Marshaller<?,byte[]> getValueMarshaller()

Returns map value marshaller.

Returns:

The IgniteMap's value marshaller.

getDistributionZone

@Nullable
public @Nullable String getDistributionZone()

Returns map distribution zone.

Returns:

The IgniteMap's distribution zone.

getStorageProfile

@Nullable
public @Nullable String getStorageProfile()

Returns map storage profile.

Returns:

The IgniteMap's storage profile.