/usr/share/doc/libjsoup-java/api/org/jsoup/safety/Whitelist.html is in libjsoup-java-doc 1.10.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Whitelist (jsoup Java HTML Parser 1.10.2 API)</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Whitelist (jsoup Java HTML Parser 1.10.2 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9,"i5":9,"i6":10,"i7":10,"i8":9,"i9":10,"i10":9,"i11":10,"i12":10,"i13":10,"i14":10,"i15":9};
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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Whitelist.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">
<li><a href="../../../org/jsoup/safety/Cleaner.html" title="class in org.jsoup.safety"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/jsoup/safety/Whitelist.html" target="_top">Frames</a></li>
<li><a href="Whitelist.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </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>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.jsoup.safety</div>
<h2 title="Class Whitelist" class="title">Class Whitelist</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.jsoup.safety.Whitelist</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">Whitelist</span>
extends <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Whitelists define what HTML (elements and attributes) to allow through the cleaner. Everything else is removed.
<p>
Start with one of the defaults:
</p>
<ul>
<li><a href="../../../org/jsoup/safety/Whitelist.html#none--"><code>none()</code></a>
<li><a href="../../../org/jsoup/safety/Whitelist.html#simpleText--"><code>simpleText()</code></a>
<li><a href="../../../org/jsoup/safety/Whitelist.html#basic--"><code>basic()</code></a>
<li><a href="../../../org/jsoup/safety/Whitelist.html#basicWithImages--"><code>basicWithImages()</code></a>
<li><a href="../../../org/jsoup/safety/Whitelist.html#relaxed--"><code>relaxed()</code></a>
</ul>
<p>
If you need to allow more through (please be careful!), tweak a base whitelist with:
</p>
<ul>
<li><a href="../../../org/jsoup/safety/Whitelist.html#addTags-java.lang.String...-"><code>addTags(java.lang.String...)</code></a>
<li><a href="../../../org/jsoup/safety/Whitelist.html#addAttributes-java.lang.String-java.lang.String...-"><code>addAttributes(java.lang.String, java.lang.String...)</code></a>
<li><a href="../../../org/jsoup/safety/Whitelist.html#addEnforcedAttribute-java.lang.String-java.lang.String-java.lang.String-"><code>addEnforcedAttribute(java.lang.String, java.lang.String, java.lang.String)</code></a>
<li><a href="../../../org/jsoup/safety/Whitelist.html#addProtocols-java.lang.String-java.lang.String-java.lang.String...-"><code>addProtocols(java.lang.String, java.lang.String, java.lang.String...)</code></a>
</ul>
<p>
You can remove any setting from an existing whitelist with:
</p>
<ul>
<li><a href="../../../org/jsoup/safety/Whitelist.html#removeTags-java.lang.String...-"><code>removeTags(java.lang.String...)</code></a>
<li><a href="../../../org/jsoup/safety/Whitelist.html#removeAttributes-java.lang.String-java.lang.String...-"><code>removeAttributes(java.lang.String, java.lang.String...)</code></a>
<li><a href="../../../org/jsoup/safety/Whitelist.html#removeEnforcedAttribute-java.lang.String-java.lang.String-"><code>removeEnforcedAttribute(java.lang.String, java.lang.String)</code></a>
<li><a href="../../../org/jsoup/safety/Whitelist.html#removeProtocols-java.lang.String-java.lang.String-java.lang.String...-"><code>removeProtocols(java.lang.String, java.lang.String, java.lang.String...)</code></a>
</ul>
<p>
The cleaner and these whitelists assume that you want to clean a <code>body</code> fragment of HTML (to add user
supplied HTML into a templated page), and not to clean a full HTML document. If the latter is the case, either wrap the
document HTML around the cleaned body HTML, or create a whitelist that allows <code>html</code> and <code>head</code>
elements as appropriate.
</p>
<p>
If you are going to extend a whitelist, please be very careful. Make sure you understand what attributes may lead to
XSS attack vectors. URL attributes are particularly vulnerable and require careful validation. See
http://ha.ckers.org/xss.html for some XSS attack examples.
</p></div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Jonathan Hedley</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/jsoup/safety/Whitelist.html#Whitelist--">Whitelist</a></span>()</code>
<div class="block">Create a new, empty whitelist.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jsoup/safety/Whitelist.html#addAttributes-java.lang.String-java.lang.String...-">addAttributes</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tag,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... attributes)</code>
<div class="block">Add a list of allowed attributes to a tag.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jsoup/safety/Whitelist.html#addEnforcedAttribute-java.lang.String-java.lang.String-java.lang.String-">addEnforcedAttribute</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tag,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> attribute,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value)</code>
<div class="block">Add an enforced attribute to a tag.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jsoup/safety/Whitelist.html#addProtocols-java.lang.String-java.lang.String-java.lang.String...-">addProtocols</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tag,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> attribute,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... protocols)</code>
<div class="block">Add allowed URL protocols for an element's URL attribute.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jsoup/safety/Whitelist.html#addTags-java.lang.String...-">addTags</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... tags)</code>
<div class="block">Add a list of allowed elements to a whitelist.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jsoup/safety/Whitelist.html#basic--">basic</a></span>()</code>
<div class="block">
This whitelist allows a fuller range of text nodes: <code>a, b, blockquote, br, cite, code, dd, dl, dt, em, i, li,
ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul</code>, and appropriate attributes.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jsoup/safety/Whitelist.html#basicWithImages--">basicWithImages</a></span>()</code>
<div class="block">This whitelist allows the same text tags as <a href="../../../org/jsoup/safety/Whitelist.html#basic--"><code>basic()</code></a>, and also allows <code>img</code> tags, with appropriate
attributes, with <code>src</code> pointing to <code>http</code> or <code>https</code>.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jsoup/safety/Whitelist.html#isSafeAttribute-java.lang.String-org.jsoup.nodes.Element-org.jsoup.nodes.Attribute-">isSafeAttribute</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tagName,
<a href="../../../org/jsoup/nodes/Element.html" title="class in org.jsoup.nodes">Element</a> el,
<a href="../../../org/jsoup/nodes/Attribute.html" title="class in org.jsoup.nodes">Attribute</a> attr)</code>
<div class="block">Test if the supplied attribute is allowed by this whitelist for this tag</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jsoup/safety/Whitelist.html#isSafeTag-java.lang.String-">isSafeTag</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tag)</code>
<div class="block">Test if the supplied tag is allowed by this whitelist</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static <a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jsoup/safety/Whitelist.html#none--">none</a></span>()</code>
<div class="block">This whitelist allows only text nodes: all HTML will be stripped.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jsoup/safety/Whitelist.html#preserveRelativeLinks-boolean-">preserveRelativeLinks</a></span>(boolean preserve)</code>
<div class="block">Configure this Whitelist to preserve relative links in an element's URL attribute, or convert them to absolute
links.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static <a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jsoup/safety/Whitelist.html#relaxed--">relaxed</a></span>()</code>
<div class="block">This whitelist allows a full range of text and structural body HTML: <code>a, b, blockquote, br, caption, cite,
code, col, colgroup, dd, div, dl, dt, em, h1, h2, h3, h4, h5, h6, i, img, li, ol, p, pre, q, small, span, strike, strong, sub,
sup, table, tbody, td, tfoot, th, thead, tr, u, ul</code></div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jsoup/safety/Whitelist.html#removeAttributes-java.lang.String-java.lang.String...-">removeAttributes</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tag,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... attributes)</code>
<div class="block">Remove a list of allowed attributes from a tag.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jsoup/safety/Whitelist.html#removeEnforcedAttribute-java.lang.String-java.lang.String-">removeEnforcedAttribute</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tag,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> attribute)</code>
<div class="block">Remove a previously configured enforced attribute from a tag.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jsoup/safety/Whitelist.html#removeProtocols-java.lang.String-java.lang.String-java.lang.String...-">removeProtocols</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tag,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> attribute,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... removeProtocols)</code>
<div class="block">Remove allowed URL protocols for an element's URL attribute.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jsoup/safety/Whitelist.html#removeTags-java.lang.String...-">removeTags</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... tags)</code>
<div class="block">Remove a list of allowed elements from a whitelist.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jsoup/safety/Whitelist.html#simpleText--">simpleText</a></span>()</code>
<div class="block">This whitelist allows only simple text formatting: <code>b, em, i, strong, u</code>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Whitelist--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Whitelist</h4>
<pre>public Whitelist()</pre>
<div class="block">Create a new, empty whitelist. Generally it will be better to start with a default prepared whitelist instead.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/jsoup/safety/Whitelist.html#basic--"><code>basic()</code></a>,
<a href="../../../org/jsoup/safety/Whitelist.html#basicWithImages--"><code>basicWithImages()</code></a>,
<a href="../../../org/jsoup/safety/Whitelist.html#simpleText--"><code>simpleText()</code></a>,
<a href="../../../org/jsoup/safety/Whitelist.html#relaxed--"><code>relaxed()</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="none--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>none</h4>
<pre>public static <a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a> none()</pre>
<div class="block">This whitelist allows only text nodes: all HTML will be stripped.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whitelist</dd>
</dl>
</li>
</ul>
<a name="simpleText--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>simpleText</h4>
<pre>public static <a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a> simpleText()</pre>
<div class="block">This whitelist allows only simple text formatting: <code>b, em, i, strong, u</code>. All other HTML (tags and
attributes) will be removed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whitelist</dd>
</dl>
</li>
</ul>
<a name="basic--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>basic</h4>
<pre>public static <a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a> basic()</pre>
<div class="block"><p>
This whitelist allows a fuller range of text nodes: <code>a, b, blockquote, br, cite, code, dd, dl, dt, em, i, li,
ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul</code>, and appropriate attributes.
</p>
<p>
Links (<code>a</code> elements) can point to <code>http, https, ftp, mailto</code>, and have an enforced
<code>rel=nofollow</code> attribute.
</p>
<p>
Does not allow images.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whitelist</dd>
</dl>
</li>
</ul>
<a name="basicWithImages--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>basicWithImages</h4>
<pre>public static <a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a> basicWithImages()</pre>
<div class="block">This whitelist allows the same text tags as <a href="../../../org/jsoup/safety/Whitelist.html#basic--"><code>basic()</code></a>, and also allows <code>img</code> tags, with appropriate
attributes, with <code>src</code> pointing to <code>http</code> or <code>https</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whitelist</dd>
</dl>
</li>
</ul>
<a name="relaxed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>relaxed</h4>
<pre>public static <a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a> relaxed()</pre>
<div class="block">This whitelist allows a full range of text and structural body HTML: <code>a, b, blockquote, br, caption, cite,
code, col, colgroup, dd, div, dl, dt, em, h1, h2, h3, h4, h5, h6, i, img, li, ol, p, pre, q, small, span, strike, strong, sub,
sup, table, tbody, td, tfoot, th, thead, tr, u, ul</code>
<p>
Links do not have an enforced <code>rel=nofollow</code> attribute, but you can add that if desired.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whitelist</dd>
</dl>
</li>
</ul>
<a name="addTags-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addTags</h4>
<pre>public <a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a> addTags(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... tags)</pre>
<div class="block">Add a list of allowed elements to a whitelist. (If a tag is not allowed, it will be removed from the HTML.)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tags</code> - tag names to allow</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this (for chaining)</dd>
</dl>
</li>
</ul>
<a name="removeTags-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeTags</h4>
<pre>public <a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a> removeTags(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... tags)</pre>
<div class="block">Remove a list of allowed elements from a whitelist. (If a tag is not allowed, it will be removed from the HTML.)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tags</code> - tag names to disallow</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this (for chaining)</dd>
</dl>
</li>
</ul>
<a name="addAttributes-java.lang.String-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addAttributes</h4>
<pre>public <a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a> addAttributes(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tag,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... attributes)</pre>
<div class="block">Add a list of allowed attributes to a tag. (If an attribute is not allowed on an element, it will be removed.)
<p>
E.g.: <code>addAttributes("a", "href", "class")</code> allows <code>href</code> and <code>class</code> attributes
on <code>a</code> tags.
</p>
<p>
To make an attribute valid for <b>all tags</b>, use the pseudo tag <code>:all</code>, e.g.
<code>addAttributes(":all", "class")</code>.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tag</code> - The tag the attributes are for. The tag will be added to the allowed tag list if necessary.</dd>
<dd><code>attributes</code> - List of valid attributes for the tag</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this (for chaining)</dd>
</dl>
</li>
</ul>
<a name="removeAttributes-java.lang.String-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAttributes</h4>
<pre>public <a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a> removeAttributes(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tag,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... attributes)</pre>
<div class="block">Remove a list of allowed attributes from a tag. (If an attribute is not allowed on an element, it will be removed.)
<p>
E.g.: <code>removeAttributes("a", "href", "class")</code> disallows <code>href</code> and <code>class</code>
attributes on <code>a</code> tags.
</p>
<p>
To make an attribute invalid for <b>all tags</b>, use the pseudo tag <code>:all</code>, e.g.
<code>removeAttributes(":all", "class")</code>.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tag</code> - The tag the attributes are for.</dd>
<dd><code>attributes</code> - List of invalid attributes for the tag</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this (for chaining)</dd>
</dl>
</li>
</ul>
<a name="addEnforcedAttribute-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addEnforcedAttribute</h4>
<pre>public <a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a> addEnforcedAttribute(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tag,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> attribute,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value)</pre>
<div class="block">Add an enforced attribute to a tag. An enforced attribute will always be added to the element. If the element
already has the attribute set, it will be overridden with this value.
<p>
E.g.: <code>addEnforcedAttribute("a", "rel", "nofollow")</code> will make all <code>a</code> tags output as
<code><a href="..." rel="nofollow"></code>
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tag</code> - The tag the enforced attribute is for. The tag will be added to the allowed tag list if necessary.</dd>
<dd><code>attribute</code> - The attribute name</dd>
<dd><code>value</code> - The enforced attribute value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this (for chaining)</dd>
</dl>
</li>
</ul>
<a name="removeEnforcedAttribute-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeEnforcedAttribute</h4>
<pre>public <a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a> removeEnforcedAttribute(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tag,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> attribute)</pre>
<div class="block">Remove a previously configured enforced attribute from a tag.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tag</code> - The tag the enforced attribute is for.</dd>
<dd><code>attribute</code> - The attribute name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this (for chaining)</dd>
</dl>
</li>
</ul>
<a name="preserveRelativeLinks-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>preserveRelativeLinks</h4>
<pre>public <a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a> preserveRelativeLinks(boolean preserve)</pre>
<div class="block">Configure this Whitelist to preserve relative links in an element's URL attribute, or convert them to absolute
links. By default, this is <b>false</b>: URLs will be made absolute (e.g. start with an allowed protocol, like
e.g. <code>http://</code>.
<p>
Note that when handling relative links, the input document must have an appropriate <code>base URI</code> set when
parsing, so that the link's protocol can be confirmed. Regardless of the setting of the <code>preserve relative
links</code> option, the link must be resolvable against the base URI to an allowed protocol; otherwise the attribute
will be removed.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>preserve</code> - <code>true</code> to allow relative links, <code>false</code> (default) to deny</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this Whitelist, for chaining.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/jsoup/safety/Whitelist.html#addProtocols-java.lang.String-java.lang.String-java.lang.String...-"><code>addProtocols(java.lang.String, java.lang.String, java.lang.String...)</code></a></dd>
</dl>
</li>
</ul>
<a name="addProtocols-java.lang.String-java.lang.String-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addProtocols</h4>
<pre>public <a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a> addProtocols(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tag,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> attribute,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... protocols)</pre>
<div class="block">Add allowed URL protocols for an element's URL attribute. This restricts the possible values of the attribute to
URLs with the defined protocol.
<p>
E.g.: <code>addProtocols("a", "href", "ftp", "http", "https")</code>
</p>
<p>
To allow a link to an in-page URL anchor (i.e. <code><a href="#anchor"></code>, add a <code>#</code>:<br>
E.g.: <code>addProtocols("a", "href", "#")</code>
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tag</code> - Tag the URL protocol is for</dd>
<dd><code>attribute</code> - Attribute name</dd>
<dd><code>protocols</code> - List of valid protocols</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this, for chaining</dd>
</dl>
</li>
</ul>
<a name="removeProtocols-java.lang.String-java.lang.String-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeProtocols</h4>
<pre>public <a href="../../../org/jsoup/safety/Whitelist.html" title="class in org.jsoup.safety">Whitelist</a> removeProtocols(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tag,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> attribute,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... removeProtocols)</pre>
<div class="block">Remove allowed URL protocols for an element's URL attribute. If you remove all protocols for an attribute, that
attribute will allow any protocol.
<p>
E.g.: <code>removeProtocols("a", "href", "ftp")</code>
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tag</code> - Tag the URL protocol is for</dd>
<dd><code>attribute</code> - Attribute name</dd>
<dd><code>removeProtocols</code> - List of invalid protocols</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this, for chaining</dd>
</dl>
</li>
</ul>
<a name="isSafeTag-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSafeTag</h4>
<pre>protected boolean isSafeTag(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tag)</pre>
<div class="block">Test if the supplied tag is allowed by this whitelist</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tag</code> - test tag</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if allowed</dd>
</dl>
</li>
</ul>
<a name="isSafeAttribute-java.lang.String-org.jsoup.nodes.Element-org.jsoup.nodes.Attribute-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isSafeAttribute</h4>
<pre>protected boolean isSafeAttribute(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tagName,
<a href="../../../org/jsoup/nodes/Element.html" title="class in org.jsoup.nodes">Element</a> el,
<a href="../../../org/jsoup/nodes/Attribute.html" title="class in org.jsoup.nodes">Attribute</a> attr)</pre>
<div class="block">Test if the supplied attribute is allowed by this whitelist for this tag</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tagName</code> - tag to consider allowing the attribute in</dd>
<dd><code>el</code> - element under test, to confirm protocol</dd>
<dd><code>attr</code> - attribute under test</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if allowed</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Whitelist.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">
<li><a href="../../../org/jsoup/safety/Cleaner.html" title="class in org.jsoup.safety"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/jsoup/safety/Whitelist.html" target="_top">Frames</a></li>
<li><a href="Whitelist.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </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>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2009–2017 <a href="http://jonathanhedley.com/">Jonathan Hedley</a>. All rights reserved.</small></p>
</body>
</html>
|