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