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

Go to download
/*
 * 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 java.util.Set;

import org.semanticweb.owlapi.model.OWLAxiom;
import org.semanticweb.owlapi.model.OWLEntity;

/**
 * Represent the common non-ontology data required by instances of
 * {@link org.semanticweb.owlapi.model.OWLAxiomChange}.
 * 
 * @author Matthew Horridge, Stanford University, Bio-Medical Informatics
 *         Research Group, Date: 27/04/2012
 */
public abstract class AxiomChangeData extends OWLOntologyChangeData {

    private static final long serialVersionUID = 30406L;
    private final OWLAxiom axiom;

    /**
     * Constructs an {@link AxiomChangeData} object that describes a change
     * involving the specified {@code axiom}.
     * 
     * @param axiom
     *        The {@link OWLAxiom} involved in a change.
     * @throws NullPointerException
     *         if {@code axiom} is {@code null}.
     */
    public AxiomChangeData(OWLAxiom axiom) {
        if (axiom == null) {
            throw new NullPointerException("axiom must not be null");
        }
        this.axiom = axiom;
    }

    /**
     * Gets the {@link OWLAxiom} that is associated with this change data.
     * 
     * @return The {@link OWLAxiom}. Not {@code null}.
     */
    public OWLAxiom getAxiom() {
        return axiom;
    }

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