/usr/share/doc/cedar-backup2-doc/interface/CedarBackup2.extend.mbox.MboxDir-class.html is in cedar-backup2-doc 2.22.0-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 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 | <?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>CedarBackup2.extend.mbox.MboxDir</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="CedarBackup2-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://cedar-backup.sourceforge.net/">CedarBackup2</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="CedarBackup2-module.html">Package CedarBackup2</a> ::
<a href="CedarBackup2.extend-module.html">Package extend</a> ::
<a href="CedarBackup2.extend.mbox-module.html">Module mbox</a> ::
Class MboxDir
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="CedarBackup2.extend.mbox.MboxDir-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class MboxDir</h1><p class="nomargin-top"><span class="codelink"><a href="CedarBackup2.extend.mbox-pysrc.html#MboxDir">source code</a></span></p>
<pre class="base-tree">
object --+
|
<strong class="uidshort">MboxDir</strong>
</pre>
<hr />
<p>Class representing mbox directory configuration..</p>
<p>The following restrictions exist on data in this class:</p>
<ul>
<li>
The absolute path must be absolute.
</li>
<li>
The collect mode must be one of the values in VALID_COLLECT_MODES.
</li>
<li>
The compress mode must be one of the values in VALID_COMPRESS_MODES.
</li>
</ul>
<p>Unlike collect directory configuration, this is the only place
exclusions are allowed (no global exclusions at the <mbox>
configuration level). Also, we only allow relative exclusions and there
is no configured ignore file. This is because mbox directory backups are
not recursive.</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.mbox.MboxDir-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">absolutePath</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">collectMode</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">compressMode</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">relativeExcludePaths</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">excludePatterns</span>=<span class="summary-sig-default">None</span>)</span><br />
Constructor for the <code>MboxDir</code> class.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.mbox-pysrc.html#MboxDir.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.mbox.MboxDir-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
Official string representation for class instance.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.mbox-pysrc.html#MboxDir.__repr__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.mbox.MboxDir-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br />
Informal string representation for class instance.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.mbox-pysrc.html#MboxDir.__str__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.mbox.MboxDir-class.html#__cmp__" class="summary-sig-name">__cmp__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">other</span>)</span><br />
Definition of equals operator for this class.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.mbox-pysrc.html#MboxDir.__cmp__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.mbox.MboxDir-class.html#_setAbsolutePath" class="summary-sig-name" onclick="show_private();">_setAbsolutePath</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span><br />
Property target used to set the absolute path.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.mbox-pysrc.html#MboxDir._setAbsolutePath">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_getAbsolutePath"></a><span class="summary-sig-name">_getAbsolutePath</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the absolute path.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.mbox-pysrc.html#MboxDir._getAbsolutePath">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.mbox.MboxDir-class.html#_setCollectMode" class="summary-sig-name" onclick="show_private();">_setCollectMode</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span><br />
Property target used to set the collect mode.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.mbox-pysrc.html#MboxDir._setCollectMode">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_getCollectMode"></a><span class="summary-sig-name">_getCollectMode</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the collect mode.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.mbox-pysrc.html#MboxDir._getCollectMode">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.mbox.MboxDir-class.html#_setCompressMode" class="summary-sig-name" onclick="show_private();">_setCompressMode</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span><br />
Property target used to set the compress mode.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.mbox-pysrc.html#MboxDir._setCompressMode">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_getCompressMode"></a><span class="summary-sig-name">_getCompressMode</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the compress mode.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.mbox-pysrc.html#MboxDir._getCompressMode">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.mbox.MboxDir-class.html#_setRelativeExcludePaths" class="summary-sig-name" onclick="show_private();">_setRelativeExcludePaths</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span><br />
Property target used to set the relative exclude paths list.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.mbox-pysrc.html#MboxDir._setRelativeExcludePaths">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_getRelativeExcludePaths"></a><span class="summary-sig-name">_getRelativeExcludePaths</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the relative exclude paths list.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.mbox-pysrc.html#MboxDir._getRelativeExcludePaths">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_setExcludePatterns"></a><span class="summary-sig-name">_setExcludePatterns</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span><br />
Property target used to set the exclude patterns list.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.mbox-pysrc.html#MboxDir._setExcludePatterns">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_getExcludePatterns"></a><span class="summary-sig-name">_getExcludePatterns</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the exclude patterns list.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.mbox-pysrc.html#MboxDir._getExcludePatterns">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__setattr__</code>,
<code>__sizeof__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Properties</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Properties"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.extend.mbox.MboxDir-class.html#absolutePath" class="summary-name">absolutePath</a><br />
Absolute path to the mbox directory.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.extend.mbox.MboxDir-class.html#collectMode" class="summary-name">collectMode</a><br />
Overridden collect mode for this mbox directory.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.extend.mbox.MboxDir-class.html#compressMode" class="summary-name">compressMode</a><br />
Overridden compress mode for this mbox directory.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.extend.mbox.MboxDir-class.html#relativeExcludePaths" class="summary-name">relativeExcludePaths</a><br />
List of relative paths to exclude.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.extend.mbox.MboxDir-class.html#excludePatterns" class="summary-name">excludePatterns</a><br />
List of regular expression patterns to exclude.
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">absolutePath</span>=<span class="sig-default">None</span>,
<span class="sig-arg">collectMode</span>=<span class="sig-default">None</span>,
<span class="sig-arg">compressMode</span>=<span class="sig-default">None</span>,
<span class="sig-arg">relativeExcludePaths</span>=<span class="sig-default">None</span>,
<span class="sig-arg">excludePatterns</span>=<span class="sig-default">None</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.mbox-pysrc.html#MboxDir.__init__">source code</a></span>
</td>
</tr></table>
<p>Constructor for the <code>MboxDir</code> class.</p>
<p>You should never directly instantiate this class.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>absolutePath</code></strong> - Absolute path to a mbox file on disk.</li>
<li><strong class="pname"><code>collectMode</code></strong> - Overridden collect mode for this directory.</li>
<li><strong class="pname"><code>compressMode</code></strong> - Overridden compression mode for this directory.</li>
<li><strong class="pname"><code>relativeExcludePaths</code></strong> - List of relative paths to exclude.</li>
<li><strong class="pname"><code>excludePatterns</code></strong> - List of regular expression patterns to exclude</li>
</ul></dd>
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="__repr__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
<br /><em class="fname">(Representation operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.mbox-pysrc.html#MboxDir.__repr__">source code</a></span>
</td>
</tr></table>
<p>Official string representation for class instance.</p>
<dl class="fields">
<dt>Overrides:
object.__repr__
</dt>
</dl>
</td></tr></table>
</div>
<a name="__str__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">self</span>)</span>
<br /><em class="fname">(Informal representation operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.mbox-pysrc.html#MboxDir.__str__">source code</a></span>
</td>
</tr></table>
<p>Informal string representation for class instance.</p>
<dl class="fields">
<dt>Overrides:
object.__str__
</dt>
</dl>
</td></tr></table>
</div>
<a name="__cmp__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__cmp__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">other</span>)</span>
<br /><em class="fname">(Comparison operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.mbox-pysrc.html#MboxDir.__cmp__">source code</a></span>
</td>
</tr></table>
<p>Definition of equals operator for this class.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>other</code></strong> - Other object to compare to.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>-1/0/1 depending on whether self is <code><</code>,
<code>=</code> or <code>></code> other.</dd>
</dl>
</td></tr></table>
</div>
<a name="_setAbsolutePath"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_setAbsolutePath</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">value</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.mbox-pysrc.html#MboxDir._setAbsolutePath">source code</a></span>
</td>
</tr></table>
<p>Property target used to set the absolute path. The value must be an
absolute path if it is not <code>None</code>. It does not have to exist
on disk at the time of assignment.</p>
<dl class="fields">
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If the value is not an absolute path.</li>
<li><code><strong class='fraise'>ValueError</strong></code> - If the value cannot be encoded properly.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_setCollectMode"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_setCollectMode</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">value</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.mbox-pysrc.html#MboxDir._setCollectMode">source code</a></span>
</td>
</tr></table>
<p>Property target used to set the collect mode. If not
<code>None</code>, the mode must be one of the values in
VALID_COLLECT_MODES.</p>
<dl class="fields">
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If the value is not valid.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_setCompressMode"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_setCompressMode</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">value</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.mbox-pysrc.html#MboxDir._setCompressMode">source code</a></span>
</td>
</tr></table>
<p>Property target used to set the compress mode. If not
<code>None</code>, the mode must be one of the values in
VALID_COMPRESS_MODES.</p>
<dl class="fields">
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If the value is not valid.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_setRelativeExcludePaths"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_setRelativeExcludePaths</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">value</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.mbox-pysrc.html#MboxDir._setRelativeExcludePaths">source code</a></span>
</td>
</tr></table>
<p>Property target used to set the relative exclude paths list. Elements
do not have to exist on disk at the time of assignment.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Property Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-PropertyDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="absolutePath"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">absolutePath</h3>
<p>Absolute path to the mbox directory.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.extend.mbox.MboxDir-class.html#_getAbsolutePath" class="summary-sig-name" onclick="show_private();">_getAbsolutePath</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the absolute path.
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.extend.mbox.MboxDir-class.html#_setAbsolutePath" class="summary-sig-name" onclick="show_private();">_setAbsolutePath</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span>
- Property target used to set the absolute path.
</dd>
</dl>
</td></tr></table>
</div>
<a name="collectMode"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">collectMode</h3>
<p>Overridden collect mode for this mbox directory.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.extend.mbox.MboxDir-class.html#_getCollectMode" class="summary-sig-name" onclick="show_private();">_getCollectMode</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the collect mode.
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.extend.mbox.MboxDir-class.html#_setCollectMode" class="summary-sig-name" onclick="show_private();">_setCollectMode</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span>
- Property target used to set the collect mode.
</dd>
</dl>
</td></tr></table>
</div>
<a name="compressMode"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">compressMode</h3>
<p>Overridden compress mode for this mbox directory.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.extend.mbox.MboxDir-class.html#_getCompressMode" class="summary-sig-name" onclick="show_private();">_getCompressMode</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the compress mode.
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.extend.mbox.MboxDir-class.html#_setCompressMode" class="summary-sig-name" onclick="show_private();">_setCompressMode</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span>
- Property target used to set the compress mode.
</dd>
</dl>
</td></tr></table>
</div>
<a name="relativeExcludePaths"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">relativeExcludePaths</h3>
<p>List of relative paths to exclude.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.extend.mbox.MboxDir-class.html#_getRelativeExcludePaths" class="summary-sig-name" onclick="show_private();">_getRelativeExcludePaths</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the relative exclude paths list.
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.extend.mbox.MboxDir-class.html#_setRelativeExcludePaths" class="summary-sig-name" onclick="show_private();">_setRelativeExcludePaths</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span>
- Property target used to set the relative exclude paths list.
</dd>
</dl>
</td></tr></table>
</div>
<a name="excludePatterns"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">excludePatterns</h3>
<p>List of regular expression patterns to exclude.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.extend.mbox.MboxDir-class.html#_getExcludePatterns" class="summary-sig-name" onclick="show_private();">_getExcludePatterns</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the exclude patterns list.
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.extend.mbox.MboxDir-class.html#_setExcludePatterns" class="summary-sig-name" onclick="show_private();">_setExcludePatterns</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span>
- Property target used to set the exclude patterns list.
</dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="CedarBackup2-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://cedar-backup.sourceforge.net/">CedarBackup2</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Thu May 9 21:18:27 2013
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|