pascal.taie.language.annotation.Annotation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tai-e Show documentation
An easy-to-learn/use static analysis framework for Java
The newest version!
/*
 * Tai-e: A Static Analysis Framework for Java
 *
 * Copyright (C) 2022 Tian Tan 
 * Copyright (C) 2022 Yue Li 
 *
 * This file is part of Tai-e.
 *
 * Tai-e is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 *
 * Tai-e is distributed in the hope that it will be useful,but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
 * Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with Tai-e. If not, see .
 */

package pascal.taie.language.annotation;

import pascal.taie.util.collection.Views;

import javax.annotation.Nullable;
import java.io.Serializable;
import java.util.Map;
import java.util.Set;

/**
 * Represents annotations in the program.
 * Each annotation contains 0 or more named elements.
 * 
 * Currently, we use {@code String} (instead of {@code JClass}
 * or {@code ClassType}) to represent the type of an annotation.
 * This makes it easier for the frontends to extract annotations
 * from the program (The type string is ready in the program,
 * and the frontends do not need to resolve the string to {@code JClass}).
 * 
 * TODO: add ElementType and RetentionPolicy.
 */
public class Annotation implements Serializable {

    /**
     * String representation of type of this annotation.
     */
    private final String annotationType;

    /**
     * Map from names to corresponding elements in this annotation.
     */
    private final Map elements;

    public Annotation(String annotationType,
                      Map elements) {
        this.annotationType = annotationType;
        this.elements = Map.copyOf(elements);
    }

    public String getType() {
        return annotationType;
    }

    public boolean hasElement(String name) {
        return elements.containsKey(name);
    }

    @Nullable
    public Element getElement(String name) {
        return elements.get(name);
    }

    /**
     * @return all name-element entries in this annotation.
     */
    public Set getElementEntries() {
        return Views.toMappedSet(elements.entrySet(),
                e -> new Entry(e.getKey(), e.getValue()));
    }

    /**
     * Represents name-element entries in annotations.
     */
    public record Entry(String name, Element element) {
    }

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder("@");
        sb.append(annotationType);
        int elems = elements.size();
        if (elems > 0) {
            sb.append('(');
            if (elems == 1 && elements.containsKey("value")) {
                // single-element annotation
                sb.append(elements.get("value"));
            } else {
                // normal annotation
                int count = 0;
                for (var e : elements.entrySet()) {
                    sb.append(e.getKey()).append('=').append(e.getValue());
                    if (++count < elems) {
                        sb.append(',');
                    }
                }
            }
            sb.append(')');
        }
        return sb.toString();
    }
}