com.hazelcast.config

Class CollectionConfig<T extends CollectionConfig>

java.lang.Object

com.hazelcast.config.CollectionConfig<T>

Type Parameters:

T - Type of Collection such as List, Set

Direct Known Subclasses:

ListConfig, SetConfig

public abstract class CollectionConfig<T extends CollectionConfig>
extends Object

Provides configuration service for Collection.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_ASYNC_BACKUP_COUNT The default number of asynchronous backups
static int	DEFAULT_MAX_SIZE Default maximum size for the Configuration.
static int	DEFAULT_SYNC_BACKUP_COUNT The default number of synchronous backups

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CollectionConfig()
protected	CollectionConfig(CollectionConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
void	addItemListenerConfig(ItemListenerConfig itemListenerConfig) Adds an item listener to this collection (listens for when items are added or removed).
abstract T	getAsReadOnly()
int	getAsyncBackupCount() Gets the number of asynchronous backups.
int	getBackupCount() Gets the number of synchronous backups for this collection.
List<ItemListenerConfig>	getItemListenerConfigs() Gets the list of ItemListenerConfigs.
int	getMaxSize() Gets the maximum size for the Configuration.
String	getName() Gets the name of this collection.
int	getTotalBackupCount() Gets the total number of synchronous and asynchronous backups for this collection.
boolean	isStatisticsEnabled() Checks if collection statistics are enabled.
T	setAsyncBackupCount(int asyncBackupCount) Sets the number of asynchronous backups.
T	setBackupCount(int backupCount) Sets the number of synchronous backups for this collection.
T	setItemListenerConfigs(List<ItemListenerConfig> listenerConfigs) Sets the list of ItemListenerConfigs.
T	setMaxSize(int maxSize) Sets the maximum size for the collection.
T	setName(String name) Sets the name of this collection.
T	setStatisticsEnabled(boolean statisticsEnabled) Sets collection statistics to enabled or disabled.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_SIZE

public static final int DEFAULT_MAX_SIZE

Default maximum size for the Configuration.

See Also:

Constant Field Values

DEFAULT_SYNC_BACKUP_COUNT

public static final int DEFAULT_SYNC_BACKUP_COUNT

The default number of synchronous backups

See Also:

Constant Field Values

DEFAULT_ASYNC_BACKUP_COUNT

public static final int DEFAULT_ASYNC_BACKUP_COUNT

The default number of asynchronous backups

See Also:

Constant Field Values

Constructor Detail

CollectionConfig

protected CollectionConfig()

CollectionConfig

protected CollectionConfig(CollectionConfig config)

Method Detail

getAsReadOnly

public abstract T getAsReadOnly()

getName

public String getName()

Gets the name of this collection.

Returns:

The name of this collection.

setName

public T setName(String name)

Sets the name of this collection.

Parameters:

name - The name of this collection.

Returns:

The updated collection configuration.

getItemListenerConfigs

public List<ItemListenerConfig> getItemListenerConfigs()

Gets the list of ItemListenerConfigs.

Returns:

The list of ItemListenerConfigs.

setItemListenerConfigs

public T setItemListenerConfigs(List<ItemListenerConfig> listenerConfigs)

Sets the list of ItemListenerConfigs.

Parameters:

listenerConfigs - The list of ItemListenerConfigs to set.

Returns:

This collection configuration.

getTotalBackupCount

public int getTotalBackupCount()

Gets the total number of synchronous and asynchronous backups for this collection.

Returns:

The total number of synchronous and asynchronous backups for this collection.

getBackupCount

public int getBackupCount()

Gets the number of synchronous backups for this collection.

Returns:

the number of synchronous backups for this collection.

setBackupCount

public T setBackupCount(int backupCount)

Sets the number of synchronous backups for this collection.

Parameters:

backupCount - the number of synchronous backups to set for this collection.

Returns:

the current CollectionConfig

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.

Returns:

The number of asynchronous backups.

setAsyncBackupCount

public T setAsyncBackupCount(int asyncBackupCount)

Sets the number of asynchronous backups.

Parameters:

asyncBackupCount - the number of asynchronous synchronous backups to set

Returns:

the updated CollectionConfig

Throws:

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

See Also:

setBackupCount(int), getAsyncBackupCount()

getMaxSize

public int getMaxSize()

Gets the maximum size for the Configuration.

Returns:

The maximum size for the Configuration.

setMaxSize

public T setMaxSize(int maxSize)

Sets the maximum size for the collection.

Returns:

The maximum size to set for the collection.

isStatisticsEnabled

public boolean isStatisticsEnabled()

Checks if collection statistics are enabled.

Returns:

True if collection statistics are enabled, false otherwise.

setStatisticsEnabled

public T setStatisticsEnabled(boolean statisticsEnabled)

Sets collection statistics to enabled or disabled.

Parameters:

statisticsEnabled - True to enable collection statistics, false to disable.

Returns:

The current collection config instance.

addItemListenerConfig

public void addItemListenerConfig(ItemListenerConfig itemListenerConfig)

Adds an item listener to this collection (listens for when items are added or removed).

Parameters:

itemListenerConfig - The item listener to add to this collection.