    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
    022import java.util.function.Consumer;
    023
    024/**
    025 * Interface for classes that want to be notified by Watchdog.
    026 *
    027 * @see org.apache.commons.exec.Watchdog
    028 */
    029public interface TimeoutObserver extends Consumer<Watchdog> {
    030
    031    /**
    032     * {@inheritDoc}
    033     *
    034     * @since 1.6.0
    035     */
    036    @Override
    037    default void accept(final Watchdog w) {
    038        timeoutOccured(w);
    039    }
    040
    041    /**
    042     * Called when the watchdog times out.
    043     *
    044     * @param w the watchdog that timed out.
    045     */
    046    void timeoutOccured(Watchdog w);
    047}