org.semanticweb.owlapi.change.RemoveImportData Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of owlapi-api Show documentation
The newest version!
/*
 * This file is part of the OWL API.
 *
 * The contents of this file are subject to the LGPL License, Version 3.0.
 *
 * Copyright (C) 2011, 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.
 *
 * Copyright 2011, The University of Manchester
 *
 * 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.change;

import org.semanticweb.owlapi.model.OWLImportsDeclaration;
import org.semanticweb.owlapi.model.OWLOntology;
import org.semanticweb.owlapi.model.RemoveImport;

/**
 * Author: Matthew Horridge

 * Stanford University

 * Bio-Medical Informatics Research Group

 * Date: 27/04/2012
 * 
 * Represents the specific non-ontology data required by a {@link org.semanticweb.owlapi.model.RemoveImport} change.
 * 
 * 
 * Instances of this class are immutable.
 * 
 * @since 3.5
 */
public final class RemoveImportData extends ImportChangeData {
    private static final long serialVersionUID = 30406L;

    /**
     * Constructs a {@link RemoveImportData} object that describes a {@link org.semanticweb.owlapi.model.RemoveImport}
     * change for the {@link OWLImportsDeclaration} specified by the {@code declaration} parameter.
     * @param declaration The {@link OWLImportsDeclaration} that is the focus of some change.  Not {@code null}.
     * @throws NullPointerException if {@code declaration} is {@code null}.
     */
    public RemoveImportData(OWLImportsDeclaration declaration) {
        super(declaration);
    }

    /**
     * Creates the {@link org.semanticweb.owlapi.model.AddImport} change that describes the removal of an {@link
     * OWLImportsDeclaration} from
     * an {@link OWLOntology} specified by the {@code ontology} parameter.
     * @param ontology The {@link OWLOntology} that the change should apply to.  Not {@code null}.
     * @return The {@link org.semanticweb.owlapi.model.RemoveImport} change for the {@link OWLOntology} specified by
     *         {@code ontology} and the
     *         {@link OWLImportsDeclaration} associated with this {@link ImportChangeData} object.
     * @throws NullPointerException if {@code ontology} is {@code null}.
     */
    @Override
    public RemoveImport createOntologyChange(OWLOntology ontology) {
        return new RemoveImport(ontology, getDeclaration());
    }

    @Override
    public  O accept(OWLOntologyChangeDataVisitor visitor) throws E {
        return visitor.visit(this);
    }

    @Override
    public int hashCode() {
        return "RemoveImportData".hashCode() + getDeclaration().hashCode();
    }

    @Override
    public boolean equals(Object obj) {
        if(obj == this) {
            return true;
        }
        if(!(obj instanceof RemoveImportData)) {
            return false;
        }
        RemoveImportData other = (RemoveImportData) obj;
        return getDeclaration().equals(other.getDeclaration());
    }

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("RemoveImportData");
        sb.append("(");
        sb.append(getDeclaration());
        sb.append(")");
        return sb.toString();
    }
}