aboutsummaryrefslogtreecommitdiff
path: root/branch-master/string-api.html
blob: b634f1fcfe28dc395030f09d89831295b4ee1052 (plain)
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
<html>
  <head>
    <title>string - clojure-contrib next API documentation</title>
    <link href="../static/favicon.png" rel="icon" />
    <link href="../static/favicon.png" rel="shortcut icon" />
    <link media="all" type="text/css" href="../static/clojure.css" rel="stylesheet" />
    <link media="all" type="text/css" href="../static/wiki.css" rel="stylesheet" />
    <link media="all" type="text/css" href="../static/internal.css" rel="stylesheet" />
    <!-- TODO: are we using these (from clojure.org)? If so, add the files -->
    <script src="file/view/code_highlighter.js" type="text/javascript"></script>
    <script src="file/view/clojure.js" type="text/javascript"></script>
    <style>.menuWrapper{height: 36px;}</style>
    <!--[if lte IE 6]>
    <link rel="stylesheet" href="http://www.wikispaces.com/_/2009051601/s/internal_ie.css" type="text/css" />
    <![endif]-->
  </head>
<!--
This document was auto-generated from the source by the clojure autodoc system.
To report errors or ask questions about the overall documentation structure, formatting,
etc., contact Tom Faulhaber (google mail name: tomfaulhaber).
For errors in the documentation of a particular namespace, contact the author of that
namespace.
-->
  <body>
    <div id="AllContentContainer">
      <div id="Header">
	<a id="Logo" href="index.html"><img alt="Clojure" height="100" width="100" src="../static/clojure-icon.gif" /></a>
	<h1><a title="page header title" id="page-header" href="index.html">Clojure-contrib API Reference</a></h1>
      </div>
      <div id="leftcolumn"><div style="text-align: center;"></div>
<div class="menu">
  <div class="WikiCustomNav WikiElement wiki">
    <span class="toc-header"><span id="project-name">clojure-contrib</span> <span id="version">next</span> API</span><br />
    <ul>
      <li><a class="wiki_link" href="index.html">Overview</a></li>
      <li><a class="wiki_link" href="api-index.html">API Index</a></li>
    </ul>
    <span class="toc-header">Namespaces</span>
    <ul id="left-sidebar-list">
      <li><a href="accumulators-api.html" class="wiki_link">accumulators</a></li><li><a href="agent-utils-api.html" class="wiki_link">agent-utils</a></li><li><a href="apply-macro-api.html" class="wiki_link">apply-macro</a></li><li><a href="base64-api.html" class="wiki_link">base64</a></li><li><a href="classpath-api.html" class="wiki_link">classpath</a></li><li><a href="combinatorics-api.html" class="wiki_link">combinatorics</a></li><li><a href="command-line-api.html" class="wiki_link">command-line</a></li><li><a href="complex-numbers-api.html" class="wiki_link">complex-numbers</a></li><li><a href="cond-api.html" class="wiki_link">cond</a></li><li><a href="condition-api.html" class="wiki_link">condition</a></li><li><a href="core-api.html" class="wiki_link">core</a></li><li><a href="dataflow-api.html" class="wiki_link">dataflow</a></li><li><a href="datalog-api.html" class="wiki_link">datalog</a></li><li><a href="def-api.html" class="wiki_link">def</a></li><li><a href="duck-streams-api.html" class="wiki_link">duck-streams</a></li><li><a href="error-kit-api.html" class="wiki_link">error-kit</a></li><li><a href="except-api.html" class="wiki_link">except</a></li><li><a href="fcase-api.html" class="wiki_link">fcase</a></li><li><a href="find-namespaces-api.html" class="wiki_link">find-namespaces</a></li><li><a href="fnmap-api.html" class="wiki_link">fnmap</a></li><li><a href="gen-html-docs-api.html" class="wiki_link">gen-html-docs</a></li><li><a href="generic.arithmetic-api.html" class="wiki_link">generic.arithmetic</a></li><li><a href="generic.collection-api.html" class="wiki_link">generic.collection</a></li><li><a href="generic.comparison-api.html" class="wiki_link">generic.comparison</a></li><li><a href="generic.functor-api.html" class="wiki_link">generic.functor</a></li><li><a href="generic.math-functions-api.html" class="wiki_link">generic.math-functions</a></li><li><a href="graph-api.html" class="wiki_link">graph</a></li><li><a href="greatest-least-api.html" class="wiki_link">greatest-least</a></li><li><a href="http.agent-api.html" class="wiki_link">http.agent</a></li><li><a href="http.connection-api.html" class="wiki_link">http.connection</a></li><li><a href="import-static-api.html" class="wiki_link">import-static</a></li><li><a href="io-api.html" class="wiki_link">io</a></li><li><a href="jar-api.html" class="wiki_link">jar</a></li><li><a href="java-utils-api.html" class="wiki_link">java-utils</a></li><li><a href="javadoc.browse-api.html" class="wiki_link">javadoc.browse</a></li><li><a href="jmx-api.html" class="wiki_link">jmx</a></li><li><a href="json-api.html" class="wiki_link">json</a></li><li><a href="lazy-seqs-api.html" class="wiki_link">lazy-seqs</a></li><li><a href="lazy-xml-api.html" class="wiki_link">lazy-xml</a></li><li><a href="logging-api.html" class="wiki_link">logging</a></li><li><a href="macro-utils-api.html" class="wiki_link">macro-utils</a></li><li><a href="macros-api.html" class="wiki_link">macros</a></li><li><a href="map-utils-api.html" class="wiki_link">map-utils</a></li><li><a href="math-api.html" class="wiki_link">math</a></li><li><a href="miglayout-api.html" class="wiki_link">miglayout</a></li><li><a href="mmap-api.html" class="wiki_link">mmap</a></li><li><a href="mock-api.html" class="wiki_link">mock</a></li><li><a href="monadic-io-streams-api.html" class="wiki_link">monadic-io-streams</a></li><li><a href="monads-api.html" class="wiki_link">monads</a></li><li><a href="ns-utils-api.html" class="wiki_link">ns-utils</a></li><li><a href="pprint-api.html" class="wiki_link">pprint</a></li><li><a href="priority-map-api.html" class="wiki_link">priority-map</a></li><li><a href="probabilities.finite-distributions-api.html" class="wiki_link">probabilities.finite-distributions</a></li><li><a href="probabilities.monte-carlo-api.html" class="wiki_link">probabilities.monte-carlo</a></li><li><a href="probabilities.random-numbers-api.html" class="wiki_link">probabilities.random-numbers</a></li><li><a href="profile-api.html" class="wiki_link">profile</a></li><li><a href="properties-api.html" class="wiki_link">properties</a></li><li><a href="prxml-api.html" class="wiki_link">prxml</a></li><li><a href="reflect-api.html" class="wiki_link">reflect</a></li><li><a href="repl-ln-api.html" class="wiki_link">repl-ln</a></li><li><a href="repl-utils-api.html" class="wiki_link">repl-utils</a></li><li><a href="seq-api.html" class="wiki_link">seq</a></li><li><a href="seq-utils-api.html" class="wiki_link">seq-utils</a></li><li><a href="server-socket-api.html" class="wiki_link">server-socket</a></li><li><a href="set-api.html" class="wiki_link">set</a></li><li><a href="shell-api.html" class="wiki_link">shell</a></li><li><a href="shell-out-api.html" class="wiki_link">shell-out</a></li><li><a href="singleton-api.html" class="wiki_link">singleton</a></li><li><a href="sql-api.html" class="wiki_link">sql</a></li><li><a href="str-utils-api.html" class="wiki_link">str-utils</a></li><li><a href="str-utils2-api.html" class="wiki_link">str-utils2</a></li><li><a href="stream-utils-api.html" class="wiki_link">stream-utils</a></li><li><a href="string-api.html" class="wiki_link">string</a></li><li><a href="strint-api.html" class="wiki_link">strint</a></li><li><a href="swing-utils-api.html" class="wiki_link">swing-utils</a></li><li><a href="test-complex-numbers-api.html" class="wiki_link">test-complex-numbers</a></li><li><a href="test-core-api.html" class="wiki_link">test-core</a></li><li><a href="test-dataflow-api.html" class="wiki_link">test-dataflow</a></li><li><a href="test-def-api.html" class="wiki_link">test-def</a></li><li><a href="test-fnmap-api.html" class="wiki_link">test-fnmap</a></li><li><a href="test-graph-api.html" class="wiki_link">test-graph</a></li><li><a href="test-greatest-least-api.html" class="wiki_link">test-greatest-least</a></li><li><a href="test-io-api.html" class="wiki_link">test-io</a></li><li><a href="test-is-api.html" class="wiki_link">test-is</a></li><li><a href="test-jmx-api.html" class="wiki_link">test-jmx</a></li><li><a href="test-json-api.html" class="wiki_link">test-json</a></li><li><a href="test-lazy-seqs-api.html" class="wiki_link">test-lazy-seqs</a></li><li><a href="test-logging-api.html" class="wiki_link">test-logging</a></li><li><a href="test-macro-utils-api.html" class="wiki_link">test-macro-utils</a></li><li><a href="test-math-api.html" class="wiki_link">test-math</a></li><li><a href="test-miglayout-api.html" class="wiki_link">test-miglayout</a></li><li><a href="test-mock-api.html" class="wiki_link">test-mock</a></li><li><a href="test-monads-api.html" class="wiki_link">test-monads</a></li><li><a href="test-profile-api.html" class="wiki_link">test-profile</a></li><li><a href="test-properties-api.html" class="wiki_link">test-properties</a></li><li><a href="test-prxml-api.html" class="wiki_link">test-prxml</a></li><li><a href="test-repl-utils-api.html" class="wiki_link">test-repl-utils</a></li><li><a href="test-seq-api.html" class="wiki_link">test-seq</a></li><li><a href="test-shell-api.html" class="wiki_link">test-shell</a></li><li><a href="test-sql-api.html" class="wiki_link">test-sql</a></li><li><a href="test-string-api.html" class="wiki_link">test-string</a></li><li><a href="test-strint-api.html" class="wiki_link">test-strint</a></li><li><a href="test-trace-api.html" class="wiki_link">test-trace</a></li><li><a href="test-with-ns-api.html" class="wiki_link">test-with-ns</a></li><li><a href="trace-api.html" class="wiki_link">trace</a></li><li><a href="types-api.html" class="wiki_link">types</a></li><li><a href="with-ns-api.html" class="wiki_link">with-ns</a></li><li><a href="zip-filter-api.html" class="wiki_link">zip-filter</a></li>
    </ul>
    <div class="BranchTOC">
      <span class="toc-header">Other Versions</span>
      <ul id="left-sidebar-branch-list">
        <li><a href="../index.html" class="wiki_link">v1.2 (beta 1)</a></li><li><a href="../branch-1.1.x/index.html" class="wiki_link">v1.1 (stable)</a></li>
      </ul>
    </div>
    <a href="http://clojure.org" class="wiki_link">Clojure Home</a>
  </div>
</div>
</div>
      <div id="rightcolumn">
	<div id="Content">
	  <div class="contentBox"><div class="innerContentBox">
              <div id="content_view" class="wiki wikiPage">
                <div id="right-sidebar"><div id="toc">
  <h1 class="nopad">Table of Contents</h1>
  <div style="margin-left: 1em;" class="toc-section">
    <a href="#toc0">Overview</a>
    <div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/as-str">as-str</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/blank?">blank?</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/butlast">butlast</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/capitalize">capitalize</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/chomp">chomp</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/chop">chop</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/codepoints">codepoints</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/dochars">dochars</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/docodepoints">docodepoints</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/drop">drop</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/escape">escape</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/get">get</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/grep">grep</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/join">join</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/lower-case">lower-case</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/ltrim">ltrim</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/map-str">map-str</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/partition">partition</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/repeat">repeat</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/replace-by">replace-by</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/replace-char">replace-char</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/replace-first-by">replace-first-by</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/replace-first-re">replace-first-re</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/replace-first-str">replace-first-str</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/replace-re">replace-re</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/replace-str">replace-str</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/reverse">reverse</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/rtrim">rtrim</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/split">split</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/split-lines">split-lines</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/substring?">substring?</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/swap-case">swap-case</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/tail">tail</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/take">take</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/trim">trim</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.string/upper-case">upper-case</a>
    </div>
    <br />
  </div>
</div>
</div>
                <div id="content-tag"><h1 id="overview">API for <span id="namespace-name">string</span>
  - <span id="header-project">clojure-contrib</span> <span id="header-version">next</span> (<span id="header-status">in development</span>)
  </h1>

<br />Usage:
<pre>
(ns your-namespace
  (:require <span id="long-name">clojure.contrib.string</span>))
</pre><pre>
</pre><h2>Overview</h2>
<pre id="namespace-docstr"></pre>


<br />
<h2>Public Variables and Functions</h2>
<div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/as-str">as-str</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (as-str)
       (as-str x)
       (as-str x &amp; ys)
</pre>
  <pre id="var-docstr">Like clojure.core/str, but if an argument is a keyword or symbol,
its name will be used instead of its literal representation.

Example:
   (str :foo :bar)     ;;=&gt; ":foo:bar"
   (as-str :foo :bar)  ;;=&gt; "foobar" 

Note that this does not apply to keywords or symbols nested within
data structures; they will be rendered as with str.

Example:
   (str {:foo :bar})     ;;=&gt; "{:foo :bar}"
   (as-str {:foo :bar})  ;;=&gt; "{:foo :bar}" </pre>
  
  
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L315" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/blank?">blank?</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (blank? s)
</pre>
  <pre id="var-docstr">True if s is nil, empty, or contains only whitespace.</pre>
  
  <span class="var-deprecated"><span id="content">Deprecated since clojure-contrib version 1.2</span><br /></span>
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L104" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/butlast">butlast</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (butlast n s)
</pre>
  <pre id="var-docstr">Returns s without the last n characters.  Returns an empty string
if n is greater than the length of s.</pre>
  
  
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L125" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/capitalize">capitalize</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (capitalize s)
</pre>
  <pre id="var-docstr">Converts first character of the string to upper-case, all other
characters to lower-case.</pre>
  
  <span class="var-deprecated"><span id="content">Deprecated since clojure-contrib version 1.2</span><br /></span>
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L271" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/chomp">chomp</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (chomp s)
</pre>
  <pre id="var-docstr">Removes all trailing newline \n or return \r characters from
string.  Note: String.trim() is similar and faster.
Deprecated in 1.2. Use clojure.string/trim-newline</pre>
  
  <span class="var-deprecated"><span id="content">Deprecated since clojure-contrib version 1.2</span><br /></span>
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L245" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/chop">chop</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (chop s)
</pre>
  <pre id="var-docstr">Removes the last character of string, does nothing on a zero-length
string.</pre>
  
  
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L236" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/codepoints">codepoints</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (codepoints s)
</pre>
  <pre id="var-docstr">Returns a sequence of integer Unicode code points in s.  Handles
Unicode supplementary characters (above U+FFFF) correctly.</pre>
  
  
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L78" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/dochars">dochars</h2>
  <span id="var-type">macro</span><br />
  <pre id="var-usage">Usage: (dochars bindings &amp; body)
</pre>
  <pre id="var-docstr">bindings =&gt; [name string]

Repeatedly executes body, with name bound to each character in
string.  Does NOT handle Unicode supplementary characters (above
U+FFFF).</pre>
  
  
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L38" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/docodepoints">docodepoints</h2>
  <span id="var-type">macro</span><br />
  <pre id="var-usage">Usage: (docodepoints bindings &amp; body)
</pre>
  <pre id="var-docstr">bindings =&gt; [name string]

Repeatedly executes body, with name bound to the integer code point
of each Unicode character in the string.  Handles Unicode
supplementary characters (above U+FFFF) correctly.</pre>
  
  
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L54" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/drop">drop</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (drop n s)
</pre>
  <pre id="var-docstr">Drops first n characters from s.  Returns an empty string if n is
greater than the length of s.</pre>
  
  
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L117" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/escape">escape</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (escape cmap s)
</pre>
  <pre id="var-docstr">Returns a new String by applying cmap (a function or a map) to each
character in s.  If cmap returns nil, the original character is
added to the output unchanged.</pre>
  
  <span class="var-deprecated"><span id="content">Deprecated since clojure-contrib version 1.2</span><br /></span>
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L91" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/get">get</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (get s i)
</pre>
  <pre id="var-docstr">Gets the i'th character in string.</pre>
  
  <span class="var-deprecated"><span id="content">Deprecated since clojure-contrib version 1.2</span><br /></span>
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L377" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/grep">grep</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (grep re coll)
</pre>
  <pre id="var-docstr">Filters elements of coll by a regular expression.  The String
representation (with str) of each element is tested with re-find.</pre>
  
  
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L309" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/join">join</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (join separator coll)
</pre>
  <pre id="var-docstr">Returns a string of all elements in coll, separated by
separator.  Like Perl's join.</pre>
  
  <span class="var-deprecated"><span id="content">Deprecated since clojure-contrib version 1.2</span><br /></span>
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L229" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/lower-case">lower-case</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (lower-case s)
</pre>
  <pre id="var-docstr">Converts string to all lower-case.</pre>
  
  <span class="var-deprecated"><span id="content">Deprecated since clojure-contrib version 1.2</span><br /></span>
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L353" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/ltrim">ltrim</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (ltrim s)
</pre>
  <pre id="var-docstr">Removes whitespace from the left side of string.
Deprecated in 1.2. Use clojure.string/triml.</pre>
  
  <span class="var-deprecated"><span id="content">Deprecated since clojure-contrib version 1.2</span><br /></span>
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L281" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/map-str">map-str</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (map-str f coll)
</pre>
  <pre id="var-docstr">Apply f to each element of coll, concatenate all results into a
String.</pre>
  
  
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L302" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/partition">partition</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (partition re s)
</pre>
  <pre id="var-docstr">Splits the string into a lazy sequence of substrings, alternating
between substrings that match the patthern and the substrings
between the matches.  The sequence always starts with the substring
before the first match, or an empty string if the beginning of the
string matches.

For example: (partition #"[a-z]+" "abc123def")
returns: ("" "abc" "123" "def")</pre>
  
  
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L208" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/repeat">repeat</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (repeat n s)
</pre>
  <pre id="var-docstr">Returns a new String containing s repeated n times.</pre>
  
  
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L140" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/replace-by">replace-by</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (replace-by re f s)
</pre>
  <pre id="var-docstr">Replaces all matches of re in s with the result of 
(f (re-groups the-match)).</pre>
  
  <span class="var-deprecated"><span id="content">Deprecated since clojure-contrib version 1.2</span><br /></span>
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L169" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/replace-char">replace-char</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (replace-char a b s)
</pre>
  <pre id="var-docstr">Replaces all instances of character a with character b in s.</pre>
  
  <span class="var-deprecated"><span id="content">Deprecated since clojure-contrib version 1.2</span><br /></span>
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L157" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/replace-first-by">replace-first-by</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (replace-first-by re f s)
</pre>
  <pre id="var-docstr">Replace first match of re in s with the result of
(f (re-groups the-match)).</pre>
  
  <span class="var-deprecated"><span id="content">Deprecated since clojure-contrib version 1.2</span><br /></span>
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L195" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/replace-first-re">replace-first-re</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (replace-first-re re replacement s)
</pre>
  <pre id="var-docstr">Replace first match of re in s.</pre>
  
  <span class="var-deprecated"><span id="content">Deprecated since clojure-contrib version 1.2</span><br /></span>
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L189" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/replace-first-str">replace-first-str</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (replace-first-str a b s)
</pre>
  <pre id="var-docstr">Replace first occurance of substring a with b in s.</pre>
  
  <span class="var-deprecated"><span id="content">Deprecated since clojure-contrib version 1.2</span><br /></span>
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L183" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/replace-re">replace-re</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (replace-re re replacement s)
</pre>
  <pre id="var-docstr">Replaces all matches of re with replacement in s.</pre>
  
  <span class="var-deprecated"><span id="content">Deprecated since clojure-contrib version 1.2</span><br /></span>
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L163" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/replace-str">replace-str</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (replace-str a b s)
</pre>
  <pre id="var-docstr">Replaces all instances of substring a with b in s.</pre>
  
  <span class="var-deprecated"><span id="content">Deprecated since clojure-contrib version 1.2</span><br /></span>
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L151" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/reverse">reverse</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (reverse s)
</pre>
  <pre id="var-docstr">Returns s with its characters reversed.</pre>
  
  <span class="var-deprecated"><span id="content">Deprecated since clojure-contrib version 1.2</span><br /></span>
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L145" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/rtrim">rtrim</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (rtrim s)
</pre>
  <pre id="var-docstr">Removes whitespace from the right side of string.
Deprecated in 1.2. Use clojure.string/trimr.</pre>
  
  <span class="var-deprecated"><span id="content">Deprecated since clojure-contrib version 1.2</span><br /></span>
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L288" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/split">split</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (split re s)
       (split re limit s)
</pre>
  <pre id="var-docstr">Splits string on a regular expression.  Optional argument limit is
the maximum number of splits.</pre>
  
  <span class="var-deprecated"><span id="content">Deprecated since clojure-contrib version 1.2</span><br /></span>
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L359" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/split-lines">split-lines</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (split-lines s)
</pre>
  <pre id="var-docstr">Splits s on \n or \r\n.</pre>
  
  <span class="var-deprecated"><span id="content">Deprecated since clojure-contrib version 1.2</span><br /></span>
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L295" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/substring?">substring?</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (substring? substring s)
</pre>
  <pre id="var-docstr">True if s contains the substring.</pre>
  
  
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L372" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/swap-case">swap-case</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (swap-case s)
</pre>
  <pre id="var-docstr">Changes upper case characters to lower case and vice-versa.
Handles Unicode supplementary characters correctly.  Uses the
locale-sensitive String.toUpperCase() and String.toLowerCase()
methods.</pre>
  
  
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L253" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/tail">tail</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (tail n s)
</pre>
  <pre id="var-docstr">Returns the last n characters of s.</pre>
  
  
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L133" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/take">take</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (take n s)
</pre>
  <pre id="var-docstr">Take first n characters from s, up to the length of s.</pre>
  
  
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L110" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/trim">trim</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (trim s)
</pre>
  <pre id="var-docstr">Removes whitespace from both ends of string.</pre>
  
  <span class="var-deprecated"><span id="content">Deprecated since clojure-contrib version 1.2</span><br /></span>
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L366" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.string/upper-case">upper-case</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (upper-case s)
</pre>
  <pre id="var-docstr">Converts string to all upper-case.</pre>
  
  <span class="var-deprecated"><span id="content">Deprecated since clojure-contrib version 1.2</span><br /></span>
  <a href="http://github.com/clojure/clojure-contrib/blob//modules/string/target/classes/clojure/contrib/string.clj#L347" id="var-source">Source</a>
</div>


</div>
              </div>
            </div>
          </div>
	</div>
	<div id="foot">
	  <div style="text-align: center;" id="copyright">Copyright 2007-2010 by Rich Hickey and the various contributors</div>
	</div>
      </div>
      <div id="DesignedBy">Logo &amp; site design by <a title="Visit Tom Hickey's website." href="http://www.tomhickey.com">Tom Hickey</a>.<br />
      Clojure auto-documentation system by Tom Faulhaber.</div>
    </div>
    <!-- /AllContentContainer -->
  </body>

</html>