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
|
<html>
<head>
<title>java-utils API reference (clojure-contrib)</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">
<div class="BranchTOC">
<a class="wiki_link" href="#">Branches</a>
<ul id="left-sidebar-branch-list">
<li><a href="index.html" class="wiki_link">master</a></li><li><a href="branch-1.1.x/index.html" class="wiki_link">1.1.x</a></li>
</ul>
</div>
<a class="wiki_link" href="index.html">Overview</a><br />
<a class="wiki_link" href="api-index.html">API Index</a><br />
<a class="wiki_link" href="#">Namespaces:</a>
<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="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-is-api.html" class="wiki_link">test-is</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>
</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.java-utils/as-file">as-file</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.java-utils/as-properties">as-properties</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.java-utils/as-str">as-str</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.java-utils/as-url">as-url</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.java-utils/delete-file">delete-file</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.java-utils/delete-file-recursively">delete-file-recursively</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.java-utils/file">file</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.java-utils/get-system-property">get-system-property</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.java-utils/read-properties">read-properties</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.java-utils/relative-path-string">relative-path-string</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.java-utils/set-system-properties">set-system-properties</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.java-utils/wall-hack-field">wall-hack-field</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.java-utils/wall-hack-method">wall-hack-method</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.java-utils/with-system-properties">with-system-properties</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.java-utils/write-properties">write-properties</a>
</div>
<br />
</div>
</div>
</div>
<div id="content-tag"><h1 id="overview">API for <span id="namespace-name">java-utils</span>
<span id="branch-name">(master branch)</span></h1>
by <span id="author">Stuart Halloway, Stephen C. Gilardi, Shawn Hoover, Perry Trolard, Stuart Sierra</span><br />
<br />Usage:
<pre>
(ns your-namespace
(:require <span id="long-name">clojure.contrib.java-utils</span>))
</pre><pre>
</pre><h2>Overview</h2>
<pre id="namespace-docstr">A set of utilties for dealing with Java stuff like files and properties.
Design goals:
(1) Ease-of-use. These APIs should be convenient. Performance is secondary.
(2) Duck typing. I hate having to think about the difference between
a string that names a file, and a File. Ditto for a ton of other
wrapper classes in the Java world (URL, InternetAddress). With these
APIs you should be able to think about domain equivalence, not type
equivalence.
(3) No bossiness. I am not marking any of these functions as private
the docstrings will tell you the intended usage but do what works for you.
Feedback welcome!
If something in this module violates the principle of least surprise, please
let me (Stu) and the Clojure community know via the mailing list.</pre>
<br />
<h2>Public Variables and Functions</h2>
<div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.java-utils/as-file">as-file</h2>
<span id="var-type">multimethod</span><br />
<pre id="var-usage">No usage documentation available</pre>
<pre id="var-docstr">Interpret a String or a java.io.File as a File. Building block
for clojure.contrib.java-utils/file, which you should prefer
in most cases.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.java-utils/as-properties">as-properties</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (as-properties m)
</pre>
<pre id="var-docstr">Convert any seq of pairs to a java.utils.Properties instance.
Uses as-str to convert both keys and values into strings.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.java-utils/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 & 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) ;;=> ":foo:bar"
(as-str :foo :bar) ;;=> "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}) ;;=> "{:foo :bar}"
(as-str {:foo :bar}) ;;=> "{:foo :bar}" </pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.java-utils/as-url">as-url</h2>
<span id="var-type">multimethod</span><br />
<pre id="var-usage">Usage: (as-url arg)
</pre>
<pre id="var-docstr">Coerces argument (URL, URI, or String) to a java.net.URL.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.java-utils/delete-file">delete-file</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (delete-file f & [silently])
</pre>
<pre id="var-docstr">Delete file f. Raise an exception if it fails unless silently is true.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.java-utils/delete-file-recursively">delete-file-recursively</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (delete-file-recursively f & [silently])
</pre>
<pre id="var-docstr">Delete file f. If it's a directory, recursively delete all its contents.
Raise an exception if any deletion fails unless silently is true.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.java-utils/file">file</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (file arg)
(file parent child)
(file parent child & more)
</pre>
<pre id="var-docstr">Returns a java.io.File from string or file args.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.java-utils/get-system-property">get-system-property</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (get-system-property stringable)
(get-system-property stringable default)
</pre>
<pre id="var-docstr">Get a system property.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.java-utils/read-properties">read-properties</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (read-properties file-able)
</pre>
<pre id="var-docstr">Read properties from file-able.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.java-utils/relative-path-string">relative-path-string</h2>
<span id="var-type">multimethod</span><br />
<pre id="var-usage">No usage documentation available</pre>
<pre id="var-docstr">Interpret a String or java.io.File as a relative path string.
Building block for clojure.contrib.java-utils/file.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.java-utils/set-system-properties">set-system-properties</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (set-system-properties settings)
</pre>
<pre id="var-docstr">Set some system properties. Nil clears a property.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.java-utils/wall-hack-field">wall-hack-field</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (wall-hack-field class-name field-name obj)
</pre>
<pre id="var-docstr">Access to private or protected field.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.java-utils/wall-hack-method">wall-hack-method</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (wall-hack-method class-name method-name params obj & args)
</pre>
<pre id="var-docstr">Calls a private or protected method.
params is a vector of class which correspond to the arguments to the method
obj is nil for static methods, the instance object otherwise
the method name is given as a symbol or a keyword (something Named)</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.java-utils/with-system-properties">with-system-properties</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (with-system-properties settings & body)
</pre>
<pre id="var-docstr">setting => property-name value
Sets the system properties to the supplied values, executes the body, and
sets the properties back to their original values. Values of nil are
translated to a clearing of the property.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.java-utils/write-properties">write-properties</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (write-properties m file-able)
(write-properties m file-able comments)
</pre>
<pre id="var-docstr">Write properties to file-able.</pre>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="foot">
<div style="text-align: center;" id="copyright">Copyright 2007-2009 by Rich Hickey and the various contributors</div>
</div>
</div>
<div id="DesignedBy">Logo & 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>
|
