/* 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.model;

import java.util.Collection;
import java.util.stream.Stream;

import org.semanticweb.owlapi.model.parameters.ChangeApplied;

/**
 * @author Matthew Horridge, Stanford University, Bio-Medical Informatics Research Group
 * @since 3.5
 */
@FunctionalInterface
public interface HasRemoveAxioms {

    /**
     * A convenience method that removes a set of axioms from an ontology. The appropriate
     * RemoveAxiom change objects are automatically generated.
     *
     * @param ont The ontology from which the axioms should be removed.
     * @param axioms The axioms to be removed.
     * @return ChangeApplied.SUCCESSFULLY if the axiom is added, ChangeApplied.UNSUCCESSFULLY
     * otherwise.
     * @throws OWLOntologyChangeException if there was a problem removing the axioms
     * @deprecated use {@link #removeAxioms(OWLOntology, Collection)}
     */
    @Deprecated
    default ChangeApplied removeAxioms(OWLOntology ont, Collection<? extends OWLAxiom> axioms) {
        return removeAxioms(ont, axioms.stream());
    }

    /**
     * A convenience method that removes a set of axioms from an ontology. The appropriate
     * RemoveAxiom change objects are automatically generated.
     *
     * @param ont The ontology from which the axioms should be removed.
     * @param axioms The axioms to be removed.
     * @return ChangeApplied.SUCCESSFULLY if the axiom is added, ChangeApplied.UNSUCCESSFULLY
     * otherwise.
     * @throws OWLOntologyChangeException if there was a problem removing the axioms
     */
    ChangeApplied removeAxioms(OWLOntology ont, Stream<? extends OWLAxiom> axioms);
}