RemovableDifferences.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 org.apache.logging.log4j.*;

/**
 *  Documents the difference, if any, for a given programming
 *  element that can be absent in either the old or the new
 *  codebase.  This includes classes, interfaces, fields,
 *  constructors, and methods.
 */
public abstract class RemovableDifferences implements Differences {
    private final String name;

    protected RemovableDifferences(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }

    public abstract String getOldDeclaration();
    public abstract String getNewDeclaration();

    public boolean isRemoved() {
        boolean result = (getOldDeclaration() != null) && (getNewDeclaration() == null);

        LogManager.getLogger(getClass()).debug("{} IsRemoved(): {}", getName(), result);
        
        return result;
    }

    public boolean isModified() {
        boolean result = (getOldDeclaration() != null) && (getNewDeclaration() != null) && !getOldDeclaration().equals(getNewDeclaration());

        LogManager.getLogger(getClass()).debug("{} IsModified(): {}", getName(), result);
        
        return result;
    }

    public boolean isNew() {
        boolean result = (getOldDeclaration() == null) && (getNewDeclaration() != null);

        LogManager.getLogger(getClass()).debug("{} IsNew(): {}", getName(), result);
        
        return result;
    }

    public String toString() {
        return getName();
    }

    public boolean equals(Object object) {
        if (this == object) {
            return true;
        }

        if (object == null || getClass() != object.getClass()) {
            return false;
        }

        return compareTo((RemovableDifferences) object) == 0;
    }

    public int hashCode() {
        return getName().hashCode();
    }
}