Skip to content

Modify copy mechanism of unused properties in configuration builder #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Modify copy mechanism of unused properties in configuration builder #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
75ea993
Modify copy mechanism in config (builder)
MartinSpiessl Jan 15, 2019
a653285
Make field final that can be made final
MartinSpiessl Jan 24, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions src/org/sosy_lab/common/configuration/Configuration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@ public final class Configuration {

private static boolean secureMode = false;

private final Configuration parent;

/** Create a new Builder instance. */
public static ConfigurationBuilder builder() {
return new ConfigurationBuilder();
Expand All @@ -116,6 +118,7 @@ public static Configuration defaultConfiguration() {
new HashSet<>(0),
new HashSet<>(0),
null,
null,
null);
}

Expand All @@ -131,7 +134,8 @@ public static Configuration copyWithNewPrefix(Configuration oldConfig, String ne
oldConfig.unusedProperties,
oldConfig.deprecatedProperties,
oldConfig.printUsedOptions,
oldConfig.logger);
oldConfig.logger,
oldConfig);
}

/** Splitter to create string arrays. */
Expand Down Expand Up @@ -291,7 +295,8 @@ LogManager getLogger() {
Set<String> pUnusedProperties,
Set<String> pDeprecatedProperties,
@Nullable PrintStream pPrintUsedOptions,
@Nullable LogManager pLogger) {
@Nullable LogManager pLogger,
@Nullable Configuration pParent) {

checkNotNull(pProperties);
checkNotNull(pSources);
Expand All @@ -306,6 +311,7 @@ LogManager getLogger() {
deprecatedProperties = checkNotNull(pDeprecatedProperties);
printUsedOptions = pPrintUsedOptions;
logger = firstNonNull(pLogger, LogManager.createNullLogManager());
parent = pParent;
}

public void enableLogging(LogManager pLogger) {
Expand Down Expand Up @@ -335,10 +341,16 @@ public String getProperty(String key) {
checkNotNull(key);
@Var String result = properties.get(prefix + key);
unusedProperties.remove(prefix + key);
if (parent != null && result != null && result.equals(parent.getProperty(prefix + key))) {
parent.unusedProperties.remove(prefix + key);
}

if (result == null && !prefix.isEmpty()) {
result = properties.get(key);
unusedProperties.remove(key);
if (parent != null && result != null && result.equals(parent.getProperty(key))) {
parent.unusedProperties.remove(key);
}
}
return result;
}
Expand Down
16 changes: 11 additions & 5 deletions src/org/sosy_lab/common/configuration/ConfigurationBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import static com.google.common.base.Preconditions.checkState;

import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Sets;
import com.google.common.io.CharSource;
import com.google.common.io.Resources;
import com.google.errorprone.annotations.CanIgnoreReturnValue;
Expand Down Expand Up @@ -122,8 +123,10 @@ public ConfigurationBuilder setPrefix(String newPrefix) {

/**
* Copy everything from an existing Configuration instance. This also means that the new
* configuration object created by this builder will share the set of unused properties with the
* configuration instance passed to this class.
* configuration object created by this builder will update the set of unused properties of the
* configuration instance passed to this class in case a property is requested. The new
* configuration will keep track of unused properties only for properties that are not present in
* the passed instance.
*
* <p>If this method is called, it has to be the first method call on this builder instance.
*
Expand Down Expand Up @@ -374,7 +377,8 @@ public Configuration build() throws InvalidConfigurationException {
Set<String> newDeprecatedProperties;
if (oldConfig != null) {
// share the same set of unused properties
newUnusedProperties = oldConfig.unusedProperties;
newUnusedProperties =
new HashSet<>(Sets.difference(newProperties.keySet(), oldConfig.properties.keySet()));
newDeprecatedProperties = oldConfig.deprecatedProperties;
} else {
newUnusedProperties = new HashSet<>(newProperties.keySet());
Expand All @@ -394,7 +398,8 @@ public Configuration build() throws InvalidConfigurationException {
newUnusedProperties,
newDeprecatedProperties,
oldConfig != null ? oldConfig.getUsedOptionsPrintStream() : null,
oldConfig != null ? oldConfig.getLogger() : null);
oldConfig != null ? oldConfig.getLogger() : null,
oldConfig);

// reset builder instance so that it may be re-used
properties = null;
Expand Down Expand Up @@ -432,7 +437,8 @@ private ImmutableMap<Class<?>, TypeConverter> buildNewConverters(
newUnusedProperties,
newDeprecatedProperties,
oldConfig != null ? oldConfig.getUsedOptionsPrintStream() : null,
oldConfig != null ? oldConfig.getLogger() : null);
oldConfig != null ? oldConfig.getLogger() : null,
oldConfig);

// This map serves as a cache: if a single TypeConverter is used for multiple types,
// we call getInstanceForNewConfiguration only once and use the new instance several times.
Expand Down