org.cp.elements.process.ProcessExecutor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cp-elements Show documentation

Java Simplified. Extensions and Useful Constructs for the Java Platform. Codeprimate Elements (a.k.a. cp-elements) is a Java library and micro-framework used to simplify the development of software applications written in Java. Elements packages several APIs into one library in order to address various application concerns and aspects of software design and development collectively and conveniently. Elements is a highly simple, yet robust and proven library built on solid OO principles, software design patterns and best practices to effectively solve common and reoccurring problems in software development.

There is a newer version: 2.0.0-M1

Show newest version

/*
 * Copyright 2016 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.cp.elements.process;

import static org.cp.elements.io.FileSystemUtils.WORKING_DIRECTORY;
import static org.cp.elements.util.ArrayUtils.asArray;

import java.io.File;

/**
 * The {@link ProcessExecutor} interface defines a contract for executing Operating System (OS) programs
 * and returning a reference to the running OS {@link Process} for program control.
 *
 * @author John Blum
 * @param  {@link Class} type of the object returned from {@link ProcessExecutor#execute(File, String...)}.
 * @see java.io.File
 * @see java.lang.Process
 * @see org.cp.elements.process.ProcessAdapter
 * @see org.cp.elements.process.ProcessContext
 * @since 1.0.0
 */
public interface ProcessExecutor {

  /**
   * Executes the program defined by the given command-line in the given {@link File directory}.
   *
   * @param directory {@link File directory} in which the program will run.
   * @param commandLine array of {@link String} values constituting the program and its runtime arguments.
   * @return an object representing the running program.
   * @see org.cp.elements.process.ProcessAdapter
   * @see java.lang.Process
   * @see java.io.File
   */
  T execute(File directory, String... commandLine);

  /**
   * Executes the program defined by the given command-line in the current working {@link File directory}.
   *
   * @param commandLine array of {@link String} values constituting the program and its runtime arguments.
   * @return an object representing the running program.
   * @see org.cp.elements.io.FileSystemUtils#WORKING_DIRECTORY
   * @see org.cp.elements.process.ProcessAdapter
   * @see java.lang.Process
   * @see #execute(File, String...)
   */
  default T execute(String... commandLine) {
    return execute(WORKING_DIRECTORY, commandLine);
  }

  /**
   * Executes the program defined by the given command-line in the current working {@link File directory}.
   *
   * @param commandLine {@link Iterable} of {@link String} values constituting the program and its runtime arguments.
   * @return an object representing the running program.
   * @see org.cp.elements.io.FileSystemUtils#WORKING_DIRECTORY
   * @see org.cp.elements.process.ProcessAdapter
   * @see java.lang.Iterable
   * @see java.lang.Process
   * @see #execute(File, String...)
   */
  default T execute(Iterable commandLine) {
    return execute(WORKING_DIRECTORY, asArray(commandLine, String.class));
  }

  /**
   * Executes the program defined by the given command-line in the given {@link File directory}.
   *
   * @param directory {@link File directory} in which the program will run.
   * @param commandLine {@link Iterable} of {@link String} values constituting the program and its runtime arguments.
   * @return an object representing the running program.
   * @see org.cp.elements.process.ProcessAdapter
   * @see java.lang.Iterable
   * @see java.lang.Process
   * @see java.io.File
   * @see #execute(File, String...)
   */
  default T execute(File directory, Iterable commandLine) {
    return execute(directory, asArray(commandLine, String.class));
  }
}