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