JavaParser Source Viewer

Home|JavaParser/com/github/javaparser/ast/nodeTypes/NodeWithType.java
1/*
2 * Copyright (C) 2007-2010 JĂșlio Vilmar Gesser.
3 * Copyright (C) 2011, 2013-2020 The JavaParser Team.
4 *
5 * This file is part of JavaParser.
6 *
7 * JavaParser can be used either under the terms of
8 * a) the GNU Lesser General Public License as published by
9 *     the Free Software Foundation, either version 3 of the License, or
10 *     (at your option) any later version.
11 * b) the terms of the Apache License
12 *
13 * You should have received a copy of both licenses in LICENCE.LGPL and
14 * LICENCE.APACHE. Please refer to those files for details.
15 *
16 * JavaParser is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 * GNU Lesser General Public License for more details.
20 */
21
22package com.github.javaparser.ast.nodeTypes;
23
24import com.github.javaparser.ast.CompilationUnit;
25import com.github.javaparser.ast.Node;
26import com.github.javaparser.ast.type.Type;
27
28import static com.github.javaparser.StaticJavaParser.parseType;
29import static com.github.javaparser.utils.Utils.assertNonEmpty;
30
31/**
32 * A node with a type.
33 * <p>
34 * The main reason for this interface is to permit users to manipulate homogeneously all nodes with getType/setType
35 * methods
36 *
37 * @since 2.3.1
38 */
39public interface NodeWithType<N extends NodeT extends Type> {
40    /**
41     * Gets the type
42     *
43     * @return the type
44     */
45    T getType();
46
47    /**
48     * Sets the type
49     *
50     * @param type the type
51     * @return this
52     */
53    N setType(T type);
54
55    void tryAddImportToParentCompilationUnit(Class<?> clazz);
56
57    /**
58     * Sets this type to this class and try to import it to the {@link CompilationUnit} if needed
59     *
60     * @param typeClass the type
61     * @return this
62     */
63    @SuppressWarnings("unchecked")
64    default N setType(Class<?> typeClass) {
65        tryAddImportToParentCompilationUnit(typeClass);
66        return setType((TparseType(typeClass.getSimpleName()));
67    }
68
69    @SuppressWarnings("unchecked")
70    default N setType(final String typeString) {
71        assertNonEmpty(typeString);
72        return setType((TparseType(typeString));
73    }
74
75    default String getTypeAsString() {
76        return getType().asString();
77    }
78}
79
MembersX
NodeWithType:tryAddImportToParentCompilationUnit
NodeWithType:setType
NodeWithType:getType
NodeWithType:getTypeAsString
Members
X