com.hazelcast.config.MultiMapConfig Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2016, Hazelcast, Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.hazelcast.config;
import java.util.ArrayList;
import java.util.List;
import static com.hazelcast.util.Preconditions.checkAsyncBackupCount;
import static com.hazelcast.util.Preconditions.checkBackupCount;
/**
* Configuration for MultiMap.
*/
public class MultiMapConfig {
/**
* The default number of synchronous backups for this MultiMap.
*/
public static final int DEFAULT_SYNC_BACKUP_COUNT = 1;
/**
* The default number of asynchronous backups for this MultiMap.
*/
public static final int DEFAULT_ASYNC_BACKUP_COUNT = 0;
/**
* Default value collection type of this MultiMap.
*/
public static final ValueCollectionType DEFAULT_VALUE_COLLECTION_TYPE = ValueCollectionType.SET;
private String name;
private String valueCollectionType = DEFAULT_VALUE_COLLECTION_TYPE.toString();
private List listenerConfigs;
private boolean binary = true;
private int backupCount = DEFAULT_SYNC_BACKUP_COUNT;
private int asyncBackupCount = DEFAULT_ASYNC_BACKUP_COUNT;
private boolean statisticsEnabled = true;
// private PartitioningStrategyConfig partitionStrategyConfig;
private MultiMapConfigReadOnly readOnly;
public MultiMapConfig() {
}
public MultiMapConfig(String name) {
setName(name);
}
public MultiMapConfig(MultiMapConfig defConfig) {
this.name = defConfig.getName();
this.valueCollectionType = defConfig.valueCollectionType;
this.binary = defConfig.binary;
this.backupCount = defConfig.backupCount;
this.asyncBackupCount = defConfig.asyncBackupCount;
this.statisticsEnabled = defConfig.statisticsEnabled;
this.listenerConfigs = new ArrayList(defConfig.getEntryListenerConfigs());
// this.partitionStrategyConfig = defConfig.getPartitioningStrategyConfig();
}
/**
* Gets the immutable version of this MultiMap config.
*
* @return Immutable version of this MultiMap config.
*/
public MultiMapConfigReadOnly getAsReadOnly() {
if (readOnly == null) {
readOnly = new MultiMapConfigReadOnly(this);
}
return readOnly;
}
/**
* Type of value collection
*/
public enum ValueCollectionType {
/**
* Store value collection as set
*/
SET,
/**
* Store value collection as list
*/
LIST
}
/**
* Gets the name of this MultiMap.
*
* @return The name of this MultiMap.
*/
public String getName() {
return name;
}
/**
* Sets the name of this MultiMap.
*
* @param name The name to set for this MultiMap.
* @return This updated MultiMap configuration.
*/
public MultiMapConfig setName(String name) {
this.name = name;
return this;
}
/**
* Gets the collection type for the values of this MultiMap.
*
* @return The collection type for the values of this MultiMap.
*/
public ValueCollectionType getValueCollectionType() {
return ValueCollectionType.valueOf(valueCollectionType.toUpperCase());
}
/**
* Sets the collection type for the values of this MultiMap.
*
* @param valueCollectionType The collection type for the values of this MultiMap (SET or LIST).
* @return This updated MultiMap configuration.
*/
public MultiMapConfig setValueCollectionType(String valueCollectionType) {
this.valueCollectionType = valueCollectionType;
return this;
}
/**
* Sets the collection type for the values of this MultiMap.
*
* @param valueCollectionType The collection type for the values of this MultiMap (SET or LIST).
* @return This updated MultiMap configuration.
*/
public MultiMapConfig setValueCollectionType(ValueCollectionType valueCollectionType) {
this.valueCollectionType = valueCollectionType.toString();
return this;
}
/**
* Adds an entry listener to this MultiMap (listens for when entries are added or removed).
*
* @param listenerConfig The entry listener to add to this MultiMap.
*/
public MultiMapConfig addEntryListenerConfig(EntryListenerConfig listenerConfig) {
getEntryListenerConfigs().add(listenerConfig);
return this;
}
/**
* Gets the list of entry listeners (listens for when entries are added or removed) for this MultiMap.
*
* @return The list of entry listeners for this MultiMap.
*/
public List getEntryListenerConfigs() {
if (listenerConfigs == null) {
listenerConfigs = new ArrayList();
}
return listenerConfigs;
}
/**
* Sets the list of entry listeners (listens for when entries are added or removed) for this MultiMap.
*
* @param listenerConfigs The list of entry listeners for this MultiMap.
* @return This updated MultiMap configuration.
*/
public MultiMapConfig setEntryListenerConfigs(List listenerConfigs) {
this.listenerConfigs = listenerConfigs;
return this;
}
/**
* Checks if the MultiMap is in binary (serialized) form.
*
* @return True if the MultiMap is in binary (serialized) form, false otherwise.
*/
public boolean isBinary() {
return binary;
}
/**
* Enables or disables binary (serialized) form for this MultiMap.
*
* @param binary True to set the MultiMap to binary (serialized) form, false otherwise.
* @return This updated MultiMap configuration.
*/
public MultiMapConfig setBinary(boolean binary) {
this.binary = binary;
return this;
}
@Deprecated
public int getSyncBackupCount() {
return backupCount;
}
@Deprecated
public MultiMapConfig setSyncBackupCount(int syncBackupCount) {
this.backupCount = syncBackupCount;
return this;
}
/**
* Gets the number of synchronous backups for this MultiMap.
*
* @return The number of synchronous backups for this MultiMap.
*/
public int getBackupCount() {
return backupCount;
}
/**
* Sets the number of synchronous backups.
*
* @param backupCount the number of synchronous backups to set for this MultiMap
* @return 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 #setAsyncBackupCount(int)
*/
public MultiMapConfig setBackupCount(int backupCount) {
this.backupCount = checkBackupCount(backupCount, asyncBackupCount);
return this;
}
/**
* Gets the number of asynchronous backups for this MultiMap.
*
* @return The number of asynchronous backups for this MultiMap.
*/
public int getAsyncBackupCount() {
return asyncBackupCount;
}
/**
* Sets the number of asynchronous backups. 0 means no backups
*
* @param asyncBackupCount the number of asynchronous synchronous backups to set
* @return 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 #setBackupCount(int)
* @see #getAsyncBackupCount()
*/
public MultiMapConfig setAsyncBackupCount(int asyncBackupCount) {
this.asyncBackupCount = checkAsyncBackupCount(backupCount, asyncBackupCount);
return this;
}
/**
* Gets the total number of backups (synchronous + asynchronous) for this MultiMap.
*
* @return The total number of backups (synchronous + asynchronous) for this MultiMap.
*/
public int getTotalBackupCount() {
return backupCount + asyncBackupCount;
}
/**
* Checks to see if statistics are enabled for this MultiMap.
*
* @return True if statistics are enabled for this MultiMap, false otherwise.
*/
public boolean isStatisticsEnabled() {
return statisticsEnabled;
}
/**
* Enables or disables statistics for this MultiMap.
*
* @param statisticsEnabled True to enable statistics for this MultiMap, false to disable.
* @return the updated MultiMapConfig
*/
public MultiMapConfig setStatisticsEnabled(boolean statisticsEnabled) {
this.statisticsEnabled = statisticsEnabled;
return this;
}
// public PartitioningStrategyConfig getPartitioningStrategyConfig() {
// return partitionStrategyConfig;
// }
//
// public MultiMapConfig setPartitioningStrategyConfig(PartitioningStrategyConfig partitionStrategyConfig) {
// this.partitionStrategyConfig = partitionStrategyConfig;
// return this;
// }
public String toString() {
return "MultiMapConfig{"
+ "name='" + name + '\''
+ ", valueCollectionType='" + valueCollectionType + '\''
+ ", listenerConfigs=" + listenerConfigs
+ ", binary=" + binary
+ ", backupCount=" + backupCount
+ ", asyncBackupCount=" + asyncBackupCount
+ '}';
}
}