NoLongerConstant.java

/*
 * Copyright 2014 Lukas Krejci
 *
 * 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.revapi.java.checks.fields;

import java.util.Collections;
import java.util.EnumSet;
import java.util.List;
import java.util.Objects;

import org.revapi.Difference;
import org.revapi.java.spi.Code;
import org.revapi.java.spi.JavaFieldElement;

/**
 * @author Lukas Krejci
 * @since 0.1
 */
public final class NoLongerConstant extends BothFieldsRequiringCheck {

    @Override
    public EnumSet<Type> getInterest() {
        return EnumSet.of(Type.FIELD);
    }

    @Override
    protected void doVisitField(JavaFieldElement oldField, JavaFieldElement newField) {
        if (!shouldCheck(oldField, newField)) {
            return;
        }

        if (oldField.getDeclaringElement().getConstantValue() != null
                && newField.getDeclaringElement().getConstantValue() == null) {
            pushActive(oldField, newField);
        }
    }

    @Override
    protected List<Difference> doEnd() {
        ActiveElements<JavaFieldElement> fields = popIfActive();
        if (fields == null) {
            return null;
        }

        return Collections.singletonList(
            createDifference(Code.FIELD_NO_LONGER_CONSTANT,
                    Code.attachmentsFor(fields.oldElement, fields.newElement,
                            "value", Objects.toString(fields.oldElement.getDeclaringElement().getConstantValue()))));
    }
}