/*
* Copyright 2011 Red Hat, Inc. and/or its affiliates.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA
*/
package org.infinispan.configuration.cache;
/**
* Controls certain tuning parameters that may break some of Infinispan's public API contracts in exchange for better
* performance in some cases.
* <p />
* Use with care, only after thoroughly reading and understanding the documentation about a specific feature.
* <p />
*/
public class UnsafeConfigurationBuilder extends AbstractConfigurationChildBuilder<UnsafeConfiguration> {
private boolean unreliableReturnValues = false;
protected UnsafeConfigurationBuilder(ConfigurationBuilder builder) {
super(builder);
}
/**
* Specify whether Infinispan is allowed to disregard the {@link Map} contract when providing return values for
* {@link org.infinispan.Cache#put(Object, Object)} and {@link org.infinispan.Cache#remove(Object)} methods.
* <p />
* Providing return values can be expensive as they may entail a read from disk or across a network, and if the usage
* of these methods never make use of these return values, allowing unreliable return values helps Infinispan
* optimize away these remote calls or disk reads.
* <p />
* @param allowUnreliableReturnValues if true, return values for the methods described above should not be relied on.
*/
public UnsafeConfigurationBuilder unreliableReturnValues(boolean allowUnreliableReturnValues) {
this.unreliableReturnValues = allowUnreliableReturnValues;
return this;
}
@Override
void validate() {
// Nothing to validate
}
@Override
UnsafeConfiguration create() {
return new UnsafeConfiguration(unreliableReturnValues);
}
@Override
public UnsafeConfigurationBuilder read(UnsafeConfiguration template) {
this.unreliableReturnValues = template.unreliableReturnValues();
return this;
}
@Override
public String toString() {
return "UnsafeConfigurationBuilder{" +
"unreliableReturnValues=" + unreliableReturnValues +
'}';
}
}