org.zeroturnaround.exec.listener.ProcessListener Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of zt-exec Show documentation
A lightweight library to execute external processes from Java.
The newest version!
/*
 * Copyright (C) 2014 ZeroTurnaround 
 * Contains fragments of code from Apache Commons Exec, rights owned
 * by Apache Software Foundation (ASF).
 *
 * 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.zeroturnaround.exec.listener;

import org.zeroturnaround.exec.ProcessExecutor;
import org.zeroturnaround.exec.ProcessResult;

/**
 * Event handler for process events.
 * 
 * This is a class instead of interface in order to add new methods without updating all implementations.
 *
 * @author Rein Raudjärv
 * @see ProcessExecutor#addListener(ProcessListener)
 */
public abstract class ProcessListener {

  /**
   * Invoked before a process is started.
   *
   * @param executor executor used for starting a process.
   *    Any changes made here apply to the starting process.
   *    Once the process has started it is not affected by the {@link ProcessExecutor} any more.
   */
  public void beforeStart(ProcessExecutor executor) {
    // do nothing
  }

  /**
   * Invoked after a process has started.
   *
   * @param process the process started.
   * @param executor executor used for starting the process.
   *    Modifying the {@link ProcessExecutor} only affects the following processes
   *    not the one just started.
   */
  public void afterStart(Process process, ProcessExecutor executor) {
    // do nothing
  }

  /**
   * Invoked after a process has finished successfully.
   *
   * @param process process just finished.
   * @param result result of the finished process.
   * @since 1.8
   */
  public void afterFinish(Process process, ProcessResult result) {
    // do nothing
  }

  /**
   * Invoked after a process has exited (whether finished or cancelled).
   *
   * @param process process just stopped.
   */
  public void afterStop(Process process) {
    // do nothing
  }

}