forked from ashishjohn1908/Java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtypes.html
More file actions
603 lines (555 loc) · 22.6 KB
/
Copy pathtypes.html
File metadata and controls
603 lines (555 loc) · 22.6 KB
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
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Generic Types (The Java™ Tutorials >
Learning the Java Language > Generics (Updated))
</title>
<meta name="description" content="This beginner Java tutorial describes fundamentals of programming in the Java programming language" />
<meta name="keywords" content="java programming, learn java, java sample code, java objects, java classes, java inheritance, interfaces, variables, arrays, data types, operators, control flow, number, string" />
<style type="text/css">
.FigureCaption {
margin-left: 1in;
margin-right: 1in;
font-family: sans-serif;
font-size: smaller;
text-align: justify;
}
#TopBar_bl {
background: url(../../images/java_bar_bl.gif) 0 100% no-repeat;
width: 100%;
height: 60px;
}
#TopBar_br {
background: url(../../images/java_bar_br.gif) 100% 100% no-repeat;
width: 100%;
height: 60px;
}
#TopBar_tl {
background: url(../../images/java_bar_tl.gif) 0 0 no-repeat;
width: 100%;
height: 60px;
}
#TopBar_tr {
background: url(../../images/java_bar_tr.gif) 100% 0 no-repeat;
width: 100%;
height: 60px;
}
#TopBar {
background: #35556B url(../../images/java_bar.gif);
margin: 10px 10px 0 10px;
height:60px;
min-width:700px;
color: white;
font-family: sans-serif;
font-weight: bold;
}
@media print {
#BreadCrumbs, #Download {
display: none;
}
}
#TopBar_right {
line-height: 14px;
float: right;
padding-top: 2px;
padding-right: 30px;
text-align: left;
}
@media print {
#TopBar_right {
display: none;
}
}
#TopBar_right a {
font-size: 12px;
margin: 3px;
padding: 0;
}
#TopBar a:visited, #TopBar a:link {
color: white;
text-decoration: none;
}
#TopBar a:hover, #TopBar a:active {
background-color: white;
color: #35556B;
}
#BreadCrumbs {
padding: 4px 5px 0.5em 0;
font-family: sans-serif;
float: right;
}
#BreadCrumbs a {
color: blue;
}
#BreadCrumbs a:visited, #BreadCrumbs a:link {
text-decoration: none;
}
#BreadCrumbs a:hover, #BreadCrumbs a:active {
text-decoration: underline;
}
#PageTitle {
margin: 0 5px 0.5em 0;
color: #F90000;
}
#PageContent{
margin: 0 5px 0 20px;
}
.LeftBar_shown {
width: 13em;
float: left;
margin-left: 10px;
margin-top: 4px;
margin-bottom: 2em;
margin-right: 10px;
}
@media print {
.LeftBar_shown {
display: none;
}
}
.LeftBar_hidden {
display: none;
}
#Footer {
padding-top: 10px;
padding-left: 10px;
margin-right: 10px;
}
.footertext {
font-size: 10px;
font-family: sans-serif;
margin-top: 1px;
}
#Footer2 {
padding-top: 10px;
padding-left: 10px;
margin-right: 10px;
}
.NavBit {
padding: 4px 5px 0.5em 0;
font-family: sans-serif;
}
@media print {
.NavBit {
display: none;
}
}
#TagNotes {
text-align: right;
}
@media print {
#TagNotes a:visited, #TagNotes a:link {
color: #35556B;
text-decoration: none;
}
}
#Contents a, .NavBit a, #TagNotes a {
color: blue
}
#TagNotes a:visited, #TagNotes a:link,
#Contents a:visited, #Contents a:link,
.NavBit a:visited, .NavBit a:link {
text-decoration: none;
}
#TagNotes a:hover, #TagNotes a:active,
#Contents a:hover, #Contents a:active,
.NavBit a:hover, .NavBit a:active {
text-decoration: underline;
}
#Contents {
float: left;
font-family: sans-serif;
}
@media print {
#Contents {
display: none;
}
}
@media screen {
div.PrintHeaders {
display: none;
}
}
.linkLESSON, .nolinkLESSON {
margin-left: 0.5em;
text-indent: -0.5em
}
.linkAHEAD, .nolinkAHEAD, .linkQUESTIONS, .nolinkQUESTIONS {
margin-left: 1.5em;
text-indent: -0.5em
}
.linkBHEAD, .nolinkBHEAD {
margin-left: 2.5em;
text-indent: -0.5em
}
.linkCHEAD, .nolinkCHEAD {
margin-left: 3.5em;
text-indent: -0.5em
}
.nolinkLESSON, .nolinkAHEAD, .nolinkBHEAD, .nolinkCHEAD,
.nolinkQUESTIONS {
font-weight: bold;
color: #F90000;
}
.MainFlow_indented {
margin-right: 10px;
margin-left: 15em;
margin-bottom: 2em;
}
.MainFlow_wide {
margin-right: 10px;
margin-left: 10px;
margin-bottom: 2em;
}
@media print {
.MainFlow_indented, .MainFlow_wide {
padding-top: 0;
margin-top: 10px;
margin-right: 10px;
margin-left: 0;
}
}
h1, h2, h3, h4, h5 {
color: #F90000;
font-family: sans-serif;
}
h1 {
font-weight: bold;
font-size: 20px;
}
h2 {
font-weight: bold;
font-size: 17px;
}
h3 {
font-weight: bold;
font-size: 14px;
}
h4 {
font-size: 15px;
}
h5 {
font-size: 12px;
}
#ToggleLeft {
display: none;
}
.note {
margin: 0 30px 0px 30px;
}
.codeblock {
margin: 0 30px 0px 30px;
}
.tocli {
list-style-type:none;
}
.betadraft {
color: red;
}
</style>
<script type="text/javascript">
/* <![CDATA[ */
function leftBar() {
var nameq = 'tutorial_showLeftBar='
var cookies = document.cookie.split(';');
for (var i = 0; i < cookies.length; i++) {
var cookieString = cookies[i];
while (cookieString.charAt(0) == ' ') {
cookieString = cookieString.substring(1, cookieString.length);
}
if (cookieString.indexOf(nameq) == 0) {
cookieValue = cookieString.substring(nameq.length,
cookieString.length);
return cookieValue == 'yes';
}
}
return true;
}
function showLeft(b) {
var contents = document.getElementById("LeftBar");
var main = document.getElementById("MainFlow");
var toggle = document.getElementById("ToggleLeft");
if (b) {
contents.className = "LeftBar_shown";
main.className = "MainFlow_indented";
toggle.innerHTML = "Hide TOC";
document.cookie = 'tutorial_showLeftBar=yes; path=/';
} else {
contents.className = "LeftBar_hidden";
main.className = "MainFlow_wide";
toggle.innerHTML = "Show the TOC";
document.cookie = 'tutorial_showLeftBar=no; path=/';
}
}
function toggleLeft() {
showLeft(document.getElementById("LeftBar").className ==
"LeftBar_hidden");
document.getElementById("ToggleLeft").blur();
}
function load() {
showLeft(leftBar());
document.getElementById("ToggleLeft").style.display="inline";
}
function showCode(displayCodePage, codePath) {
var codePathEls = codePath.split("/");
var currDocPathEls = location.href.split("/");
//alert ("codePathEls = " + codePathEls + "\n" + "currDocPathEls = " + currDocPathEls);
currDocPathEls.pop(); // remove file name at the end
while (codePathEls.length > 0) {
if (codePathEls[0] == "..") {
codePathEls.shift();
currDocPathEls.pop();
} else {
break;
}
}
var fullCodePath = currDocPathEls.join("/") + "/" + codePathEls.join("/");
//alert ("fullCodePath = " + fullCodePath );
if (codePath.indexOf(".java") != -1 || codePath.indexOf(".jnlp") != -1) {
window.location.href = displayCodePage + "?code=" + encodeURI(fullCodePath);
} else {
window.location.href = fullCodePath;
}
}
/* ]]> */
</script>
</head>
<body onload="load()">
<noscript>
A browser with JavaScript enabled is required for this page to operate properly.
</noscript>
<div id="TopBar"> <div id="TopBar_tr"> <div id="TopBar_tl"> <div id="TopBar_br"> <div id="TopBar_bl">
<div id="TopBar_right">
<a target="_blank"
href="http://www.oracle.com/technetwork/java/javase/downloads/java-se-7-tutorial-2012-02-28-1536013.html">Download Ebooks</a><br />
<a target="_blank"
href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">Download JDK</a>
<br />
<a href="../../search.html" target="_blank">Search Java Tutorials</a>
<br />
<a href="javascript:toggleLeft()"
id="ToggleLeft">Hide TOC</a>
</div>
</div> </div> </div> </div> </div>
<div class="PrintHeaders">
<b>Trail:</b> Learning the Java Language
<br /><b>Lesson:</b> Generics (Updated)
</div>
<div id="LeftBar" class="LeftBar_shown">
<div id="Contents">
<div class="linkLESSON"><a href="index.html">Generics (Updated)</a></div>
<div class="linkAHEAD"><a href="why.html">Why Use Generics?</a></div>
<div class="nolinkAHEAD">Generic Types</div>
<div class="linkBHEAD"><a href="rawTypes.html">Raw Types</a></div>
<div class="linkAHEAD"><a href="methods.html">Generic Methods</a></div>
<div class="linkAHEAD"><a href="bounded.html">Bounded Type Parameters</a></div>
<div class="linkBHEAD"><a href="boundedTypeParams.html">Generic Methods and Bounded Type Parameters</a></div>
<div class="linkAHEAD"><a href="inheritance.html">Generics, Inheritance, and Subtypes</a></div>
<div class="linkAHEAD"><a href="genTypeInference.html">Type Inference</a></div>
<div class="linkAHEAD"><a href="wildcards.html">Wildcards</a></div>
<div class="linkBHEAD"><a href="upperBounded.html">Upper Bounded Wildcards</a></div>
<div class="linkBHEAD"><a href="unboundedWildcards.html">Unbounded Wildcards</a></div>
<div class="linkBHEAD"><a href="lowerBounded.html">Lower Bounded Wildcards</a></div>
<div class="linkBHEAD"><a href="subtyping.html">Wildcards and Subtyping</a></div>
<div class="linkBHEAD"><a href="capture.html">Wildcard Capture and Helper Methods</a></div>
<div class="linkBHEAD"><a href="wildcardGuidelines.html">Guidelines for Wildcard Use</a></div>
<div class="linkAHEAD"><a href="erasure.html">Type Erasure</a></div>
<div class="linkBHEAD"><a href="genTypes.html">Erasure of Generic Types</a></div>
<div class="linkBHEAD"><a href="genMethods.html">Erasure of Generic Methods</a></div>
<div class="linkBHEAD"><a href="bridgeMethods.html">Effects of Type Erasure and Bridge Methods</a></div>
<div class="linkBHEAD"><a href="nonReifiableVarargsType.html">Non-Reifiable Types</a></div>
<div class="linkAHEAD"><a href="restrictions.html">Restrictions on Generics</a></div>
<div class="linkQUESTIONS"><a href="QandE/generics-questions.html">Questions and Exercises</a></div>
</div>
</div>
<div id="MainFlow" class="MainFlow_indented">
<span id="BreadCrumbs">
<a href="../../index.html" target="_top">Home Page</a>
>
<a href="../index.html" target="_top">Learning the Java Language</a>
>
<a href="index.html" target="_top">Generics (Updated)</a>
</span>
<div class="NavBit">
<a target="_top" href="why.html">« Previous</a> • <a target="_top" href="../TOC.html">Trail</a> • <a target="_top" href="rawTypes.html">Next »</a>
</div>
<div id="PageTitle"><h1>Generic Types</h1></div>
<div id="PageContent">
<p>
A <em>generic type</em> is a generic class or interface that is parameterized over types. The following <tt>Box</tt> class will be modified to demonstrate the concept.</p>
<h2>A Simple Box Class</h2>
<p>
Begin by examining a non-generic <tt>Box</tt> class that operates on objects of any type. It needs only to provide two methods: <tt>set</tt>, which adds an object to the box, and <tt>get</tt>, which retrieves it:</p>
<div class="codeblock"><pre>
public class Box {
private Object object;
public void set(Object object) { this.object = object; }
public Object get() { return object; }
}
</pre></div>
<p>
Since its methods accept or return an <tt>Object</tt>, you are free to pass in whatever you want, provided that it is not one of the primitive types. There is no way to verify, at compile time, how the class is used. One part of the code may place an <tt>Integer</tt> in the box and expect to get <tt>Integer</tt>s out of it, while another part of the code may mistakenly pass in a <tt>String</tt>, resulting in a runtime error.</p>
<h2>A Generic Version of the Box Class</h2>
<p>
A <em>generic class</em> is defined with the following format:</p>
<div class="codeblock"><pre>
class name<T1, T2, ..., Tn> { /* ... */ }
</pre></div>
<p>
The type parameter section, delimited by angle brackets (<tt><></tt>), follows the class name. It specifies the <em>type parameters</em> (also called <em>type variables</em>) <tt>T1</tt>, <tt>T2</tt>, ..., and <tt>Tn</tt>.</p>
<p>
To update the <tt>Box</tt> class to use generics, you create a <em>generic type declaration</em> by changing the code "<tt>public class Box</tt>" to "<tt>public class Box<T></tt>". This introduces the type variable, <tt>T</tt>, that can be used anywhere inside the class.</p>
<p>
With this change, the <tt>Box</tt> class becomes:</p>
<div class="codeblock"><pre>
/**
* Generic version of the Box class.
* @param <T> the type of the value being boxed
*/
public class Box<T> {
// T stands for "Type"
private T t;
public void set(T t) { this.t = t; }
public T get() { return t; }
}
</pre></div>
<p>
As you can see, all occurrences of <tt>Object</tt> are replaced by <tt>T</tt>. A type variable can be any <strong>non-primitive</strong> type you specify: any class type, any interface type, any array type, or even another type variable.</p>
<p>
This same technique can be applied to create generic interfaces.</p>
<h2>Type Parameter Naming Conventions</h2>
<p>By convention, type parameter names are single, uppercase letters. This stands in sharp contrast to the variable
<a class="TutorialLink" target="_top" href="../nutsandbolts/variables.html#naming">naming</a> conventions that you already know about, and with good reason: Without this convention, it would be difficult to tell the difference between a type variable and an ordinary class or interface name.</p>
<p>The most commonly used type parameter names are:</p>
<ul>
<li>E - Element (used extensively by the Java Collections Framework)</li>
<li>K - Key</li>
<li>N - Number</li>
<li>T - Type</li>
<li>V - Value</li>
<li>S,U,V etc. - 2nd, 3rd, 4th types</li>
</ul>
<p>You'll see these names used throughout the Java SE API and the rest of this lesson.</p>
<h2><a name="instantiation">Invoking and Instantiating a Generic Type</a></h2>
<p>
To reference the generic <tt>Box</tt> class from within your code, you must perform a <em>generic type invocation</em>, which replaces <tt>T</tt> with some concrete value, such as <tt>Integer</tt>:</p>
<div class="codeblock"><pre>
Box<Integer> integerBox;
</pre></div>
<p>
You can think of a generic type invocation as being similar to an ordinary method invocation, but instead of passing an argument to a method, you are passing a <em>type argument</em> — <tt>Integer</tt> in this case — to the <tt>Box</tt> class itself.</p>
<div class="note"><hr /><strong>Type Parameter and Type Argument Terminology:</strong> Many developers use the terms "type parameter" and "type argument" interchangeably, but these terms are not the same. When coding, one provides type arguments in order to create a parameterized type. Therefore, the <tt>T</tt> in <tt>Foo<T></tt> is a type parameter and the <tt>String</tt> in <tt>Foo<String> f</tt> is a type argument. This lesson observes this definition when using these terms.
<hr /></div>
<p>
Like any other variable declaration, this code does not actually create a new <tt>Box</tt> object. It simply declares that <tt>integerBox</tt> will hold a reference to a "<tt>Box</tt> of <tt>Integer</tt>", which is how <tt>Box<Integer></tt> is read.</p>
<p>
An invocation of a generic type is generally known as a <em>parameterized type</em>.</p>
<p>
To instantiate this class, use the <tt>new</tt> keyword, as usual, but place <tt><Integer></tt> between the class name and the parenthesis:</p>
<div class="codeblock"><pre>
Box<Integer> integerBox = new Box<Integer>();
</pre></div>
<h2><a name="diamond" id="diamond">The Diamond</a></h2>
<p>
In Java SE 7 and later, you can replace the type arguments required to invoke the constructor of a generic class with an empty set of type arguments (<>) as long as the compiler can determine, or infer, the type arguments from the context. This pair of angle brackets, <>, is informally called <em>the diamond</em>. For example, you can create an instance of <tt>Box<Integer></tt> with the following statement:</p>
<div class="codeblock"><pre>
Box<Integer> integerBox = new Box<>();
</pre></div>
<p>
For more information on diamond notation and type inference, see
<a class="TutorialLink" target="_top" href="genTypeInference.html">Type Inference</a>.</p>
<h2><a name="multiple" id="multiple">Multiple Type Parameters</a></h2>
<p>
As mentioned previously, a generic class can have multiple type parameters. For example, the generic <tt>OrderedPair</tt> class, which implements the generic <tt>Pair</tt> interface:</p>
<div class="codeblock"><pre>
public interface Pair<K, V> {
public K getKey();
public V getValue();
}
public class OrderedPair<K, V> implements Pair<K, V> {
private K key;
private V value;
public OrderedPair(K key, V value) {
this.key = key;
this.value = value;
}
public K getKey() { return key; }
public V getValue() { return value; }
}
</pre></div>
<p>
The following statements create two instantiations of the <tt>OrderedPair</tt> class:</p>
<div class="codeblock"><pre>
Pair<String, Integer> p1 = new OrderedPair<String, Integer>("Even", 8);
Pair<String, String> p2 = new OrderedPair<String, String>("hello", "world");
</pre></div>
<p>
The code, <tt>new OrderedPair<String, Integer></tt>, instantiates <tt>K</tt> as a <tt>String</tt> and <tt>V</tt> as an <tt>Integer</tt>. Therefore, the parameter types of <tt>OrderedPair</tt>'s constructor are <tt>String</tt> and <tt>Integer</tt>, respectively. Due to
<a class="TutorialLink" target="_top" href="../data/autoboxing.html">autoboxing</a>, it is valid to pass a <tt>String</tt> and an <tt>int</tt> to the class.</p>
<p>
As mentioned in <a href="#diamond">The Diamond</a>, because a Java compiler can infer the <tt>K</tt> and <tt>V</tt> types from the declaration <tt>OrderedPair<String, Integer></tt>, these statements can be shortened using diamond notation:</p>
<div class="codeblock"><pre>
OrderedPair<String, Integer> p1 = new OrderedPair<strong><></strong>("Even", 8);
OrderedPair<String, String> p2 = new OrderedPair<strong><></strong>("hello", "world");
</pre></div>
<p>
To create a generic interface, follow the same conventions as for creating a generic class.</p>
<h2>Parameterized Types</h2>
<p>
You can also substitute a type parameter (i.e., <tt>K</tt> or <tt>V</tt>) with a parameterized type (i.e., <tt>List<String></tt>). For example, using the <tt>OrderedPair<K, V></tt> example:</p>
<div class="codeblock"><pre>
OrderedPair<String, <strong>Box<Integer></strong>> p = new OrderedPair<>("primes", new Box<Integer>(...));
</pre></div>
</div>
<div class="NavBit">
<a target="_top" href="why.html">« Previous</a>
•
<a target="_top" href="../TOC.html">Trail</a>
•
<a target="_top" href="rawTypes.html">Next »</a>
</div>
</div>
<div id="Footer2">
<hr />
<div id="TagNotes">
<p class="footertext">Problems with the examples? Try <a target="_blank"
href="../../information/run-examples.html">Compiling and Running
the Examples: FAQs</a>.
<br />
Complaints? Compliments? Suggestions? <a target="_blank"
href="http://docs.oracle.com/javase/feedback.html">Give
us your feedback</a>.
</p>
</div>
<div id="Footer">
<p class="footertext"><a name="license_info">Your use of this</a> page and all the material on pages under "The Java Tutorials" banner
is subject to these <a href="../../information/cpyr.html">legal notices</a>.
</p>
<table border="0" cellspacing="0" cellpadding="5" summary="">
<tr>
<td width="20%">
<table width="100%" border="0" cellspacing="0" cellpadding="5">
<tr>
<td headers="h1" align="center"><img id="duke" src="../../images/DukeWave.gif" width="55" height="55" alt="duke image" /></td>
<td headers="h2" align="left" valign="middle"><img id="oracle" src="../../images/logo_oracle_footer.gif" width="100" height="29" alt="Oracle logo" /></td>
</tr>
</table>
</td>
<td width="55%" valign="middle" align="center">
<p class="footertext"><a href="http://www.oracle.com/us/corporate/index.html">About Oracle</a> | <a href="http://www.oracle.com/technology/index.html">Oracle Technology Network</a> | <a href="http://www.oracle.com/us/legal/terms/index.html">Terms of Use</a></p>
</td>
<td width="25%" valign="middle" align="right">
<p class="footertext">Copyright © 1995, 2014 Oracle and/or its affiliates. All rights reserved.</p>
</td>
</tr>
</table>
</div>
</div>
<div class="PrintHeaders">
<b>Previous page:</b> Why Use Generics?
<br /><b>Next page:</b> Raw Types
</div>
</body>
</html>