/*

 * Copyright (C) 2007-2010 Júlio Vilmar Gesser.

 * Copyright (C) 2011, 2013-2021 The JavaParser Team.

 *

 * This file is part of JavaParser.

 *

 * JavaParser can be used either under the terms of

 * a) 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.

 * b) the terms of the Apache License

 *

 * You should have received a copy of both licenses in LICENCE.LGPL and

 * LICENCE.APACHE. Please refer to those files for details.

 *

 * JavaParser 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.

 */

package com.github.javaparser.ast.expr;

import com.github.javaparser.TokenRange;

import com.github.javaparser.ast.AllFieldsConstructor;

import com.github.javaparser.ast.Generated;

import com.github.javaparser.ast.Node;

import com.github.javaparser.ast.nodeTypes.NodeWithName;

import com.github.javaparser.ast.observer.ObservableProperty;

import com.github.javaparser.ast.visitor.CloneVisitor;

import com.github.javaparser.metamodel.AnnotationExprMetaModel;

import com.github.javaparser.metamodel.JavaParserMetaModel;

import com.github.javaparser.resolution.Resolvable;

import com.github.javaparser.resolution.UnsolvedSymbolException;

import com.github.javaparser.resolution.declarations.ResolvedAnnotationDeclaration;

import java.util.Optional;

import java.util.function.Consumer;

import static com.github.javaparser.utils.Utils.assertNotNull;

/**

 * A base class for the different types of annotations.

 *

 * @author Julio Vilmar Gesser

 */

public abstract class AnnotationExpr extends Expression implements NodeWithName<AnnotationExpr>, Resolvable<ResolvedAnnotationDeclaration> {

    protected Name name;

    public AnnotationExpr() {

        this(null, new Name());

    }

    @AllFieldsConstructor

    public AnnotationExpr(Name name) {

        this(null, name);

    }

    /**

     * This constructor is used by the parser and is considered private.

     */

    @Generated("com.github.javaparser.generator.core.node.MainConstructorGenerator")

    public AnnotationExpr(TokenRange tokenRange, Name name) {

        super(tokenRange);

        setName(name);

        customInitialization();

    }

    @Generated("com.github.javaparser.generator.core.node.PropertyGenerator")

    public Name getName() {

        return name;

    }

    @Generated("com.github.javaparser.generator.core.node.PropertyGenerator")

    public AnnotationExpr setName(final Name name) {

        assertNotNull(name);

        if (name == this.name) {

            return this;

        }

        notifyPropertyChange(ObservableProperty.NAME, this.name, name);

        if (this.name != null)

            this.name.setParentNode(null);

        this.name = name;

        setAsParentNodeOf(name);

        return this;

    }

    @Override

    @Generated("com.github.javaparser.generator.core.node.RemoveMethodGenerator")

    public boolean remove(Node node) {

        if (node == null)

            return false;

        return super.remove(node);

    }

    @Override

    @Generated("com.github.javaparser.generator.core.node.CloneGenerator")

    public AnnotationExpr clone() {

        return (AnnotationExpr) accept(new CloneVisitor(), null);

    }

    @Override

    @Generated("com.github.javaparser.generator.core.node.GetMetaModelGenerator")

    public AnnotationExprMetaModel getMetaModel() {

        return JavaParserMetaModel.annotationExprMetaModel;

    }

    @Override

    @Generated("com.github.javaparser.generator.core.node.ReplaceMethodGenerator")

    public boolean replace(Node node, Node replacementNode) {

        if (node == null)

            return false;

        if (node == name) {

            setName((Name) replacementNode);

            return true;

        }

        return super.replace(node, replacementNode);

    }

    @Override

    @Generated("com.github.javaparser.generator.core.node.TypeCastingGenerator")

    public boolean isAnnotationExpr() {

        return true;

    }

    @Override

    @Generated("com.github.javaparser.generator.core.node.TypeCastingGenerator")

    public AnnotationExpr asAnnotationExpr() {

        return this;

    }

    @Override

    @Generated("com.github.javaparser.generator.core.node.TypeCastingGenerator")

    public void ifAnnotationExpr(Consumer<AnnotationExpr> action) {

        action.accept(this);

    }

    /**

     * Attempts to resolve the declaration corresponding to the annotation expression. If successful, a

     * {@link ResolvedAnnotationDeclaration} representing the declaration of the annotation referenced by this

     * {@code AnnotationExpr} is returned. Otherwise, an {@link UnsolvedSymbolException} is thrown.

     *

     * @return a {@link ResolvedAnnotationDeclaration} representing the declaration of the annotation expression.

     * @throws UnsolvedSymbolException if the declaration corresponding to the annotation expression could not be

     *                                 resolved.

     */

    @Override

    public ResolvedAnnotationDeclaration resolve() {

        return getSymbolResolver().resolveDeclaration(this, ResolvedAnnotationDeclaration.class);

    }

    @Override

    @Generated("com.github.javaparser.generator.core.node.TypeCastingGenerator")

    public Optional<AnnotationExpr> toAnnotationExpr() {

        return Optional.of(this);

    }

}