Home | History | Annotate | Download | only in nodeTypes
      1 /*
      2  * Copyright (C) 2007-2010 Jlio Vilmar Gesser.
      3  * Copyright (C) 2011, 2013-2015 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 
     22 package com.github.javaparser.ast.nodeTypes;
     23 
     24 import com.github.javaparser.ast.ArrayBracketPair;
     25 import com.github.javaparser.ast.CompilationUnit;
     26 import com.github.javaparser.ast.Node;
     27 import com.github.javaparser.ast.body.MethodDeclaration;
     28 import com.github.javaparser.ast.type.ClassOrInterfaceType;
     29 import com.github.javaparser.ast.type.Type;
     30 
     31 import java.util.List;
     32 
     33 /**
     34  * A node having an element type.
     35  * In most cases, the element type is simply the type.
     36  * In case of arrays, the element type is the type that is inside the deepest nesting:
     37  * for int[][][], the element type is int.
     38  *
     39  * The main reason for this interface is to permit users to manipulate homogeneously all nodes with getElementType/setElementType
     40  * methods
     41  */
     42 public interface NodeWithElementType<T> {
     43     /**
     44      * @return the element type
     45      */
     46     Type<?> getElementType();
     47 
     48     /**
     49      * @param elementType the element elementType
     50      * @return this
     51      */
     52     T setElementType(Type<?> elementType);
     53 
     54     List<ArrayBracketPair> getArrayBracketPairsAfterElementType();
     55 
     56     T setArrayBracketPairsAfterElementType(List<ArrayBracketPair> arrayBracketPairsAfterType);
     57 
     58     /**
     59      * Sets this type to this class and try to import it to the {@link CompilationUnit} if needed
     60      *
     61      * @param typeClass the type
     62      * @return this
     63      */
     64     default T setElementType(Class<?> typeClass) {
     65         ((Node) this).tryAddImportToParentCompilationUnit(typeClass);
     66         return setElementType(new ClassOrInterfaceType(typeClass.getSimpleName()));
     67     }
     68 
     69     default T setElementType(final String type) {
     70         ClassOrInterfaceType classOrInterfaceType = new ClassOrInterfaceType(type);
     71         return setElementType(classOrInterfaceType);
     72     }
     73 }
     74