de.mklinger.commons.exec.CmdBuilderBase Maven / Gradle / Ivy
/*
* Copyright 2013-present mklinger GmbH - http://www.mklinger.de
*
* 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 de.mklinger.commons.exec;
import java.io.File;
import java.io.OutputStream;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.Executor;
import java.util.concurrent.TimeUnit;
import java.util.function.Supplier;
/**
* Base class for
*
* - {@link CmdBuilder}
* - {@link JavaClassCmdBuilder}
* - {@link JavaJarCmdBuilder}
*
* and possibly others.
*
* @author Marc Klinger - mklinger[at]mklinger[dot]de - klingerm
*/
public abstract class CmdBuilderBase> {
private final CmdSettings cmdSettings = new CmdSettings();
private boolean inheritEnvironment = true;
private Set withoutEnvironment = null;
public B stdout(final OutputStream stdout) {
cmdSettings.setStdout(stdout);
return getBuilder();
}
public B stdout(final File stdout) {
cmdSettings.setStdoutFile(stdout);
return getBuilder();
}
public B stdout(final Path stdout) {
return stdout(stdout.toFile());
}
public B stderr(final OutputStream stderr) {
cmdSettings.setStderr(stderr);
return getBuilder();
}
public B stderr(final File stderr) {
cmdSettings.setStderrFile(stderr);
return getBuilder();
}
public B stderr(final Path stderr) {
return stderr(stderr.toFile());
}
public B redirectErrorStream(final boolean redirectErrorStream) {
cmdSettings.setRedirectErrorStream(redirectErrorStream);
return getBuilder();
}
public B stdin(final byte[] stdinBytes) {
cmdSettings.setStdinBytes(stdinBytes);
return getBuilder();
}
public B ping(final Pingable pingable) {
cmdSettings.setPingable(pingable);
return getBuilder();
}
public B directory(final File directory) {
cmdSettings.setDirectory(directory);
return getBuilder();
}
public B directory(final Path directory) {
return directory(directory.toFile());
}
public B inheritEnvironment(final boolean inheritEnvironment) {
this.inheritEnvironment = inheritEnvironment;
return getBuilder();
}
public B environment(final String name, final String value) {
if (cmdSettings.getEnvironment() == null) {
cmdSettings.setEnvironment(new HashMap<>());
}
cmdSettings.getEnvironment().put(name, value);
return getBuilder();
}
public B withoutEnvironment(final String name) {
if (withoutEnvironment == null) {
withoutEnvironment = new HashSet<>();
}
withoutEnvironment.add(name);
return getBuilder();
}
public B timeout(final long timeout) {
cmdSettings.setTimeout(timeout);
return getBuilder();
}
public B timeout(final int duration, final TimeUnit timeUnit) {
return timeout(timeUnit.toMillis(duration));
}
public B destroyOnError(final boolean destroyOnError) {
cmdSettings.setDestroyOnError(destroyOnError);
return getBuilder();
}
public B destroyOnShutdown(final boolean destroyOnShutdown) {
cmdSettings.setDestroyOnShutdown(destroyOnShutdown);
return getBuilder();
}
public B destroyForcibly(final boolean destroyForcibly) {
cmdSettings.setDestroyForcibly(destroyForcibly);
return getBuilder();
}
public B args(final Object... arguments) {
if (cmdSettings.getCommand() == null) {
cmdSettings.setCommand(new ArrayList());
}
addArguments(cmdSettings.getCommand(), arguments);
return getBuilder();
}
public B arg(final Object argument) {
if (cmdSettings.getCommand() == null) {
cmdSettings.setCommand(new ArrayList());
}
addArguments(cmdSettings.getCommand(), argument);
return getBuilder();
}
private void addArguments(final List command, final Object... arguments) {
if (arguments == null) {
return;
}
for (final Object o : arguments) {
if (o == null) {
continue;
}
if (o.getClass().isArray()) {
addArguments(command, (Object[])o);
} else if (Collection.class.isAssignableFrom(o.getClass())) {
final Collection c = (Collection)o;
final Object[] array = new Object[c.size()];
int idx = 0;
for (final Object object : c) {
array[idx] = object;
idx++;
}
addArguments(command, array);
} else if (File.class.isAssignableFrom(o.getClass())) {
command.add(((File)o).getAbsolutePath());
} else {
command.add(String.valueOf(o));
}
}
}
public B executorSupplier(final Supplier executorSupplier) {
cmdSettings.setExecutorSupplier(executorSupplier);
return getBuilder();
}
public CmdSettings toCmdSettings() {
final CmdSettings cmdSettings = new CmdSettings(this.cmdSettings);
Map env = null;
final Map settingsEnv = cmdSettings.getEnvironment();
if (inheritEnvironment && settingsEnv != null) {
env = new HashMap<>(System.getenv());
env.putAll(settingsEnv);
}
if (withoutEnvironment != null) {
if (env == null) {
if (settingsEnv != null) {
env = new HashMap<>(settingsEnv);
} else {
env = new HashMap<>();
}
}
for (final String name : withoutEnvironment) {
env.remove(name);
}
}
if (env != null) {
cmdSettings.setEnvironment(env);
}
return cmdSettings;
}
public Cmd toCmd() {
final CmdSettings clone = toCmdSettings();
clone.freeze();
return new Cmd(clone);
}
@SuppressWarnings("unchecked")
protected B getBuilder() {
return (B)this;
}
}