JavassistParameterDeclarationTest.java

/*
 * Copyright (C) 2015-2016 Federico Tomassetti
 * Copyright (C) 2017-2024 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.symbolsolver.javassistmodel;

import static org.junit.jupiter.api.Assertions.*;

import com.github.javaparser.resolution.TypeSolver;
import com.github.javaparser.resolution.declarations.ResolvedConstructorDeclaration;
import com.github.javaparser.resolution.declarations.ResolvedMethodDeclaration;
import com.github.javaparser.symbolsolver.resolution.AbstractResolutionTest;
import com.github.javaparser.symbolsolver.resolution.typesolvers.CombinedTypeSolver;
import com.github.javaparser.symbolsolver.resolution.typesolvers.JarTypeSolver;
import com.github.javaparser.symbolsolver.resolution.typesolvers.ReflectionTypeSolver;
import java.io.IOException;
import java.nio.file.Path;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

class JavassistParameterDeclarationTest extends AbstractResolutionTest {

    private TypeSolver typeSolver;

    @BeforeEach
    void setup() throws IOException {
        Path pathToJar = adaptPath("src/test/resources/javaparser-core-3.0.0-alpha.2.jar");
        typeSolver = new CombinedTypeSolver(new JarTypeSolver(pathToJar), new ReflectionTypeSolver());
    }

    @Test
    void noNamesAvailableInInterfaceMethods() {
        JavassistInterfaceDeclaration namesNotAvailable = (JavassistInterfaceDeclaration)
                typeSolver.solveType("com.github.javaparser.ast.nodeTypes.NodeWithBody");

        namesNotAvailable.getDeclaredMethods().forEach(methodDecl -> {
            for (int i = 0; i < methodDecl.getNumberOfParams(); i++) {
                assertFalse(methodDecl.getParam(i).hasName());
                assertNull(methodDecl.getParam(i).getName());
            }
        });
    }

    @Test
    void nameForConstructorParameter() {
        JavassistClassDeclaration rangeDecl =
                (JavassistClassDeclaration) typeSolver.solveType("com.github.javaparser.Range");
        ResolvedConstructorDeclaration constructor = rangeDecl.getConstructors().get(0);
        assertEquals("begin", constructor.getParam(0).getName());
        assertTrue(constructor.getParam(0).hasName());
        assertEquals("end", constructor.getParam(1).getName());
        assertTrue(constructor.getParam(1).hasName());
    }

    @Test
    void nameForMethodParameters() {
        JavassistClassDeclaration rangeDecl =
                (JavassistClassDeclaration) typeSolver.solveType("com.github.javaparser.Range");
        for (ResolvedMethodDeclaration methodDecl : rangeDecl.getDeclaredMethods()) {
            switch (methodDecl.getName()) {
                case "range": // static methods
                    if (methodDecl.getNumberOfParams() == 2) {
                        assertEquals("begin", methodDecl.getParam(0).getName());
                        assertTrue(methodDecl.getParam(0).hasName());
                        assertEquals("end", methodDecl.getParam(1).getName());
                        assertTrue(methodDecl.getParam(1).hasName());
                    } else if (methodDecl.getNumberOfParams() == 4) {
                        assertEquals("beginLine", methodDecl.getParam(0).getName());
                        assertTrue(methodDecl.getParam(0).hasName());
                        assertEquals("beginColumn", methodDecl.getParam(1).getName());
                        assertTrue(methodDecl.getParam(1).hasName());
                        assertEquals("endLine", methodDecl.getParam(2).getName());
                        assertTrue(methodDecl.getParam(2).hasName());
                        assertEquals("endColumn", methodDecl.getParam(3).getName());
                        assertTrue(methodDecl.getParam(3).hasName());
                    }
                    break;
                case "withBeginColumn":
                    assertEquals("column", methodDecl.getParam(0).getName());
                    assertTrue(methodDecl.getParam(0).hasName());
                    break;
            }
        }
    }

    @Test
    void isField() {
        JavassistClassDeclaration rangeDecl =
                (JavassistClassDeclaration) typeSolver.solveType("com.github.javaparser.Range");
        JavassistParameterDeclaration paramDecl = (JavassistParameterDeclaration)
                rangeDecl.getConstructors().get(0).getParam(0);

        assertFalse(paramDecl.isField());
    }

    @Test
    void isParameter() {
        JavassistClassDeclaration rangeDecl =
                (JavassistClassDeclaration) typeSolver.solveType("com.github.javaparser.Range");
        JavassistParameterDeclaration paramDecl = (JavassistParameterDeclaration)
                rangeDecl.getConstructors().get(0).getParam(0);

        assertTrue(paramDecl.isParameter());
    }

    @Test
    void isType() {
        JavassistClassDeclaration rangeDecl =
                (JavassistClassDeclaration) typeSolver.solveType("com.github.javaparser.Range");
        JavassistParameterDeclaration paramDecl = (JavassistParameterDeclaration)
                rangeDecl.getConstructors().get(0).getParam(0);

        assertFalse(paramDecl.isType());
    }

    @Test
    void isVaraidic() {
        JavassistClassDeclaration cuDecl =
                (JavassistClassDeclaration) typeSolver.solveType("com.github" + ".javaparser" + ".ast.CompilationUnit");
        cuDecl.getDeclaredMethods().forEach(methodDecl -> {
            if ("addClass".equals(methodDecl.getName())) {
                if (methodDecl.getNumberOfParams() == 1) {
                    assertFalse(methodDecl.getParam(0).isVariadic());
                } else if (methodDecl.getNumberOfParams() == 2) {
                    assertFalse(methodDecl.getParam(0).isVariadic());
                    assertTrue(methodDecl.getParam(1).isVariadic());
                }
            }
        });
    }

    @Test
    void isEnumConstant() {
        JavassistClassDeclaration rangeDecl =
                (JavassistClassDeclaration) typeSolver.solveType("com.github.javaparser.Range");
        JavassistParameterDeclaration paramDecl = (JavassistParameterDeclaration)
                rangeDecl.getConstructors().get(0).getParam(0);

        assertFalse(paramDecl.isEnumConstant());
    }

    @Test
    void isMethod() {
        JavassistClassDeclaration rangeDecl =
                (JavassistClassDeclaration) typeSolver.solveType("com.github.javaparser.Range");
        JavassistParameterDeclaration paramDecl = (JavassistParameterDeclaration)
                rangeDecl.getConstructors().get(0).getParam(0);

        assertFalse(paramDecl.isMethod());
    }

    @Test
    void isVariable() {
        JavassistClassDeclaration rangeDecl =
                (JavassistClassDeclaration) typeSolver.solveType("com.github.javaparser.Range");
        JavassistParameterDeclaration paramDecl = (JavassistParameterDeclaration)
                rangeDecl.getConstructors().get(0).getParam(0);

        assertFalse(paramDecl.isVariable());
    }
}