org.semanticweb.owlapi.change.ImportChangeData 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
There is a newer version: 4.7.5
/* 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.change;

import static org.semanticweb.owlapi.util.OWLAPIPreconditions.checkNotNull;

import java.util.Set;

import javax.annotation.Nonnull;

import org.semanticweb.owlapi.model.OWLEntity;
import org.semanticweb.owlapi.model.OWLImportsDeclaration;
import org.semanticweb.owlapi.util.CollectionFactory;

/**
 * Instances of this class represent {@link OWLOntologyChangeData} for changes
 * that that are specific to the addition or removal of import statements
 * to/from an ontology.
 * 
 * @author Matthew Horridge, Stanford University, Bio-Medical Informatics
 *         Research Group
 * @since 3.3
 */
public abstract class ImportChangeData extends OWLOntologyChangeData {

    private static final long serialVersionUID = 40000L;
    @Nonnull
    private final OWLImportsDeclaration declaration;

    /**
     * Constructs an {@code ImportChangeData} object that describes an
     * {@link org.semanticweb.owlapi.model.ImportChange} based on the
     * {@link OWLImportsDeclaration} specified by the {@code declaration}
     * parameter.
     * 
     * @param declaration
     *        The {@link OWLImportsDeclaration} that is the focus of some
     *        change.
     */
    protected ImportChangeData(@Nonnull OWLImportsDeclaration declaration) {
        this.declaration = checkNotNull(declaration,
                "declaration must not be null");
    }

    /**
     * Gets the {@link OWLImportsDeclaration} that this change data describes.
     * 
     * @return The {@link OWLImportsDeclaration}.
     */
    @Nonnull
    public OWLImportsDeclaration getDeclaration() {
        return declaration;
    }

    @Override
    public OWLImportsDeclaration getItem() {
        return getDeclaration();
    }

    @Override
    public Set getSignature() {
        return CollectionFactory.emptySet();
    }
}