blob: 97f35f59587b3922211be9544ca99476e8cfa06f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
/*
* Copyright (C) 2007-2010 Júlio Vilmar Gesser.
* Copyright (C) 2011, 2013-2016 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.resolution.declarations;
import com.github.javaparser.resolution.types.ResolvedType;
import java.util.Collections;
import java.util.LinkedList;
import java.util.List;
import java.util.Optional;
/**
* This is a common interface for MethodDeclaration and ConstructorDeclaration.
*
* @author Federico Tomassetti
*/
public interface ResolvedMethodLikeDeclaration extends ResolvedDeclaration,
ResolvedTypeParametrizable, HasAccessSpecifier {
/**
* The package name of the declaring type.
*/
default String getPackageName() {
return declaringType().getPackageName();
}
/**
* The class(es) wrapping the declaring type.
*/
default String getClassName() {
return declaringType().getClassName();
}
/**
* The qualified name of the method composed by the qualfied name of the declaring type
* followed by a dot and the name of the method.
*/
default String getQualifiedName() {
return declaringType().getQualifiedName() + "." + this.getName();
}
/**
* The signature of the method.
*/
default String getSignature() {
StringBuilder sb = new StringBuilder();
sb.append(getName());
sb.append("(");
for (int i = 0; i < getNumberOfParams(); i++) {
if (i != 0) {
sb.append(", ");
}
sb.append(getParam(i).describeType());
}
sb.append(")");
return sb.toString();
}
/**
* The qualified signature of the method. It is composed by the qualified name of the declaring type
* followed by the signature of the method.
*/
default String getQualifiedSignature() {
return declaringType().getId() + "." + this.getSignature();
}
/**
* The type in which the method is declared.
*/
ResolvedReferenceTypeDeclaration declaringType();
/**
* Number of params.
*/
int getNumberOfParams();
/**
* Get the ParameterDeclaration at the corresponding position or throw IllegalArgumentException.
*/
ResolvedParameterDeclaration getParam(int i);
/**
* Utility method to get the last ParameterDeclaration. It throws UnsupportedOperationException if the method
* has no parameters.
* The last parameter can be variadic and sometimes it needs to be handled in a special way.
*/
default ResolvedParameterDeclaration getLastParam() {
if (getNumberOfParams() == 0) {
throw new UnsupportedOperationException("This method has no typeParametersValues, therefore it has no a last parameter");
}
return getParam(getNumberOfParams() - 1);
}
/**
* Has the method or construcor a variadic parameter?
* Note that when a method has a variadic parameter it should have an array type.
*/
default boolean hasVariadicParameter() {
if (getNumberOfParams() == 0) {
return false;
} else {
return getParam(getNumberOfParams() - 1).isVariadic();
}
}
@Override
default Optional<ResolvedTypeParameterDeclaration> findTypeParameter(String name) {
for (ResolvedTypeParameterDeclaration tp : this.getTypeParameters()) {
if (tp.getName().equals(name)) {
return Optional.of(tp);
}
}
return declaringType().findTypeParameter(name);
}
/**
* Number of exceptions listed in the throws clause.
*/
int getNumberOfSpecifiedExceptions();
/**
* Type of the corresponding entry in the throws clause.
*
* @throws IllegalArgumentException if the index is negative or it is equal or greater than the value returned by
* getNumberOfSpecifiedExceptions
* @throws UnsupportedOperationException for those types of methods of constructor that do not declare exceptions
*/
ResolvedType getSpecifiedException(int index);
default List<ResolvedType> getSpecifiedExceptions() {
if (getNumberOfSpecifiedExceptions() == 0) {
return Collections.emptyList();
} else {
List<ResolvedType> exceptions = new LinkedList<>();
for (int i=0;i<getNumberOfSpecifiedExceptions();i++) {
exceptions.add(getSpecifiedException(i));
}
return exceptions;
}
}
}
|
