DeprecatableDifferences.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.*;

import com.jeantessier.classreader.*;

/**
 *  Documents the difference, if any, for a given programming
 *  element that can be deprecated through the use of javadoc
 *  tags.
 */
public class DeprecatableDifferences extends DecoratorDifferences {
    private final boolean newDeprecation;
    private final boolean removedDeprecation;

    /**
     *  Only the DifferencesFactory can create instances of this class.
     */
    DeprecatableDifferences(Differences component, Deprecatable oldDeprecatable, Deprecatable newDeprecatable) {
        super(component);

        LogManager.getLogger(getClass()).debug("Begin {}", getName());

        if (oldDeprecatable != null && newDeprecatable != null) {
            LogManager.getLogger(getClass()).debug("      old deprecatable: {}", () -> oldDeprecatable.isDeprecated());
            LogManager.getLogger(getClass()).debug("      new deprecatable: {}", () -> newDeprecatable.isDeprecated());

            removedDeprecation = oldDeprecatable.isDeprecated() && !newDeprecatable.isDeprecated();
            newDeprecation = !oldDeprecatable.isDeprecated() && newDeprecatable.isDeprecated();
        } else {
            removedDeprecation = false;
            newDeprecation = false;
        }

        LogManager.getLogger(getClass()).debug("End   {}", getName());
    }

    public boolean isNewDeprecation() {
        return newDeprecation;
    }

    public boolean isRemovedDeprecation() {
        return removedDeprecation;
    }

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