View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   https://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  
20  package org.apache.commons.exec;
21  
22  /**
23   * Destroys all registered {@link Process} after a certain event, typically when the VM exits.
24   *
25   * @see ShutdownHookProcessDestroyer
26   */
27  public interface ProcessDestroyer {
28  
29      /**
30       * Returns {@code true} if the specified {@link Process} was successfully added to the list of processes to be destroyed.
31       *
32       * @param process the process to add.
33       * @return {@code true} if the specified {@link Process} was successfully added.
34       */
35      boolean add(Process process);
36  
37      /**
38       * Returns {@code true} if the specified {@link Process} was successfully removed from the list of processes to be destroyed.
39       *
40       * @param process the process to remove.
41       * @return {@code true} if the specified {@link Process} was successfully removed.
42       */
43      boolean remove(Process process);
44  
45      /**
46       * Returns the number of registered processes.
47       *
48       * @return the number of register process.
49       */
50      int size();
51  }