com.hazelcast.config

Class MultiMapConfig

java.lang.Object

com.hazelcast.config.MultiMapConfig

Direct Known Subclasses:

MultiMapConfigReadOnly

public class MultiMapConfig
extends Object

Configuration for MultiMap.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MultiMapConfig.ValueCollectionType Type of value collection

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_ASYNC_BACKUP_COUNT The default number of asynchronous backups for this MultiMap.
static int	DEFAULT_SYNC_BACKUP_COUNT The default number of synchronous backups for this MultiMap.
static MultiMapConfig.ValueCollectionType	DEFAULT_VALUE_COLLECTION_TYPE Default value collection type of this MultiMap.

Constructor Summary

Constructors

Constructor and Description
MultiMapConfig()
MultiMapConfig(MultiMapConfig defConfig)
MultiMapConfig(String name)

Method Summary

Modifier and Type	Method and Description
MultiMapConfig	addEntryListenerConfig(EntryListenerConfig listenerConfig) Adds an entry listener to this MultiMap (listens for when entries are added or removed).
MultiMapConfigReadOnly	getAsReadOnly() Deprecated. this method will be removed in 4.0; it is meant for internal usage only.
int	getAsyncBackupCount() Gets the number of asynchronous backups for this MultiMap.
int	getBackupCount() Gets the number of synchronous backups for this MultiMap.
List<EntryListenerConfig>	getEntryListenerConfigs() Gets the list of entry listeners (listens for when entries are added or removed) for this MultiMap.
String	getName() Gets the name of this MultiMap.
int	getSyncBackupCount() Deprecated.
int	getTotalBackupCount() Gets the total number of backups (synchronous + asynchronous) for this MultiMap.
MultiMapConfig.ValueCollectionType	getValueCollectionType() Gets the collection type for the values of this MultiMap.
boolean	isBinary() Checks if the MultiMap is in binary (serialized) form.
boolean	isStatisticsEnabled() Checks to see if statistics are enabled for this MultiMap.
MultiMapConfig	setAsyncBackupCount(int asyncBackupCount) Sets the number of asynchronous backups.
MultiMapConfig	setBackupCount(int backupCount) Sets the number of synchronous backups.
MultiMapConfig	setBinary(boolean binary) Enables or disables binary (serialized) form for this MultiMap.
MultiMapConfig	setEntryListenerConfigs(List<EntryListenerConfig> listenerConfigs) Sets the list of entry listeners (listens for when entries are added or removed) for this MultiMap.
MultiMapConfig	setName(String name) Sets the name of this MultiMap.
MultiMapConfig	setStatisticsEnabled(boolean statisticsEnabled) Enables or disables statistics for this MultiMap.
MultiMapConfig	setSyncBackupCount(int syncBackupCount) Deprecated.
MultiMapConfig	setValueCollectionType(MultiMapConfig.ValueCollectionType valueCollectionType) Sets the collection type for the values of this MultiMap.
MultiMapConfig	setValueCollectionType(String valueCollectionType) Sets the collection type for the values of this MultiMap.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SYNC_BACKUP_COUNT

public static final int DEFAULT_SYNC_BACKUP_COUNT

The default number of synchronous backups for this MultiMap.

See Also:

Constant Field Values

DEFAULT_ASYNC_BACKUP_COUNT

public static final int DEFAULT_ASYNC_BACKUP_COUNT

The default number of asynchronous backups for this MultiMap.

See Also:

Constant Field Values

DEFAULT_VALUE_COLLECTION_TYPE

public static final MultiMapConfig.ValueCollectionType DEFAULT_VALUE_COLLECTION_TYPE

Default value collection type of this MultiMap.

Constructor Detail

MultiMapConfig

public MultiMapConfig()

MultiMapConfig

public MultiMapConfig(String name)

MultiMapConfig

public MultiMapConfig(MultiMapConfig defConfig)

Method Detail

getAsReadOnly

public MultiMapConfigReadOnly getAsReadOnly()

Deprecated. this method will be removed in 4.0; it is meant for internal usage only.

Gets immutable version of this configuration.

Returns:

Immutable version of this configuration.

getName

public String getName()

Gets the name of this MultiMap.

Returns:

The name of this MultiMap.

setName

public MultiMapConfig setName(String name)

Sets the name of this MultiMap.

Parameters:

name - The name to set for this MultiMap.

Returns:

This updated MultiMap configuration.

getValueCollectionType

public MultiMapConfig.ValueCollectionType getValueCollectionType()

Gets the collection type for the values of this MultiMap.

Returns:

The collection type for the values of this MultiMap.

setValueCollectionType

public MultiMapConfig setValueCollectionType(String valueCollectionType)

Sets the collection type for the values of this MultiMap.

Parameters:

valueCollectionType - The collection type for the values of this MultiMap (SET or LIST).

Returns:

This updated MultiMap configuration.

setValueCollectionType

public MultiMapConfig setValueCollectionType(MultiMapConfig.ValueCollectionType valueCollectionType)

Sets the collection type for the values of this MultiMap.

Parameters:

valueCollectionType - The collection type for the values of this MultiMap (SET or LIST).

Returns:

This updated MultiMap configuration.

addEntryListenerConfig

public MultiMapConfig addEntryListenerConfig(EntryListenerConfig listenerConfig)

Adds an entry listener to this MultiMap (listens for when entries are added or removed).

Parameters:

listenerConfig - The entry listener to add to this MultiMap.

getEntryListenerConfigs

public List<EntryListenerConfig> getEntryListenerConfigs()

Gets the list of entry listeners (listens for when entries are added or removed) for this MultiMap.

Returns:

The list of entry listeners for this MultiMap.

setEntryListenerConfigs

public MultiMapConfig setEntryListenerConfigs(List<EntryListenerConfig> listenerConfigs)

Sets the list of entry listeners (listens for when entries are added or removed) for this MultiMap.

Parameters:

listenerConfigs - The list of entry listeners for this MultiMap.

Returns:

This updated MultiMap configuration.

isBinary

public boolean isBinary()

Checks if the MultiMap is in binary (serialized) form.

Returns:

True if the MultiMap is in binary (serialized) form, false otherwise.

setBinary

public MultiMapConfig setBinary(boolean binary)

Enables or disables binary (serialized) form for this MultiMap.

Parameters:

binary - True to set the MultiMap to binary (serialized) form, false otherwise.

Returns:

This updated MultiMap configuration.

getSyncBackupCount

@Deprecated
public int getSyncBackupCount()

Deprecated.

setSyncBackupCount

@Deprecated
public MultiMapConfig setSyncBackupCount(int syncBackupCount)

Deprecated.

getBackupCount

public int getBackupCount()

Gets the number of synchronous backups for this MultiMap.

Returns:

The number of synchronous backups for this MultiMap.

setBackupCount

public MultiMapConfig setBackupCount(int backupCount)

Sets the number of synchronous backups.

Parameters:

backupCount - the number of synchronous backups to set for this MultiMap

Returns:

the current MultiMapConfig

Throws:

IllegalArgumentException - if backupCount smaller than 0, or larger than the maximum number of backup or the sum of the backups and async backups is larger than the maximum number of backups

See Also:

setAsyncBackupCount(int)

getAsyncBackupCount

public int getAsyncBackupCount()

Gets the number of asynchronous backups for this MultiMap.

Returns:

The number of asynchronous backups for this MultiMap.

setAsyncBackupCount

public MultiMapConfig setAsyncBackupCount(int asyncBackupCount)

Sets the number of asynchronous backups. 0 means no backups

Parameters:

asyncBackupCount - the number of asynchronous synchronous backups to set

Returns:

the updated MultiMapConfig

Throws:

IllegalArgumentException - if asyncBackupCount smaller than 0, or larger than the maximum number of backup or the sum of the backups and async backups is larger than the maximum number of backups

See Also:

setBackupCount(int), getAsyncBackupCount()

getTotalBackupCount

public int getTotalBackupCount()

Gets the total number of backups (synchronous + asynchronous) for this MultiMap.

Returns:

The total number of backups (synchronous + asynchronous) for this MultiMap.

isStatisticsEnabled

public boolean isStatisticsEnabled()

Checks to see if statistics are enabled for this MultiMap.

Returns:

True if statistics are enabled for this MultiMap, false otherwise.

setStatisticsEnabled

public MultiMapConfig setStatisticsEnabled(boolean statisticsEnabled)

Enables or disables statistics for this MultiMap.

Parameters:

statisticsEnabled - True to enable statistics for this MultiMap, false to disable.

Returns:

the updated MultiMapConfig

toString

public String toString()

Overrides:

toString in class Object