org.gradle.internal.buildoption.BooleanBuildOption Maven / Gradle / Ivy
/*
* Copyright 2017 the original author or authors.
*
* 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 org.gradle.internal.buildoption;
import org.gradle.cli.CommandLineParser;
import org.gradle.cli.ParsedCommandLine;
import java.util.Map;
/**
* A build option that takes a boolean value.
*
* If a command line option is provided, this build option automatically creates a disabled option out-of-the-box e.g. {@code "--no-daemon"} for the provided option {@code "--daemon"}.
*
* @since 4.3
*/
public abstract class BooleanBuildOption extends AbstractBuildOption {
public BooleanBuildOption(String gradleProperty) {
super(gradleProperty);
}
public BooleanBuildOption(String gradleProperty, BooleanCommandLineOptionConfiguration... commandLineOptionConfigurations) {
super(gradleProperty, commandLineOptionConfigurations);
}
@Override
public void applyFromProperty(Map properties, T settings) {
String value = properties.get(gradleProperty);
if (value != null) {
applyTo(isTrue(properties.get(gradleProperty)), settings, Origin.forGradleProperty(gradleProperty));
}
}
@Override
public void configure(CommandLineParser parser) {
for (BooleanCommandLineOptionConfiguration config : commandLineOptionConfigurations) {
configureCommandLineOption(parser, new String[] {config.getLongOption()}, config.getDescription(), config.isDeprecated(), config.isIncubating());
String disabledOption = getDisabledCommandLineOption(config);
configureCommandLineOption(parser, new String[] {disabledOption}, config.getDisabledDescription(), config.isDeprecated(), config.isIncubating());
parser.allowOneOf(config.getLongOption(), disabledOption);
}
}
@Override
public void applyFromCommandLine(ParsedCommandLine options, T settings) {
for (BooleanCommandLineOptionConfiguration config : commandLineOptionConfigurations) {
if (options.hasOption(config.getLongOption())) {
applyTo(true, settings, Origin.forCommandLine(config.getLongOption()));
}
if (options.hasOption(getDisabledCommandLineOption(config))) {
applyTo(false, settings, Origin.forCommandLine(getDisabledCommandLineOption(config)));
}
}
}
private String getDisabledCommandLineOption(BooleanCommandLineOptionConfiguration config) {
return "no-" + config.getLongOption();
}
public abstract void applyTo(boolean value, T settings, Origin origin);
}