org.checkerframework.dataflow.cfg.node.StringLiteralNode 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.

The newest version!

package org.checkerframework.dataflow.cfg.node;

import com.sun.source.tree.LiteralTree;
import com.sun.source.tree.Tree;

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

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

/**
 * A node for an string literal. For example:
 *
 *  *   "abc"
 * 
 */
public class StringLiteralNode extends ValueLiteralNode {

    /**
     * Create a new StringLiteralNode.
     *
     * @param t the tree for the literal value
     */
    public StringLiteralNode(LiteralTree t) {
        super(t);
        assert t.getKind() == Tree.Kind.STRING_LITERAL;
    }

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

    @Override
    public  R accept(NodeVisitor visitor, P p) {
        return visitor.visitStringLiteral(this, p);
    }

    @Override
    public boolean equals(@Nullable Object obj) {
        // test that obj is a StringLiteralNode
        if (!(obj instanceof StringLiteralNode)) {
            return false;
        }
        // super method compares values
        return super.equals(obj);
    }

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

    @Override
    public String toString() {
        return "\"" + super.toString() + "\"";
    }
}