ClassDifferences.java

/*
 *  Copyright (c) 2001-2024, Jean Tessier
 *  All rights reserved.
 *  
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *  
 *      * Redistributions of source code must retain the above copyright
 *        notice, this list of conditions and the following disclaimer.
 *  
 *      * Redistributions in binary form must reproduce the above copyright
 *        notice, this list of conditions and the following disclaimer in the
 *        documentation and/or other materials provided with the distribution.
 *  
 *      * Neither the name of Jean Tessier nor the names of his contributors
 *        may be used to endorse or promote products derived from this software
 *        without specific prior written permission.
 *  
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR
 *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 *  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.jeantessier.diff;

import java.util.*;

import org.apache.logging.log4j.*;

import com.jeantessier.classreader.*;

/**
 *  Documents the difference, if any, for a given object
 *  type (class or interface).  Its subclasses only
 *  differ in which Visitor callback they invoke.
 *
 *  @see Visitor
 */
public class ClassDifferences extends RemovableDifferences {
    private Classfile oldClass;
    private Classfile newClass;

    private boolean declarationModified;
    private final Collection<Differences> featureDifferences = new LinkedList<>();

    /**
     *  Only the DifferencesFactory can create instances of this class.
     */
    ClassDifferences(String name, Classfile oldClass, Classfile newClass) {
        super(name);

        setOldClass(oldClass);
        setNewClass(newClass);

        if (isModified()) {
            LogManager.getLogger(getClass()).debug("{} declaration has been modified.", getName());
        } else {
            LogManager.getLogger(getClass()).debug("{} declaration has not been modified.", getName());
        }
    }

    public Classfile getOldClass() {
        return oldClass;
    }

    protected void setOldClass(Classfile oldClass) {
        this.oldClass = oldClass;
    }

    public Classfile getNewClass() {
        return newClass;
    }

    protected void setNewClass(Classfile newClass) {
        this.newClass = newClass;
    }

    public String getOldDeclaration() {
        String result = null;

        if (getOldClass() != null) {
            result = getOldClass().getDeclaration();
        }

        return result;
    }

    public String getNewDeclaration() {
        String result = null;

        if (getNewClass() != null) {
            result = getNewClass().getDeclaration();
        }

        return result;
    }

    public boolean isDeclarationModified() {
        return declarationModified;
    }

    /**
     * Only the DifferencesFactory can set this flag
     */
    void setDeclarationModified(boolean declarationModified) {
        this.declarationModified = declarationModified;
    }

    public Collection<Differences> getFeatureDifferences() {
        return featureDifferences;
    }

    public boolean isModified() {
        return isDeclarationModified() || !getFeatureDifferences().isEmpty();
    }

    public void accept(Visitor visitor) {
        visitor.visitClassDifferences(this);
    }
}