-
Notifications
You must be signed in to change notification settings - Fork 1
/
UriTemplate.html
1295 lines (1295 loc) · 56.3 KB
/
UriTemplate.html
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
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.2) on Sat Oct 21 15:44:48 UTC 2023 -->
<title>UriTemplate (Tyrus 2.0.5 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-10-21">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="UriTemplate (Tyrus 2.0.5 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":9,"i3":9,"i4":10,"i5":9,"i6":9,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":9,"i21":9,"i22":9,"i23":9,"i24":9,"i25":9,"i26":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/UriTemplate.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses.html">All Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding"> </div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.glassfish.tyrus.core.uri.internal</a></div>
<h2 title="Class UriTemplate" class="title">Class UriTemplate</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.glassfish.tyrus.core.uri.internal.UriTemplate</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="PathTemplate.html" title="class in org.glassfish.tyrus.core.uri.internal">PathTemplate</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">UriTemplate</span>
extends java.lang.Object</pre>
<div class="block">A URI template.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Paul Sandoz, Martin Matula, Gerard Davison (gerard.davison at oracle.com)</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.Comparator<<a href="UriTemplate.html" title="class in org.glassfish.tyrus.core.uri.internal">UriTemplate</a>></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#COMPARATOR">COMPARATOR</a></span></code></th>
<td class="colLast">
<div class="block">Order the templates according to JAX-RS specification.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="UriTemplate.html" title="class in org.glassfish.tyrus.core.uri.internal">UriTemplate</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#EMPTY">EMPTY</a></span></code></th>
<td class="colLast">
<div class="block">The empty URI template that matches the <code>null</code> or empty URI path.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code> </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String)">UriTemplate</a></span>​(java.lang.String template)</code></th>
<td class="colLast">
<div class="block">Construct a new URI template.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.glassfish.tyrus.core.uri.internal.UriTemplateParser)">UriTemplate</a></span>​(<a href="UriTemplateParser.html" title="class in org.glassfish.tyrus.core.uri.internal">UriTemplateParser</a> templateParser)</code></th>
<td class="colLast">
<div class="block">Construct a new URI template.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createURI(java.lang.String...)">createURI</a></span>​(java.lang.String... values)</code></th>
<td class="colLast">
<div class="block">Create a URI by substituting any template variables
for corresponding template values.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createURI(java.lang.String%5B%5D,int,int)">createURI</a></span>​(java.lang.String[] values,
int offset,
int length)</code></th>
<td class="colLast">
<div class="block">Create a URI by substituting any template variables
for corresponding template values.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createURI(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.Object%5B%5D,boolean,boolean)">createURI</a></span>​(java.lang.String scheme,
java.lang.String authority,
java.lang.String userInfo,
java.lang.String host,
java.lang.String port,
java.lang.String path,
java.lang.String query,
java.lang.String fragment,
java.lang.Object[] values,
boolean encode,
boolean encodeSlashInPath)</code></th>
<td class="colLast">
<div class="block">Construct a URI from the component parts each of which may contain
template variables.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createURI(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.util.Map,boolean,boolean)">createURI</a></span>​(java.lang.String scheme,
java.lang.String authority,
java.lang.String userInfo,
java.lang.String host,
java.lang.String port,
java.lang.String path,
java.lang.String query,
java.lang.String fragment,
java.util.Map<java.lang.String,​?> values,
boolean encode,
boolean encodeSlashInPath)</code></th>
<td class="colLast">
<div class="block">Construct a URI from the component parts each of which may contain
template variables.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createURI(java.util.Map)">createURI</a></span>​(java.util.Map<java.lang.String,​java.lang.String> values)</code></th>
<td class="colLast">
<div class="block">Create a URI by substituting any template variables
for corresponding template values.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createURIWithStringValues(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String%5B%5D,boolean,boolean)">createURIWithStringValues</a></span>​(java.lang.String scheme,
java.lang.String authority,
java.lang.String userInfo,
java.lang.String host,
java.lang.String port,
java.lang.String path,
java.lang.String query,
java.lang.String fragment,
java.lang.String[] values,
boolean encode,
boolean encodeSlashInPath)</code></th>
<td class="colLast">
<div class="block">Construct a URI from the component parts each of which may contain
template variables.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createURIWithStringValues(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.util.Map,boolean,boolean)">createURIWithStringValues</a></span>​(java.lang.String scheme,
java.lang.String authority,
java.lang.String userInfo,
java.lang.String host,
java.lang.String port,
java.lang.String path,
java.lang.String query,
java.lang.String fragment,
java.util.Map<java.lang.String,​?> values,
boolean encode,
boolean encodeSlashInPath)</code></th>
<td class="colLast">
<div class="block">Construct a URI from the component parts each of which may contain
template variables.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#endsWithSlash()">endsWithSlash</a></span>()</code></th>
<td class="colLast">
<div class="block">Check if the URI template ends in a slash (<code>'/'</code>).</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>​(java.lang.Object o)</code></th>
<td class="colLast">
<div class="block">Equality is calculated from the String of the regular expression
generated from the templates.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNumberOfExplicitCharacters()">getNumberOfExplicitCharacters</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the number of characters in the regular expression not resulting
from conversion of template variables.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNumberOfExplicitRegexes()">getNumberOfExplicitRegexes</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the number of explicit regular expressions declared in the template variables.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNumberOfRegexGroups()">getNumberOfRegexGroups</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the number of regular expression groups</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNumberOfTemplateVariables()">getNumberOfTemplateVariables</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the number of template variables.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="PatternWithGroups.html" title="class in org.glassfish.tyrus.core.uri.internal">PatternWithGroups</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPattern()">getPattern</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the URI pattern.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTemplate()">getTemplate</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the URI template as a String.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>java.util.List<java.lang.String></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTemplateVariables()">getTemplateVariables</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the list of template variables for the template.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th>
<td class="colLast">
<div class="block">Hash code is calculated from String of the regular expression
generated from the template.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isTemplateVariablePresent(java.lang.String)">isTemplateVariablePresent</a></span>​(java.lang.String name)</code></th>
<td class="colLast">
<div class="block">Ascertain if a template variable is a member of this
template.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#match(java.lang.CharSequence,java.util.List)">match</a></span>​(java.lang.CharSequence uri,
java.util.List<java.lang.String> groupValues)</code></th>
<td class="colLast">
<div class="block">Match a URI against the template.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#match(java.lang.CharSequence,java.util.Map)">match</a></span>​(java.lang.CharSequence uri,
java.util.Map<java.lang.String,​java.lang.String> templateVariableToValue)</code></th>
<td class="colLast">
<div class="block">Match a URI against the template.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>static java.net.URI</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#normalize(java.lang.String)">normalize</a></span>​(java.lang.String uri)</code></th>
<td class="colLast">
<div class="block">Normalize the URI by resolve the dot & dot-dot path segments as described in
<a href="http://tools.ietf.org/html/rfc3986#section-5.2.4">RFC 3986</a>.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>static java.net.URI</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#normalize(java.net.URI)">normalize</a></span>​(java.net.URI uri)</code></th>
<td class="colLast">
<div class="block">Normalize the URI by resolve the dot & dot-dot path segments as described in
<a href="http://tools.ietf.org/html/rfc3986#section-5.2.4">RFC 3986</a>.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>static java.net.URI</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#relativize(java.net.URI,java.net.URI)">relativize</a></span>​(java.net.URI baseUri,
java.net.URI refUri)</code></th>
<td class="colLast">
<div class="block">Relativize URI with respect to a base URI.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>static java.net.URI</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resolve(java.net.URI,java.lang.String)">resolve</a></span>​(java.net.URI baseUri,
java.lang.String refUri)</code></th>
<td class="colLast">
<div class="block">Resolve a relative URI reference against a base URI as defined in
<a href="http://tools.ietf.org/html/rfc3986#section-5.4">RFC 3986</a>.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>static java.net.URI</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resolve(java.net.URI,java.net.URI)">resolve</a></span>​(java.net.URI baseUri,
java.net.URI refUri)</code></th>
<td class="colLast">
<div class="block">Resolve a relative URI reference against a base URI as defined in
<a href="http://tools.ietf.org/html/rfc3986#section-5.4">RFC 3986</a>.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resolveTemplateValues(org.glassfish.tyrus.core.uri.internal.UriComponent.Type,java.lang.String,boolean,java.util.Map)">resolveTemplateValues</a></span>​(<a href="UriComponent.Type.html" title="enum in org.glassfish.tyrus.core.uri.internal">UriComponent.Type</a> type,
java.lang.String template,
boolean encode,
java.util.Map<java.lang.String,​?> _mapValues)</code></th>
<td class="colLast">
<div class="block">Resolves template variables in the given <code>template</code> from <code>_mapValues</code>.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast"> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="COMPARATOR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>COMPARATOR</h4>
<pre>public static final java.util.Comparator<<a href="UriTemplate.html" title="class in org.glassfish.tyrus.core.uri.internal">UriTemplate</a>> COMPARATOR</pre>
<div class="block">Order the templates according to JAX-RS specification.
<p>
Sort the set of matching resource classes using the number of
characters in the regular expression not resulting from template
variables as the primary key, the number of matching groups
as a secondary key, and the number of explicit regular expression
declarations as the tertiary key.</div>
</li>
</ul>
<a id="EMPTY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>EMPTY</h4>
<pre>public static final <a href="UriTemplate.html" title="class in org.glassfish.tyrus.core.uri.internal">UriTemplate</a> EMPTY</pre>
<div class="block">The empty URI template that matches the <code>null</code> or empty URI path.</div>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="<init>(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UriTemplate</h4>
<pre>public UriTemplate​(java.lang.String template)
throws java.util.regex.PatternSyntaxException,
java.lang.IllegalArgumentException</pre>
<div class="block">Construct a new URI template.
<p>
The template will be parsed to extract template variables.
<p>
A specific regular expression will be generated from the template
to match URIs according to the template and map template variables to
template values.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>template</code> - the template.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.util.regex.PatternSyntaxException</code> - if the specified
regular expression could not be generated</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if the template is <code>null</code> or
an empty string.</dd>
</dl>
</li>
</ul>
<a id="<init>(org.glassfish.tyrus.core.uri.internal.UriTemplateParser)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>UriTemplate</h4>
<pre>protected UriTemplate​(<a href="UriTemplateParser.html" title="class in org.glassfish.tyrus.core.uri.internal">UriTemplateParser</a> templateParser)
throws java.util.regex.PatternSyntaxException,
java.lang.IllegalArgumentException</pre>
<div class="block">Construct a new URI template.
<p>
The template will be parsed to extract template variables.
<p>
A specific regular expression will be generated from the template
to match URIs according to the template and map template variables to
template values.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>templateParser</code> - the parser to parse the template.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.util.regex.PatternSyntaxException</code> - if the specified
regular expression could not be generated</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if the template is <code>null</code> or
an empty string.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="resolve(java.net.URI,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolve</h4>
<pre class="methodSignature">public static java.net.URI resolve​(java.net.URI baseUri,
java.lang.String refUri)</pre>
<div class="block">Resolve a relative URI reference against a base URI as defined in
<a href="http://tools.ietf.org/html/rfc3986#section-5.4">RFC 3986</a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>baseUri</code> - base URI to be used for resolution.</dd>
<dd><code>refUri</code> - reference URI string to be resolved against the base URI.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>resolved URI.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - If the given string violates the URI specification RFC.</dd>
</dl>
</li>
</ul>
<a id="resolve(java.net.URI,java.net.URI)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolve</h4>
<pre class="methodSignature">public static java.net.URI resolve​(java.net.URI baseUri,
java.net.URI refUri)</pre>
<div class="block">Resolve a relative URI reference against a base URI as defined in
<a href="http://tools.ietf.org/html/rfc3986#section-5.4">RFC 3986</a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>baseUri</code> - base URI to be used for resolution.</dd>
<dd><code>refUri</code> - reference URI to be resolved against the base URI.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>resolved URI.</dd>
</dl>
</li>
</ul>
<a id="normalize(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>normalize</h4>
<pre class="methodSignature">public static java.net.URI normalize​(java.lang.String uri)</pre>
<div class="block">Normalize the URI by resolve the dot & dot-dot path segments as described in
<a href="http://tools.ietf.org/html/rfc3986#section-5.2.4">RFC 3986</a>.
<p>
This method provides a workaround for issues with <code>URI.normalize()</code> which
is not able to properly normalize absolute paths that start with a <code>".."</code> segment,
e.g. <code>"/../a/b"</code> as required by RFC 3986 (according to RFC 3986 the path <code>"/../a/b"</code>
should resolve to <code>"/a/b"</code>, while <code>URI.normalize()</code> keeps the <code>".."</code> segment
in the URI path.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uri</code> - the original URI string.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the URI with dot and dot-dot segments resolved.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - If the given string violates the URI specification RFC.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>URI.normalize()</code></dd>
</dl>
</li>
</ul>
<a id="normalize(java.net.URI)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>normalize</h4>
<pre class="methodSignature">public static java.net.URI normalize​(java.net.URI uri)</pre>
<div class="block">Normalize the URI by resolve the dot & dot-dot path segments as described in
<a href="http://tools.ietf.org/html/rfc3986#section-5.2.4">RFC 3986</a>.
<p>
This method provides a workaround for issues with <code>URI.normalize()</code> which
is not able to properly normalize absolute paths that start with a <code>".."</code> segment,
e.g. <code>"/../a/b"</code> as required by RFC 3986 (according to RFC 3986 the path <code>"/../a/b"</code>
should resolve to <code>"/a/b"</code>, while <code>URI.normalize()</code> keeps the <code>".."</code> segment
in the URI path.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uri</code> - the original URI.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the URI with dot and dot-dot segments resolved.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>URI.normalize()</code></dd>
</dl>
</li>
</ul>
<a id="relativize(java.net.URI,java.net.URI)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>relativize</h4>
<pre class="methodSignature">public static java.net.URI relativize​(java.net.URI baseUri,
java.net.URI refUri)</pre>
<div class="block">Relativize URI with respect to a base URI.
<p>
After the relativization is done, dots in paths of both URIs are <a href="#normalize(java.net.URI)"><code>resolved</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>baseUri</code> - base URI to be used for relativization.</dd>
<dd><code>refUri</code> - URI to be relativized.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>relativized URI.</dd>
</dl>
</li>
</ul>
<a id="getTemplate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTemplate</h4>
<pre class="methodSignature">public final java.lang.String getTemplate()</pre>
<div class="block">Get the URI template as a String.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the URI template.</dd>
</dl>
</li>
</ul>
<a id="getPattern()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPattern</h4>
<pre class="methodSignature">public final <a href="PatternWithGroups.html" title="class in org.glassfish.tyrus.core.uri.internal">PatternWithGroups</a> getPattern()</pre>
<div class="block">Get the URI pattern.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the URI pattern.</dd>
</dl>
</li>
</ul>
<a id="endsWithSlash()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>endsWithSlash</h4>
<pre class="methodSignature">public final boolean endsWithSlash()</pre>
<div class="block">Check if the URI template ends in a slash (<code>'/'</code>).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the template ends in a '/', otherwise false.</dd>
</dl>
</li>
</ul>
<a id="getTemplateVariables()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTemplateVariables</h4>
<pre class="methodSignature">public final java.util.List<java.lang.String> getTemplateVariables()</pre>
<div class="block">Get the list of template variables for the template.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the list of template variables.</dd>
</dl>
</li>
</ul>
<a id="isTemplateVariablePresent(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isTemplateVariablePresent</h4>
<pre class="methodSignature">public final boolean isTemplateVariablePresent​(java.lang.String name)</pre>
<div class="block">Ascertain if a template variable is a member of this
template.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - name The template variable.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the template variable is a member of the template, otherwise <code>false</code>.</dd>
</dl>
</li>
</ul>
<a id="getNumberOfExplicitRegexes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumberOfExplicitRegexes</h4>
<pre class="methodSignature">public final int getNumberOfExplicitRegexes()</pre>
<div class="block">Get the number of explicit regular expressions declared in the template variables.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of explicit regular expressions in the template variables.</dd>
</dl>
</li>
</ul>
<a id="getNumberOfRegexGroups()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumberOfRegexGroups</h4>
<pre class="methodSignature">public final int getNumberOfRegexGroups()</pre>
<div class="block">Get the number of regular expression groups</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of regular expressions groups</dd>
</dl>
</li>
</ul>
<a id="getNumberOfExplicitCharacters()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumberOfExplicitCharacters</h4>
<pre class="methodSignature">public final int getNumberOfExplicitCharacters()</pre>
<div class="block">Get the number of characters in the regular expression not resulting
from conversion of template variables.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of explicit characters</dd>
</dl>
</li>
</ul>
<a id="getNumberOfTemplateVariables()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumberOfTemplateVariables</h4>
<pre class="methodSignature">public final int getNumberOfTemplateVariables()</pre>
<div class="block">Get the number of template variables.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of template variables.</dd>
</dl>
</li>
</ul>
<a id="match(java.lang.CharSequence,java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>match</h4>
<pre class="methodSignature">public final boolean match​(java.lang.CharSequence uri,
java.util.Map<java.lang.String,​java.lang.String> templateVariableToValue)
throws java.lang.IllegalArgumentException</pre>
<div class="block">Match a URI against the template.
<p>
If the URI matches against the pattern then the template variable to value
map will be filled with template variables as keys and template values as
values.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uri</code> - the uri to match against the template.</dd>
<dd><code>templateVariableToValue</code> - the map where to put template variables (as keys)
and template values (as values). The map is cleared before any
entries are put.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the URI matches the template, otherwise false.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the uri or
templateVariableToValue is null.</dd>
</dl>
</li>
</ul>
<a id="match(java.lang.CharSequence,java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>match</h4>
<pre class="methodSignature">public final boolean match​(java.lang.CharSequence uri,
java.util.List<java.lang.String> groupValues)
throws java.lang.IllegalArgumentException</pre>
<div class="block">Match a URI against the template.
<p>
If the URI matches against the pattern the capturing group values (if any)
will be added to a list passed in as parameter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uri</code> - the uri to match against the template.</dd>
<dd><code>groupValues</code> - the list to store the values of a pattern's
capturing groups is matching is successful. The values are stored
in the same order as the pattern's capturing groups.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the URI matches the template, otherwise false.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the uri or
templateVariableToValue is null.</dd>
</dl>
</li>
</ul>
<a id="createURI(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createURI</h4>
<pre class="methodSignature">public final java.lang.String createURI​(java.util.Map<java.lang.String,​java.lang.String> values)</pre>
<div class="block">Create a URI by substituting any template variables
for corresponding template values.
<p>
A URI template variable without a value will be substituted by the
empty string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>values</code> - the map of template variables to template values.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the URI.</dd>
</dl>
</li>
</ul>
<a id="createURI(java.lang.String...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createURI</h4>
<pre class="methodSignature">public final java.lang.String createURI​(java.lang.String... values)</pre>
<div class="block">Create a URI by substituting any template variables
for corresponding template values.
<p>
A URI template variable without a value will be substituted by the
empty string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>values</code> - the array of template values. The values will be
substituted in order of occurrence of unique template variables.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the URI.</dd>
</dl>
</li>
</ul>
<a id="createURI(java.lang.String[],int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createURI</h4>
<pre class="methodSignature">public final java.lang.String createURI​(java.lang.String[] values,
int offset,
int length)</pre>
<div class="block">Create a URI by substituting any template variables
for corresponding template values.
<p>
A URI template variable without a value will be substituted by the
empty string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>values</code> - the array of template values. The values will be
substituted in order of occurrence of unique template variables.</dd>
<dd><code>offset</code> - the offset into the template value array.</dd>
<dd><code>length</code> - the length of the template value array.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the URI.</dd>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public final java.lang.String toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a id="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre class="methodSignature">public final int hashCode()</pre>
<div class="block">Hash code is calculated from String of the regular expression
generated from the template.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the hash code.</dd>
</dl>
</li>
</ul>
<a id="equals(java.lang.Object)">