org.semanticweb.owlapi.util.Monitorable Maven / Gradle / Ivy

/* This file is part of the OWL API.
 * The contents of this file are subject to the LGPL License, Version 3.0.
 * Copyright 2014, The University of Manchester
 * 
 * This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License along with this program.  If not, see http://www.gnu.org/licenses/.
 *
 * Alternatively, the contents of this file may be used under the terms of the Apache License, Version 2.0 in which case, the provisions of the Apache License Version 2.0 are applicable instead of those above.
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */
package org.semanticweb.owlapi.util;

/**
 * Certain tasks or algorithms may take some time to accomplish. For example
 * parsing, saving etc. In some situations, it is desirable to monitor the
 * progress of such tasks, for example to provide feedback in user interfaces.
 * Interfaces which represent long tasks can implement this progress monitor
 * interface to provide a hook for a progress monitor.
 * 
 * @author Matthew Horridge, The University Of Manchester, Bio-Health
 *         Informatics Group
 * @since 2.0.0
 */
public interface Monitorable {

    /**
     * Sets the progress monitor which receives information about the progress
     * of the this object which represents a long running task.
     * 
     * @param progressMonitor
     *        progress monitor
     */
    void setProgressMonitor(ProgressMonitor progressMonitor);

    /**
     * Interrupts the long running task (if possible).
     * 
     * @throws InterruptedException
     *         interrupted exception
     */
    void interrupt() throws InterruptedException;

    /** @return true if this long running task can be cancelled. */
    boolean canInterrupt();
}