001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 *  contributor license agreements.  See the NOTICE file distributed with
004 *  this work for additional information regarding copyright ownership.
005 *  The ASF licenses this file to You under the Apache License, Version 2.0
006 *  (the "License"); you may not use this file except in compliance with
007 *  the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 *  Unless required by applicable law or agreed to in writing, software
012 *  distributed under the License is distributed on an "AS IS" BASIS,
013 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 *  See the License for the specific language governing permissions and
015 *  limitations under the License.
016 */
017
018package org.apache.commons.exec;
019
020/**
021 * Destroys all registered {@link Process} after a certain event, typically when the VM exits.
022 *
023 * @see ShutdownHookProcessDestroyer
024 */
025public interface ProcessDestroyer {
026
027    /**
028     * Returns {@code true} if the specified {@link Process} was successfully added to the list of processes to be destroy.
029     *
030     * @param process the process to add.
031     * @return {@code true} if the specified {@link Process} was successfully added.
032     */
033    boolean add(Process process);
034
035    /**
036     * Returns {@code true} if the specified {@link Process} was successfully removed from the list of processes to be destroy.
037     *
038     * @param process the process to remove.
039     * @return {@code true} if the specified {@link Process} was successfully removed.
040     */
041    boolean remove(Process process);
042
043    /**
044     * Returns the number of registered processes.
045     *
046     * @return the number of register process.
047     */
048    int size();
049}