-
Notifications
You must be signed in to change notification settings - Fork 33
/
AbstractJClass.java
547 lines (497 loc) · 14.7 KB
/
AbstractJClass.java
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
/**
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
* Portions Copyright 2013-2018 Philip Helger + contributors
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.helger.jcodemodel;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import com.helger.jcodemodel.util.JCValueEnforcer;
/**
* Represents a Java reference type, such as a class, an interface, an enum, an
* array type, a parameterized type.
* <p>
* To be exact, this object represents an "use" of a reference type, not
* necessarily a declaration of it, which is modeled as {@link JDefinedClass}.
*/
public abstract class AbstractJClass extends AbstractJType
{
/**
* Sometimes useful reusable empty array.
*/
public static final JTypeVar [] EMPTY_ARRAY = new JTypeVar [0];
private final JCodeModel m_aOwner;
private JArrayClass m_aArrayClass;
protected AbstractJClass (@Nonnull final JCodeModel aOwner)
{
m_aOwner = JCValueEnforcer.notNull (aOwner, "Owner");
}
/**
* Gets the name of this class.
*
* @return name of this class, without any qualification. For example, this
* method returns "String" for <code>java.lang.String</code>.
*/
@Override
public abstract String name ();
/**
* Gets the package to which this class belongs. TODO: shall we move move this
* down?
*
* @return The {@link JPackage} this class belongs to. Is usually not
* <code>null</code> except for the {@link JTypeVar} and the
* {@link JTypeWildcard} implementation.
*/
public abstract JPackage _package ();
/**
* @return the class in which this class is nested, or <tt>null</tt> if this
* is a top-level class.
*/
@Nullable
public AbstractJClass outer ()
{
return null;
}
@Nonnull
public final JCodeModel owner ()
{
return m_aOwner;
}
/**
* Gets the super class of this class.
*
* @return Returns the {@link AbstractJClass} representing the superclass of
* the entity (class or interface) represented by this
* {@link AbstractJClass}. Even if no super class is given explicitly
* or this {@link AbstractJClass} is not a class, this method still
* returns {@link AbstractJClass} for {@link Object}. If this
* {@link AbstractJClass} represents {@link Object}, return null.
*/
@Nullable
public abstract AbstractJClass _extends ();
/**
* Iterates all super interfaces directly implemented by this class/interface.
*
* @return A non-null valid iterator that iterates all {@link AbstractJClass}
* objects that represents those interfaces implemented by this
* object.
*/
@Nonnull
public abstract Iterator <AbstractJClass> _implements ();
/**
* @return <code>true</code> if this object represents an interface.
*/
public abstract boolean isInterface ();
/**
* @return <code>true</code> if this class is an abstract class.
*/
public abstract boolean isAbstract ();
/**
* @return If this class represents one of the wrapper classes defined in the
* <code>java.lang</code> package, return the corresponding primitive
* type. Otherwise <code>null</code>.
*/
@Nullable
public JPrimitiveType getPrimitiveType ()
{
return null;
}
/**
* @deprecated calling this method from {@link AbstractJClass} would be
* meaningless, since it's always guaranteed to return
* <tt>this</tt>.
*/
@Deprecated
@Override
public final AbstractJClass boxify ()
{
return this;
}
@Override
@Nonnull
public final AbstractJType unboxify ()
{
final JPrimitiveType aPrimitiveType = getPrimitiveType ();
return aPrimitiveType == null ? this : aPrimitiveType;
}
@Override
@Nonnull
public AbstractJClass erasure ()
{
return this;
}
/**
* Gets the parameterization of the given base type.
* <p>
* For example, given the following
*
* <pre>
* <code>
* interface Foo<T> extends List<List<T>> {}
* interface Bar extends Foo<String> {}
* </code>
* </pre>
*
* This method works like this:
*
* <pre>
* <code>
* getBaseClass( Bar, List ) = List<List<String>
* getBaseClass( Bar, Foo ) = Foo<String>
* getBaseClass( Foo<? extends Number>, Collection ) = Collection<List<? extends Number>>
* getBaseClass( ArrayList<? extends BigInteger>, List ) = List<? extends BigInteger>
* </code>
* </pre>
*
* @param aBaseType
* The class whose parameterization we are interested in.
* @return The use of {@code baseType} in {@code this} type. or null if the
* type is not assignable to the base type.
*/
@Nullable
public final AbstractJClass getBaseClass (@Nonnull final AbstractJClass aBaseType)
{
if (erasure ().equals (aBaseType))
return this;
final AbstractJClass b = _extends ();
if (b != null)
{
final AbstractJClass bc = b.getBaseClass (aBaseType);
if (bc != null)
return bc;
}
final Iterator <AbstractJClass> itfs = _implements ();
while (itfs.hasNext ())
{
final AbstractJClass bc = itfs.next ().getBaseClass (aBaseType);
if (bc != null)
return bc;
}
return null;
}
@Nullable
public final AbstractJClass getBaseClass (@Nonnull final Class <?> aBaseType)
{
return getBaseClass (owner ().ref (aBaseType));
}
@Override
@Nonnull
public JArrayClass array ()
{
if (m_aArrayClass == null)
m_aArrayClass = new JArrayClass (owner (), this);
return m_aArrayClass;
}
/**
* "Narrows" a generic class to a concrete class by specifying a type
* argument.<br>
* <code>.narrow(X)</code> builds <code>Set<X></code> from
* <code>Set</code>.
*
* @param aClazz
* class to narrow with
* @return Never <code>null</code>. Narrowed class.
*/
@Nonnull
public JNarrowedClass narrow (@Nonnull final Class <?> aClazz)
{
return narrow (owner ().ref (aClazz));
}
@Nonnull
public AbstractJClass narrow (@Nonnull final Class <?>... aClazzes)
{
final List <AbstractJClass> r = new ArrayList <> (aClazzes.length);
for (final Class <?> aElement : aClazzes)
r.add (owner ().ref (aElement));
return narrow (r);
}
/**
* "Narrows" a generic class to a concrete class by specifying a type
* argument. <br>
* <code>.narrow(X)</code> builds <code>Set<X></code> from
* <code>Set</code>.
*
* @param aClazz
* class to narrow with
* @return Never <code>null</code>. Narrowed class.
*/
@Nonnull
public JNarrowedClass narrow (@Nonnull final AbstractJClass aClazz)
{
return new JNarrowedClass (this, aClazz);
}
@Nonnull
public JNarrowedClass narrow (@Nonnull final AbstractJType aType)
{
return narrow (aType.boxify ());
}
@Nonnull
public AbstractJClass narrow (@Nonnull final AbstractJClass... aClazz)
{
return new JNarrowedClass (this, Arrays.asList (aClazz.clone ()));
}
@Nonnull
public AbstractJClass narrow (@Nonnull final List <? extends AbstractJClass> aClazz)
{
return new JNarrowedClass (this, new ArrayList <> (aClazz));
}
/**
* @return A narrowed type without any type parameter (as in
* <code>HashMap <></code>)
*/
@Nonnull
public AbstractJClass narrowEmpty ()
{
return new JNarrowedClass (this, new ArrayList <> ());
}
/**
* @return A narrowed type just with a "?" parameter (as in
* <code>HashMap <?></code>)
* @since 3.0.0
*/
@Nonnull
public AbstractJClass narrowAny ()
{
return narrow (owner ().wildcard ());
}
/**
* @return If this class is parameterized, the type parameters of the given
* index.
*/
@Nonnull
public List <? extends AbstractJClass> getTypeParameters ()
{
return Collections.emptyList ();
}
/**
* Iterates all the type parameters of this class/interface. <br>
* For example, if this {@link AbstractJClass} represents
* <code>Set<T></code>, this method returns an array that contains
* single {@link JTypeVar} for 'T'.
*
* @return All type parameters as array.
*/
@Nonnull
public JTypeVar [] typeParams ()
{
return EMPTY_ARRAY;
}
/**
* @return <code>true</code> if this class is a parameterized class.
*/
public final boolean isParameterized ()
{
return erasure () != this;
}
/**
* Create "? extends T" from T.
*
* @return never <code>null</code>
* @deprecated Use {@link #wildcardExtends()} instead
*/
@Nonnull
@Deprecated
public final JTypeWildcard wildcard ()
{
return wildcardExtends ();
}
/**
* Create "? extends T" from T.
*
* @return never <code>null</code>
* @since 3.0.0
*/
@Nonnull
public final JTypeWildcard wildcardExtends ()
{
return wildcard (EWildcardBoundMode.EXTENDS);
}
/**
* Create "? super T" from T.
*
* @return never <code>null</code>
*/
@Nonnull
public final JTypeWildcard wildcardSuper ()
{
return wildcard (EWildcardBoundMode.SUPER);
}
/**
* Create "? extends T" from T or "? super T" from T.
*
* @param eMode
* "extends" or "super"
* @return never <code>null</code>
*/
@Nonnull
public final JTypeWildcard wildcard (@Nonnull final EWildcardBoundMode eMode)
{
return new JTypeWildcard (this, eMode);
}
/**
* Substitutes the type variables with their actual arguments. <br>
* For example, when this class is Map<String,Map<V>>, (where V
* then doing substituteParams( V, Integer ) returns a {@link AbstractJClass}
* for <code>Map<String,Map<Integer>></code>. <br>
* This method needs to work recursively.
*
* @param aVariables
* Type variables
* @param aBindings
* Bindings
* @return Never <code>null</code>.
*/
@Nonnull
protected abstract AbstractJClass substituteParams (@Nonnull JTypeVar [] aVariables,
@Nonnull List <? extends AbstractJClass> aBindings);
/**
* Check if this class is a class container and if so try to find the inner
* class with the provided name.
*
* @param sName
* The name to check. May be <code>null</code>.
* @return The inner class with the provided name.
* @since 3.0.3
*/
@Nullable
public AbstractJClassContainer <?> getInnerClass (@Nullable final String sName)
{
if (sName != null && this instanceof AbstractJClassContainer <?>)
{
@SuppressWarnings ("rawtypes")
final Collection <AbstractJClassContainer <?>> aInnerClasses = ((AbstractJClassContainer) this).classes ();
for (final AbstractJClassContainer <?> aInnerClass : aInnerClasses)
if (aInnerClass.name ().equals (sName))
return aInnerClass;
}
return null;
}
/**
* @return name<code>.class</code>
*/
@Nonnull
public final IJExpression dotclass ()
{
return JExpr.dotclass (this);
}
/**
* Generates a static method invocation.
*
* @param aMethod
* Method to be invoked
* @return Newly created {@link JInvocation}
*/
@Nonnull
public final JInvocation staticInvoke (@Nonnull final JMethod aMethod)
{
return new JInvocation (this, aMethod);
}
/**
* Generates a static method invocation.
*
* @param sMethod
* Method to be invoked
* @return Newly created {@link JInvocation}
*/
@Nonnull
public final JInvocation staticInvoke (@Nonnull final String sMethod)
{
return new JInvocation (this, sMethod);
}
/**
* Static field reference.
*
* @param sField
* Field to be referenced
* @return Newly created {@link JFieldRef}
*/
@Nonnull
public final JFieldRef staticRef (@Nonnull final String sField)
{
return new JFieldRef (this, sField);
}
/**
* Static field reference.
*
* @param aField
* Field to be referenced
* @return Newly created {@link JFieldRef}
*/
@Nonnull
public final JFieldRef staticRef (@Nonnull final JVar aField)
{
return new JFieldRef (this, aField);
}
/**
* Method reference for JDK8 (as in <code>String::valueOf</code>).
*
* @param sMethod
* Method to be referenced
* @return Newly created {@link JLambdaMethodRef}
*/
@Nonnull
public final JLambdaMethodRef methodRef (@Nonnull final String sMethod)
{
return new JLambdaMethodRef (this, sMethod);
}
public void generate (@Nonnull final JFormatter f)
{
f.type (this);
}
/**
* Prints the class name in javadoc @link format.
*
* @param f
* Formatter to be used
*/
void printLink (@Nonnull final JFormatter f)
{
f.print ("{@link ").generable (this).print ('}');
}
@Override
public String toString ()
{
return getClass ().getName () + '(' + fullName () + ')';
}
}