org.checkerframework.dataflow.cfg.node.ValueLiteralNode Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dataflow-shaded Show documentation

dataflow-shaded is a dataflow framework based on the javac compiler. It differs from the org.checkerframework:dataflow artifact in two ways. First, the packages in this artifact have been renamed to org.checkerframework.shaded.*. Second, unlike the dataflow artifact, this artifact contains the dependencies it requires.

There is a newer version: 3.42.0-eisop5

Show newest version

package org.checkerframework.dataflow.cfg.node;

import com.sun.source.tree.LiteralTree;

import org.checkerframework.checker.nullness.qual.Nullable;
import org.checkerframework.dataflow.qual.SideEffectFree;
import org.checkerframework.javacutil.TreeUtils;

import java.util.Collection;
import java.util.Collections;
import java.util.Objects;

/**
 * A node for a literals that have some form of value:
 *
 * 
 *   integer literal
 *   
long literal
 *   
char literal
 *   
string literal
 *   
float literal
 *   
double literal
 *   
boolean literal
 *   
null literal
 * 
 */
public abstract class ValueLiteralNode extends Node {

    /** The tree for the value literal. */
    protected final LiteralTree tree;

    /**
     * Returns the value of the literal, null for the null literal.
     *
     * @return the value of the literal, null for the null literal
     */
    public abstract @Nullable Object getValue();

    protected ValueLiteralNode(LiteralTree tree) {
        super(TreeUtils.typeOf(tree));
        this.tree = tree;
    }

    @Override
    public LiteralTree getTree() {
        return tree;
    }

    @Override
    public String toString() {
        return String.valueOf(getValue());
    }

    @Override
    public boolean equals(@Nullable Object obj) {
        if (this == obj) {
            return true;
        }
        if (!(obj instanceof ValueLiteralNode)) {
            return false;
        }
        ValueLiteralNode other = (ValueLiteralNode) obj;
        Object val = getValue();
        Object otherVal = other.getValue();
        return Objects.equals(val, otherVal);
    }

    @Override
    public int hashCode() {
        // value might be null
        return Objects.hash(this.getClass(), getValue());
    }

    @Override
    @SideEffectFree
    public Collection getOperands() {
        return Collections.emptyList();
    }
}