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

Show more of this group Show more artifacts with this name
Show all versions of checker Show documentation

The Checker Framework enhances Java’s type system to make it more powerful and useful. This lets software developers detect and prevent errors in their Java programs. The Checker Framework includes compiler plug-ins ("checkers") that find bugs or verify their absence. It also permits you to write your own compiler plug-ins.

There is a newer version: 3.42.0

Show newest version

package org.checkerframework.dataflow.cfg.node;

import org.checkerframework.dataflow.util.HashCodeUtils;

import org.checkerframework.javacutil.InternalUtils;

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

import com.sun.source.tree.LiteralTree;

/*>>>
import org.checkerframework.checker.nullness.qual.Nullable;
*/

/**
 * 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
 * 
 *
 * @author Stefan Heule
 *
 */
public abstract class ValueLiteralNode extends Node {

    protected final LiteralTree tree;

    /**
     * @return the value of the literal
     */
    abstract public /*@Nullable*/ Object getValue();

    public ValueLiteralNode(LiteralTree tree) {
        super(InternalUtils.typeOf(tree));
        this.tree = tree;
    }

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

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

    /**
     * Compare the value of this nodes.
     */
    @Override
    public boolean equals(Object obj) {
        if (obj == null || !(obj instanceof ValueLiteralNode)) {
            return false;
        }
        ValueLiteralNode other = (ValueLiteralNode) obj;
        Object val = getValue();
        Object otherVal = other.getValue();
        return ((val == null || otherVal == null) && val == otherVal) || val.equals(otherVal);
    }

    @Override
    public int hashCode() {
        return HashCodeUtils.hash(getValue());
    }

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

}