Package com.github.javaparser.ast.nodeTypes

Interface NodeWithMembers<N extends Node>

All Superinterfaces:

NodeWithSimpleName<N>

All Known Implementing Classes:

AnnotationDeclaration, ClassOrInterfaceDeclaration, EnumDeclaration, RecordDeclaration, TypeDeclaration

public interface NodeWithMembers<N extends Node>
extends NodeWithSimpleName<N>

A node having members.

The main reason for this interface is to permit users to manipulate homogeneously all nodes with a getMembers method.

Method Summary

Modifier and Type	Method	Description
default ConstructorDeclaration	addConstructor(Modifier.Keyword... modifiers)	Adds a constructor to this node with members.
default FieldDeclaration	addField(Type type, String name, Modifier.Keyword... modifiers)	Add a field to this.
default FieldDeclaration	addField(Class<?> typeClass, String name, Modifier.Keyword... modifiers)	Add a field to this and automatically add the import of the type if needed
default FieldDeclaration	addField(String type, String name, Modifier.Keyword... modifiers)	Add a field to this.
default FieldDeclaration	addFieldWithInitializer(Type type, String name, Expression initializer, Modifier.Keyword... modifiers)	Add a field to this.
default FieldDeclaration	addFieldWithInitializer(Class<?> typeClass, String name, Expression initializer, Modifier.Keyword... modifiers)	Add a field to this and automatically add the import of the type if needed
default FieldDeclaration	addFieldWithInitializer(String type, String name, Expression initializer, Modifier.Keyword... modifiers)	Add a field to this.
default BlockStmt	addInitializer()	Add an initializer block (InitializerDeclaration) to this.
default N	addMember(BodyDeclaration<?> member)
default MethodDeclaration	addMethod(String methodName, Modifier.Keyword... modifiers)	Adds a methods with void return by default to this.
default FieldDeclaration	addPrivateField(Type type, String name)	Add a private field to this.
default FieldDeclaration	addPrivateField(Class<?> typeClass, String name)	Add a private field to this.
default FieldDeclaration	addPrivateField(String type, String name)	Add a private field to this and automatically add the import of the type if needed.
default FieldDeclaration	addProtectedField(Type type, String name)	Add a protected field to this.
default FieldDeclaration	addProtectedField(Class<?> typeClass, String name)	Add a protected field to this.
default FieldDeclaration	addProtectedField(String type, String name)	Add a protected field to this and automatically add the import of the type if needed.
default FieldDeclaration	addPublicField(Type type, String name)	Add a public field to this.
default FieldDeclaration	addPublicField(Class<?> typeClass, String name)	Add a public field to this.
default FieldDeclaration	addPublicField(String type, String name)	Add a public field to this and automatically add the import of the type if needed.
default BlockStmt	addStaticInitializer()	Add a static initializer block (InitializerDeclaration) to this.
default Optional<ConstructorDeclaration>	getConstructorByParameterTypes(Class<?>... paramTypes)	Try to find a ConstructorDeclaration by its parameter types.
default Optional<ConstructorDeclaration>	getConstructorByParameterTypes(String... paramTypes)	Try to find a ConstructorDeclaration by its parameter types.
default List<ConstructorDeclaration>	getConstructors()	Find all constructors in the members of this node.
default Optional<ConstructorDeclaration>	getDefaultConstructor()	Try to find a ConstructorDeclaration with no parameters.
default Optional<FieldDeclaration>	getFieldByName(String name)	Try to find a FieldDeclaration by its name
default List<FieldDeclaration>	getFields()	Find all fields in the members of this node.
default BodyDeclaration<?>	getMember(int i)
NodeList<BodyDeclaration<?>>	getMembers()
default List<MethodDeclaration>	getMethods()	Find all methods in the members of this node.
default List<MethodDeclaration>	getMethodsByName(String name)	Try to find a MethodDeclaration by its name
default List<MethodDeclaration>	getMethodsByParameterTypes(Class<?>... paramTypes)	Try to find a MethodDeclaration by its parameter types.
default List<MethodDeclaration>	getMethodsByParameterTypes(String... paramTypes)	Try to find a MethodDeclaration by its parameter types.
default List<MethodDeclaration>	getMethodsBySignature(String name, String... paramTypes)	Try to find MethodDeclarations by their name and parameter types.
default boolean	isEmpty()
default N	setMember(int i, BodyDeclaration<?> member)
N	setMembers(NodeList<BodyDeclaration<?>> members)
void	tryAddImportToParentCompilationUnit(Class<?> clazz)

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithSimpleName

getName, getNameAsExpression, getNameAsString, setName, setName

Method Detail

getMembers

NodeList<BodyDeclaration<?>> getMembers()

Returns:

all members inside the braces of this node, like fields, methods, nested types, etc.

tryAddImportToParentCompilationUnit

void tryAddImportToParentCompilationUnit(Class<?> clazz)

getMember

default BodyDeclaration<?> getMember(int i)

setMember

default N setMember(int i,
                    BodyDeclaration<?> member)

addMember

default N addMember(BodyDeclaration<?> member)

setMembers

N setMembers(NodeList<BodyDeclaration<?>> members)

addField

default FieldDeclaration addField(Class<?> typeClass,
                                  String name,
                                  Modifier.Keyword... modifiers)

Add a field to this and automatically add the import of the type if needed

Parameters:

typeClass - the type of the field

name - the name of the field

modifiers - the modifiers like Modifier.Keyword.PUBLIC

Returns:

the FieldDeclaration created

addField

default FieldDeclaration addField(String type,
                                  String name,
                                  Modifier.Keyword... modifiers)

Add a field to this.

Parameters:

type - the type of the field

name - the name of the field

modifiers - the modifiers like Modifier.Keyword.PUBLIC

Returns:

the FieldDeclaration created

addField

default FieldDeclaration addField(Type type,
                                  String name,
                                  Modifier.Keyword... modifiers)

Add a field to this.

Parameters:

type - the type of the field

name - the name of the field

modifiers - the modifiers like Modifier.Keyword.PUBLIC

Returns:

the FieldDeclaration created

addFieldWithInitializer

default FieldDeclaration addFieldWithInitializer(Class<?> typeClass,
                                                 String name,
                                                 Expression initializer,
                                                 Modifier.Keyword... modifiers)

Add a field to this and automatically add the import of the type if needed

Parameters:

typeClass - the type of the field

name - the name of the field

initializer - the initializer of the field

modifiers - the modifiers like Modifier.Keyword.PUBLIC

Returns:

the FieldDeclaration created

addFieldWithInitializer

default FieldDeclaration addFieldWithInitializer(String type,
                                                 String name,
                                                 Expression initializer,
                                                 Modifier.Keyword... modifiers)

Add a field to this.

Parameters:

type - the type of the field

name - the name of the field

initializer - the initializer of the field

modifiers - the modifiers like Modifier.Keyword.PUBLIC

Returns:

the FieldDeclaration created

addFieldWithInitializer

default FieldDeclaration addFieldWithInitializer(Type type,
                                                 String name,
                                                 Expression initializer,
                                                 Modifier.Keyword... modifiers)

Add a field to this.

Parameters:

type - the type of the field

name - the name of the field

initializer - the initializer of the field

modifiers - the modifiers like Modifier.Keyword.PUBLIC

Returns:

the FieldDeclaration created

addPrivateField

default FieldDeclaration addPrivateField(Class<?> typeClass,
                                         String name)

Add a private field to this.

Parameters:

typeClass - the type of the field

name - the name of the field

Returns:

the FieldDeclaration created

addPrivateField

default FieldDeclaration addPrivateField(String type,
                                         String name)

Add a private field to this and automatically add the import of the type if needed.

Parameters:

type - the type of the field

name - the name of the field

Returns:

the FieldDeclaration created

addPrivateField

default FieldDeclaration addPrivateField(Type type,
                                         String name)

Add a private field to this.

Parameters:

type - the type of the field

name - the name of the field

Returns:

the FieldDeclaration created

addPublicField

default FieldDeclaration addPublicField(Class<?> typeClass,
                                        String name)

Add a public field to this.

Parameters:

typeClass - the type of the field

name - the name of the field

Returns:

the FieldDeclaration created

addPublicField

default FieldDeclaration addPublicField(String type,
                                        String name)

Add a public field to this and automatically add the import of the type if needed.

Parameters:

type - the type of the field

name - the name of the field

Returns:

the FieldDeclaration created

addPublicField

default FieldDeclaration addPublicField(Type type,
                                        String name)

Add a public field to this.

Parameters:

type - the type of the field

name - the name of the field

Returns:

the FieldDeclaration created

addProtectedField

default FieldDeclaration addProtectedField(Class<?> typeClass,
                                           String name)

Add a protected field to this.

Parameters:

typeClass - the type of the field

name - the name of the field

Returns:

the FieldDeclaration created

addProtectedField

default FieldDeclaration addProtectedField(String type,
                                           String name)

Add a protected field to this and automatically add the import of the type if needed.

Parameters:

type - the type of the field

name - the name of the field

Returns:

the FieldDeclaration created

addProtectedField

default FieldDeclaration addProtectedField(Type type,
                                           String name)

Add a protected field to this.

Parameters:

type - the type of the field

name - the name of the field

Returns:

the FieldDeclaration created

addMethod

default MethodDeclaration addMethod(String methodName,
                                    Modifier.Keyword... modifiers)

Adds a methods with void return by default to this.

Parameters:

methodName - the method name

modifiers - the modifiers like Modifier.Keyword.PUBLIC

Returns:

the MethodDeclaration created

addConstructor

default ConstructorDeclaration addConstructor(Modifier.Keyword... modifiers)

Adds a constructor to this node with members.

Parameters:

modifiers - the modifiers like Modifier.Keyword.PUBLIC

Returns:

the created constructor

addInitializer

default BlockStmt addInitializer()

Add an initializer block (InitializerDeclaration) to this.

addStaticInitializer

default BlockStmt addStaticInitializer()

Add a static initializer block (InitializerDeclaration) to this.

getMethodsByName

default List<MethodDeclaration> getMethodsByName(String name)

Try to find a MethodDeclaration by its name

Parameters:

name - the name of the method

Returns:

the methods found (multiple in case of overloading)

getMethods

default List<MethodDeclaration> getMethods()

Find all methods in the members of this node.

Returns:

the methods found. This list is immutable.

getMethodsByParameterTypes

default List<MethodDeclaration> getMethodsByParameterTypes(String... paramTypes)

Try to find a MethodDeclaration by its parameter types. The given parameter types must literally match the declared types of this node's parameters, so passing the string "List" to this method will find all methods that have exactly one parameter whose type is declared as List, but not methods with exactly one parameter whose type is declared as java.util.List or java.awt.List. Conversely, passing the string "java.util.List" to this method will find all methods that have exactly one parameter whose type is declared as java.util.List, but not if the parameter type is declared as List. Similarly, note that generics are matched as well: If there is a method that has a parameter declared as List<String>, then it will be considered as a match only if the given string is "List<String>", but not if the given string is only "List".

Parameters:

paramTypes - the types of parameters like "Map<Integer, String>", "int" to match void foo(Map<Integer,String> myMap, int number)

Returns:

the methods found

getMethodsBySignature

default List<MethodDeclaration> getMethodsBySignature(String name,
                                                      String... paramTypes)

Try to find MethodDeclarations by their name and parameter types. Parameter types are matched exactly as in the case of getMethodsByParameterTypes(String...).

Parameters:

paramTypes - the types of parameters like "Map<Integer, String>", "int" to match void foo(Map<Integer,String> myMap, int number)

Returns:

the methods found

getMethodsByParameterTypes

default List<MethodDeclaration> getMethodsByParameterTypes(Class<?>... paramTypes)

Try to find a MethodDeclaration by its parameter types. Note that this is a match in SimpleName, so java.awt.List and java.util.List are identical to this algorithm. In addition, note that it is the erasure of each type which is considered, so passing List.class to this method will return all methods that have exactly one parameter whose type is named List, regardless of whether the parameter type is declared without generics as List, or with generics as List<String>, or List<Integer>, etc.

Parameters:

paramTypes - the types of parameters like Map.class, int.class to match void foo(Map<Integer,String> myMap, int number)

Returns:

the methods found

getConstructors

default List<ConstructorDeclaration> getConstructors()

Find all constructors in the members of this node. Note that only "normal" constructors, not the "compact" constructors", within RecordDeclaration are included in the output of this method.

Returns:

the constructors found. This list is immutable.

getDefaultConstructor

default Optional<ConstructorDeclaration> getDefaultConstructor()

Try to find a ConstructorDeclaration with no parameters.

Returns:

the constructor found, if any.

getConstructorByParameterTypes

default Optional<ConstructorDeclaration> getConstructorByParameterTypes(String... paramTypes)

Try to find a ConstructorDeclaration by its parameter types. The given parameter types must literally match the declared types of the desired constructor, so passing the string "List" to this method will search for a constructor that has exactly one parameter whose type is declared as List, but not for a constructor with exactly one parameter whose type is declared as java.util.List or java.awt.List. Conversely, passing the string "java.util.List" to this method will search for a constructor that has exactly one parameter whose type is declared as java.util.List, but not for a constructor whose type is declared as List. Similarly, note that generics are matched as well: If there is a constructor that has a parameter declared as List<String>, then it will be considered as a match only if the given string is "List<String>", but not if the given string is only "List".

Parameters:

paramTypes - the types of parameters like "Map<Integer, String>", "int" to match Foo(Map<Integer,String> myMap, int number)

Returns:

the constructor found, if any.

getConstructorByParameterTypes

default Optional<ConstructorDeclaration> getConstructorByParameterTypes(Class<?>... paramTypes)

Try to find a ConstructorDeclaration by its parameter types. Note that this is a match in SimpleName, so java.awt.List and java.util.List are identical to this algorithm. In addition, note that it is the erasure of each type which is considered, so passing List.class to this method will search for a constructor that has exactly one parameter whose type is named List, regardless of whether the parameter type is declared without generics as List, or with generics as List<String>, or List<Integer>, etc.

Parameters:

paramTypes - the types of parameters like Map.class, int.class to match Foo(Map<Integer,String> myMap, int number)

Returns:

the constructor found, if any.

getFieldByName

default Optional<FieldDeclaration> getFieldByName(String name)

Try to find a FieldDeclaration by its name

Parameters:

name - the name of the field

Returns:

null if not found, the FieldDeclaration otherwise

getFields

default List<FieldDeclaration> getFields()

Find all fields in the members of this node.

Returns:

the fields found. This list is immutable.

isEmpty

default boolean isEmpty()

Returns:

true if there are no members contained in this node.