-
Notifications
You must be signed in to change notification settings - Fork 1
/
UriComponent.html
844 lines (844 loc) · 38.8 KB
/
UriComponent.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
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.2) on Sat Oct 21 15:44:48 UTC 2023 -->
<title>UriComponent (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="UriComponent (Tyrus 2.0.5 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9,"i16":9,"i17":9,"i18":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/UriComponent.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><a href="#nested.class.summary">Nested</a> | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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 UriComponent" class="title">Class UriComponent</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.glassfish.tyrus.core.uri.internal.UriComponent</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">UriComponent</span>
extends java.lang.Object</pre>
<div class="block">Utility class for validating, encoding and decoding components
of a URI.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Paul Sandoz, Marek Potociar</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class </code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="UriComponent.Type.html" title="enum in org.glassfish.tyrus.core.uri.internal">UriComponent.Type</a></span></code></th>
<td class="colLast">
<div class="block">The URI component type.</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="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>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contextualEncode(java.lang.String,org.glassfish.tyrus.core.uri.internal.UriComponent.Type)">contextualEncode</a></span>​(java.lang.String s,
<a href="UriComponent.Type.html" title="enum in org.glassfish.tyrus.core.uri.internal">UriComponent.Type</a> t)</code></th>
<td class="colLast">
<div class="block">Contextually encodes the characters of string that are either non-ASCII characters or are ASCII characters that
must be percent-encoded using the UTF-8 encoding.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contextualEncode(java.lang.String,org.glassfish.tyrus.core.uri.internal.UriComponent.Type,boolean)">contextualEncode</a></span>​(java.lang.String s,
<a href="UriComponent.Type.html" title="enum in org.glassfish.tyrus.core.uri.internal">UriComponent.Type</a> t,
boolean template)</code></th>
<td class="colLast">
<div class="block">Contextually encodes the characters of string that are either non-ASCII characters or are ASCII characters that
must be percent-encoded using the UTF-8 encoding.</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="#decode(java.lang.String,org.glassfish.tyrus.core.uri.internal.UriComponent.Type)">decode</a></span>​(java.lang.String s,
<a href="UriComponent.Type.html" title="enum in org.glassfish.tyrus.core.uri.internal">UriComponent.Type</a> t)</code></th>
<td class="colLast">
<div class="block">Decodes characters of a string that are percent-encoded octets using
UTF-8 decoding (if needed).</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="MultivaluedMap.html" title="interface in org.glassfish.tyrus.core.uri.internal">MultivaluedMap</a><java.lang.String,​java.lang.String></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decodeMatrix(java.lang.String,boolean)">decodeMatrix</a></span>​(java.lang.String pathSegment,
boolean decode)</code></th>
<td class="colLast">
<div class="block">Decode the matrix component of a URI path segment.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static java.util.List<<a href="PathSegment.html" title="interface in org.glassfish.tyrus.core.uri.internal">PathSegment</a>></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decodePath(java.lang.String,boolean)">decodePath</a></span>​(java.lang.String path,
boolean decode)</code></th>
<td class="colLast">
<div class="block">Decode the path component of a URI as path segments.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static java.util.List<<a href="PathSegment.html" title="interface in org.glassfish.tyrus.core.uri.internal">PathSegment</a>></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decodePath(java.net.URI,boolean)">decodePath</a></span>​(java.net.URI u,
boolean decode)</code></th>
<td class="colLast">
<div class="block">Decode the path component of a URI as path segments.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decodePathSegment(java.util.List,java.lang.String,boolean)">decodePathSegment</a></span>​(java.util.List<<a href="PathSegment.html" title="interface in org.glassfish.tyrus.core.uri.internal">PathSegment</a>> segments,
java.lang.String segment,
boolean decode)</code></th>
<td class="colLast">
<div class="block">Decode the path segment and add it to the list of path segments.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="MultivaluedMap.html" title="interface in org.glassfish.tyrus.core.uri.internal">MultivaluedMap</a><java.lang.String,​java.lang.String></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decodeQuery(java.lang.String,boolean)">decodeQuery</a></span>​(java.lang.String q,
boolean decode)</code></th>
<td class="colLast">
<div class="block">Decode the query component of a URI.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static <a href="MultivaluedMap.html" title="interface in org.glassfish.tyrus.core.uri.internal">MultivaluedMap</a><java.lang.String,​java.lang.String></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decodeQuery(java.lang.String,boolean,boolean)">decodeQuery</a></span>​(java.lang.String q,
boolean decodeNames,
boolean decodeValues)</code></th>
<td class="colLast">
<div class="block">Decode the query component of a URI.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static <a href="MultivaluedMap.html" title="interface in org.glassfish.tyrus.core.uri.internal">MultivaluedMap</a><java.lang.String,​java.lang.String></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decodeQuery(java.net.URI,boolean)">decodeQuery</a></span>​(java.net.URI u,
boolean decode)</code></th>
<td class="colLast">
<div class="block">Decode the query component of a URI.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#encode(java.lang.String,org.glassfish.tyrus.core.uri.internal.UriComponent.Type)">encode</a></span>​(java.lang.String s,
<a href="UriComponent.Type.html" title="enum in org.glassfish.tyrus.core.uri.internal">UriComponent.Type</a> t)</code></th>
<td class="colLast">
<div class="block">Encodes the characters of string that are either non-ASCII characters
or are ASCII characters that must be percent-encoded using the
UTF-8 encoding.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#encode(java.lang.String,org.glassfish.tyrus.core.uri.internal.UriComponent.Type,boolean)">encode</a></span>​(java.lang.String s,
<a href="UriComponent.Type.html" title="enum in org.glassfish.tyrus.core.uri.internal">UriComponent.Type</a> t,
boolean template)</code></th>
<td class="colLast">
<div class="block">Encodes the characters of string that are either non-ASCII characters
or are ASCII characters that must be percent-encoded using the
UTF-8 encoding.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#encodeTemplateNames(java.lang.String)">encodeTemplateNames</a></span>​(java.lang.String s)</code></th>
<td class="colLast">
<div class="block">Encodes a string with template parameters names present, specifically the
characters '{' and '}' will be percent-encoded.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fullRelativeUri(java.net.URI)">fullRelativeUri</a></span>​(java.net.URI uri)</code></th>
<td class="colLast">
<div class="block">Return the <code>Request-Uri</code> representation as defined by HTTP spec.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isHexCharacter(char)">isHexCharacter</a></span>​(char c)</code></th>
<td class="colLast">
<div class="block">Checks whether the character <code>c</code> is hexadecimal character.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#valid(java.lang.String,org.glassfish.tyrus.core.uri.internal.UriComponent.Type)">valid</a></span>​(java.lang.String s,
<a href="UriComponent.Type.html" title="enum in org.glassfish.tyrus.core.uri.internal">UriComponent.Type</a> t)</code></th>
<td class="colLast">
<div class="block">Validates the legal characters of a percent-encoded string that represents a URI component type.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#valid(java.lang.String,org.glassfish.tyrus.core.uri.internal.UriComponent.Type,boolean)">valid</a></span>​(java.lang.String s,
<a href="UriComponent.Type.html" title="enum in org.glassfish.tyrus.core.uri.internal">UriComponent.Type</a> t,
boolean template)</code></th>
<td class="colLast">
<div class="block">Validates the legal characters of a percent-encoded string that represents a URI component type.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validate(java.lang.String,org.glassfish.tyrus.core.uri.internal.UriComponent.Type)">validate</a></span>​(java.lang.String s,
<a href="UriComponent.Type.html" title="enum in org.glassfish.tyrus.core.uri.internal">UriComponent.Type</a> t)</code></th>
<td class="colLast">
<div class="block">Validates the legal characters of a percent-encoded string that represents a URI component type.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validate(java.lang.String,org.glassfish.tyrus.core.uri.internal.UriComponent.Type,boolean)">validate</a></span>​(java.lang.String s,
<a href="UriComponent.Type.html" title="enum in org.glassfish.tyrus.core.uri.internal">UriComponent.Type</a> t,
boolean template)</code></th>
<td class="colLast">
<div class="block">Validates the legal characters of a percent-encoded string that represents a URI component type.</div>
</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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="validate(java.lang.String,org.glassfish.tyrus.core.uri.internal.UriComponent.Type)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validate</h4>
<pre class="methodSignature">public static void validate​(java.lang.String s,
<a href="UriComponent.Type.html" title="enum in org.glassfish.tyrus.core.uri.internal">UriComponent.Type</a> t)</pre>
<div class="block">Validates the legal characters of a percent-encoded string that represents a URI component type.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>s</code> - the encoded string.</dd>
<dd><code>t</code> - the URI component type identifying the legal characters.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the encoded string contains illegal characters.</dd>
</dl>
</li>
</ul>
<a id="validate(java.lang.String,org.glassfish.tyrus.core.uri.internal.UriComponent.Type,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validate</h4>
<pre class="methodSignature">public static void validate​(java.lang.String s,
<a href="UriComponent.Type.html" title="enum in org.glassfish.tyrus.core.uri.internal">UriComponent.Type</a> t,
boolean template)</pre>
<div class="block">Validates the legal characters of a percent-encoded string that represents a URI component type.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>s</code> - the encoded string.</dd>
<dd><code>t</code> - the URI component type identifying the legal characters.</dd>
<dd><code>template</code> - true if the encoded string contains URI template variables</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the encoded string contains illegal characters.</dd>
</dl>
</li>
</ul>
<a id="valid(java.lang.String,org.glassfish.tyrus.core.uri.internal.UriComponent.Type)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valid</h4>
<pre class="methodSignature">public static boolean valid​(java.lang.String s,
<a href="UriComponent.Type.html" title="enum in org.glassfish.tyrus.core.uri.internal">UriComponent.Type</a> t)</pre>
<div class="block">Validates the legal characters of a percent-encoded string that represents a URI component type.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>s</code> - the encoded string.</dd>
<dd><code>t</code> - the URI component type identifying the legal characters.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the encoded string is valid, otherwise false.</dd>
</dl>
</li>
</ul>
<a id="valid(java.lang.String,org.glassfish.tyrus.core.uri.internal.UriComponent.Type,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valid</h4>
<pre class="methodSignature">public static boolean valid​(java.lang.String s,
<a href="UriComponent.Type.html" title="enum in org.glassfish.tyrus.core.uri.internal">UriComponent.Type</a> t,
boolean template)</pre>
<div class="block">Validates the legal characters of a percent-encoded string that represents a URI component type.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>s</code> - the encoded string.</dd>
<dd><code>t</code> - the URI component type identifying the legal characters.</dd>
<dd><code>template</code> - true if the encoded string contains URI template variables</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the encoded string is valid, otherwise false.</dd>
</dl>
</li>
</ul>
<a id="contextualEncode(java.lang.String,org.glassfish.tyrus.core.uri.internal.UriComponent.Type)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contextualEncode</h4>
<pre class="methodSignature">public static java.lang.String contextualEncode​(java.lang.String s,
<a href="UriComponent.Type.html" title="enum in org.glassfish.tyrus.core.uri.internal">UriComponent.Type</a> t)</pre>
<div class="block">Contextually encodes the characters of string that are either non-ASCII characters or are ASCII characters that
must be percent-encoded using the UTF-8 encoding. Percent-encoded characters will be recognized and not double
encoded.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>s</code> - the string to be encoded.</dd>
<dd><code>t</code> - the URI component type identifying the ASCII characters that must be percent-encoded.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the encoded string.</dd>
</dl>
</li>
</ul>
<a id="contextualEncode(java.lang.String,org.glassfish.tyrus.core.uri.internal.UriComponent.Type,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contextualEncode</h4>
<pre class="methodSignature">public static java.lang.String contextualEncode​(java.lang.String s,
<a href="UriComponent.Type.html" title="enum in org.glassfish.tyrus.core.uri.internal">UriComponent.Type</a> t,
boolean template)</pre>
<div class="block">Contextually encodes the characters of string that are either non-ASCII characters or are ASCII characters that
must be percent-encoded using the UTF-8 encoding. Percent-encoded characters will be recognized and not double
encoded.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>s</code> - the string to be encoded.</dd>
<dd><code>t</code> - the URI component type identifying the ASCII characters that must be percent-encoded.</dd>
<dd><code>template</code> - true if the encoded string contains URI template variables</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the encoded string.</dd>
</dl>
</li>
</ul>
<a id="encode(java.lang.String,org.glassfish.tyrus.core.uri.internal.UriComponent.Type)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre class="methodSignature">public static java.lang.String encode​(java.lang.String s,
<a href="UriComponent.Type.html" title="enum in org.glassfish.tyrus.core.uri.internal">UriComponent.Type</a> t)</pre>
<div class="block">Encodes the characters of string that are either non-ASCII characters
or are ASCII characters that must be percent-encoded using the
UTF-8 encoding.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>s</code> - the string to be encoded.</dd>
<dd><code>t</code> - the URI component type identifying the ASCII characters that
must be percent-encoded.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the encoded string.</dd>
</dl>
</li>
</ul>
<a id="encode(java.lang.String,org.glassfish.tyrus.core.uri.internal.UriComponent.Type,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre class="methodSignature">public static java.lang.String encode​(java.lang.String s,
<a href="UriComponent.Type.html" title="enum in org.glassfish.tyrus.core.uri.internal">UriComponent.Type</a> t,
boolean template)</pre>
<div class="block">Encodes the characters of string that are either non-ASCII characters
or are ASCII characters that must be percent-encoded using the
UTF-8 encoding.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>s</code> - the string to be encoded.</dd>
<dd><code>t</code> - the URI component type identifying the ASCII characters that
must be percent-encoded.</dd>
<dd><code>template</code> - true if the encoded string contains URI template variables</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the encoded string.</dd>
</dl>
</li>
</ul>
<a id="encodeTemplateNames(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeTemplateNames</h4>
<pre class="methodSignature">public static java.lang.String encodeTemplateNames​(java.lang.String s)</pre>
<div class="block">Encodes a string with template parameters names present, specifically the
characters '{' and '}' will be percent-encoded.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>s</code> - the string with zero or more template parameters names</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the string with encoded template parameters names.</dd>
</dl>
</li>
</ul>
<a id="decode(java.lang.String,org.glassfish.tyrus.core.uri.internal.UriComponent.Type)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decode</h4>
<pre class="methodSignature">public static java.lang.String decode​(java.lang.String s,
<a href="UriComponent.Type.html" title="enum in org.glassfish.tyrus.core.uri.internal">UriComponent.Type</a> t)</pre>
<div class="block">Decodes characters of a string that are percent-encoded octets using
UTF-8 decoding (if needed).
<p>
It is assumed that the string is valid according to an (unspecified) URI
component type. If a sequence of contiguous percent-encoded octets is
not a valid UTF-8 character then the octets are replaced with '�'.
<p>
If the URI component is of type HOST then any "%" found between "[]" is
left alone. It is an IPv6 literal with a scope_id.
<p>
If the URI component is of type QUERY_PARAM then any "+" is decoded as
as ' '.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>s</code> - the string to be decoded.</dd>
<dd><code>t</code> - the URI component type, may be null.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the decoded string.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if a malformed percent-encoded octet is
detected</dd>
</dl>
</li>
</ul>
<a id="decodeQuery(java.net.URI,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decodeQuery</h4>
<pre class="methodSignature">public static <a href="MultivaluedMap.html" title="interface in org.glassfish.tyrus.core.uri.internal">MultivaluedMap</a><java.lang.String,​java.lang.String> decodeQuery​(java.net.URI u,
boolean decode)</pre>
<div class="block">Decode the query component of a URI.
<p>
Query parameter names in the returned map are always decoded. Decoding of query parameter
values can be controlled using the <code>decode</code> parameter flag.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>u</code> - the URI.</dd>
<dd><code>decode</code> - <code>true</code> if the returned query parameter values of the query component
should be in decoded form.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the multivalued map of query parameters.</dd>
</dl>
</li>
</ul>
<a id="decodeQuery(java.lang.String,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decodeQuery</h4>
<pre class="methodSignature">public static <a href="MultivaluedMap.html" title="interface in org.glassfish.tyrus.core.uri.internal">MultivaluedMap</a><java.lang.String,​java.lang.String> decodeQuery​(java.lang.String q,
boolean decode)</pre>
<div class="block">Decode the query component of a URI.
<p>
Query parameter names in the returned map are always decoded. Decoding of query parameter
values can be controlled using the <code>decode</code> parameter flag.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>q</code> - the query component in encoded form.</dd>
<dd><code>decode</code> - <code>true</code> if the returned query parameter values of the query component
should be in decoded form.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the multivalued map of query parameters.</dd>
</dl>
</li>
</ul>
<a id="decodeQuery(java.lang.String,boolean,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decodeQuery</h4>
<pre class="methodSignature">public static <a href="MultivaluedMap.html" title="interface in org.glassfish.tyrus.core.uri.internal">MultivaluedMap</a><java.lang.String,​java.lang.String> decodeQuery​(java.lang.String q,
boolean decodeNames,
boolean decodeValues)</pre>
<div class="block">Decode the query component of a URI.
<p>
Decoding of query parameter names and values can be controlled using the <code>decodeNames</code>
and <code>decodeValues</code> parameter flags.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>q</code> - the query component in encoded form.</dd>
<dd><code>decodeNames</code> - <code>true</code> if the returned query parameter names of the query component
should be in decoded form.</dd>
<dd><code>decodeValues</code> - <code>true</code> if the returned query parameter values of the query component
should be in decoded form.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the multivalued map of query parameters.</dd>
</dl>
</li>
</ul>
<a id="decodePath(java.net.URI,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decodePath</h4>
<pre class="methodSignature">public static java.util.List<<a href="PathSegment.html" title="interface in org.glassfish.tyrus.core.uri.internal">PathSegment</a>> decodePath​(java.net.URI u,
boolean decode)</pre>
<div class="block">Decode the path component of a URI as path segments.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>u</code> - the URI. If the path component is an absolute path component
then the leading '/' is ignored and is not considered a delimiator
of a path segment.</dd>
<dd><code>decode</code> - true if the path segments of the path component
should be in decoded form.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the list of path segments.</dd>
</dl>
</li>
</ul>
<a id="decodePath(java.lang.String,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decodePath</h4>
<pre class="methodSignature">public static java.util.List<<a href="PathSegment.html" title="interface in org.glassfish.tyrus.core.uri.internal">PathSegment</a>> decodePath​(java.lang.String path,
boolean decode)</pre>
<div class="block">Decode the path component of a URI as path segments.
<p>
Any '/' character in the path is considered to be a deliminator
between two path segments. Thus if the path is '/' then the path segment
list will contain two empty path segments. If the path is "//" then
the path segment list will contain three empty path segments. If the path
is "/a/" the path segment list will consist of the following path
segments in order: "", "a" and "".</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>path</code> - the path component in encoded form.</dd>
<dd><code>decode</code> - true if the path segments of the path component
should be in decoded form.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the list of path segments.</dd>
</dl>
</li>
</ul>
<a id="decodePathSegment(java.util.List,java.lang.String,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decodePathSegment</h4>
<pre class="methodSignature">public static void decodePathSegment​(java.util.List<<a href="PathSegment.html" title="interface in org.glassfish.tyrus.core.uri.internal">PathSegment</a>> segments,
java.lang.String segment,
boolean decode)</pre>
<div class="block">Decode the path segment and add it to the list of path segments.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>segments</code> - mutable list of path segments.</dd>
<dd><code>segment</code> - path segment to be decoded.</dd>
<dd><code>decode</code> - <code>true</code> if the path segment should be in a decoded form.</dd>
</dl>
</li>
</ul>
<a id="decodeMatrix(java.lang.String,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decodeMatrix</h4>
<pre class="methodSignature">public static <a href="MultivaluedMap.html" title="interface in org.glassfish.tyrus.core.uri.internal">MultivaluedMap</a><java.lang.String,​java.lang.String> decodeMatrix​(java.lang.String pathSegment,
boolean decode)</pre>
<div class="block">Decode the matrix component of a URI path segment.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pathSegment</code> - the path segment component in encoded form.</dd>
<dd><code>decode</code> - true if the matrix parameters of the path segment component should be in decoded form.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the multivalued map of matrix parameters.</dd>
</dl>
</li>
</ul>
<a id="isHexCharacter(char)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isHexCharacter</h4>
<pre class="methodSignature">public static boolean isHexCharacter​(char c)</pre>
<div class="block">Checks whether the character <code>c</code> is hexadecimal character.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>c</code> - Any character</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The is <code>c</code> is a hexadecimal character (e.g. 0, 5, a, A, f, ...)</dd>
</dl>
</li>
</ul>
<a id="fullRelativeUri(java.net.URI)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>fullRelativeUri</h4>
<pre class="methodSignature">public static java.lang.String fullRelativeUri​(java.net.URI uri)</pre>
<div class="block">Return the <code>Request-Uri</code> representation as defined by HTTP spec. For example:
<pre><Method> <Request-URI> HTTP/<Version> (e.g. GET /auth;foo=bar/hello?foo=bar HTTP/1.1)</pre></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uri</code> - uri to obtain <code>Request-Uri</code> from.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>Request-Uri</code> representation or <code>null</code> if <code>uri</code> is not provided.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.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/UriComponent.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_bottom">
<li><a href="../../../../../../allclasses.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
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><a href="#nested.class.summary">Nested</a> | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright © 2012–2020 <a href="http://www.oracle.com/">Oracle Corporation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>