aboutsummaryrefslogtreecommitdiff
path: root/branch-1.1.x/java-utils-api.html
diff options
context:
space:
mode:
authorTom Faulhaber <git_net@infolace.com>2010-06-02 10:47:29 -0700
committerTom Faulhaber <git_net@infolace.com>2010-06-02 10:47:29 -0700
commitb17ce9fbb29483eb8f6e591a1ff282db453a4713 (patch)
treec802eb892622de7b7a34cce55524fd5f91491817 /branch-1.1.x/java-utils-api.html
parentb9907dc35b12f46c584f426aacc61b4375f9ea8c (diff)
Autodoc commit for master/4fe738db, 1.1.x/d132c5f1
Diffstat (limited to 'branch-1.1.x/java-utils-api.html')
-rw-r--r--branch-1.1.x/java-utils-api.html54
1 files changed, 18 insertions, 36 deletions
diff --git a/branch-1.1.x/java-utils-api.html b/branch-1.1.x/java-utils-api.html
index fecedac7..8a19c45b 100644
--- a/branch-1.1.x/java-utils-api.html
+++ b/branch-1.1.x/java-utils-api.html
@@ -40,7 +40,7 @@ namespace.
<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="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="jmx-api.html" class="wiki_link">jmx</a></li><li><a href="json.read-api.html" class="wiki_link">json.read</a></li><li><a href="json.write-api.html" class="wiki_link">json.write</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="prxml-api.html" class="wiki_link">prxml</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-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-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="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>
+ <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="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.read-api.html" class="wiki_link">json.read</a></li><li><a href="json.write-api.html" class="wiki_link">json.write</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="prxml-api.html" class="wiki_link">prxml</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-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-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="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>
@@ -90,32 +90,14 @@ namespace.
</div>
<div id="content-tag"><h1 id="overview">API for <span id="namespace-name">java-utils</span>
<span id="branch-name">(1.1.x branch)</span></h1>
-by <span id="author">Stuart Halloway, Stephen C. Gilardi, Shawn Hoover, Perry Trolard, Stuart Sierra</span><br />
+by <span id="author">Unknown</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>
+<pre id="namespace-docstr"></pre>
<br />
@@ -131,7 +113,7 @@ for clojure.contrib.java-utils/file, which you should prefer
in most cases.</pre>
-
+ <a href="http://github.com/richhickey/clojure-contrib/blob/cc4e2ec2bf558f059330ebc97a031d7806a1e364/src/clojure/contrib/java_utils.clj#L75" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -143,7 +125,7 @@ in most cases.</pre>
Uses as-str to convert both keys and values into strings.</pre>
-
+ <a href="http://github.com/richhickey/clojure-contrib/blob/cc4e2ec2bf558f059330ebc97a031d7806a1e364/src/clojure/contrib/java_utils.clj#L152" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -168,7 +150,7 @@ Example:
(as-str {:foo :bar}) ;;=&gt; "{:foo :bar}" </pre>
-
+ <a href="http://github.com/richhickey/clojure-contrib/blob/cc4e2ec2bf558f059330ebc97a031d7806a1e364/src/clojure/contrib/java_utils.clj#L92" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -179,7 +161,7 @@ Example:
<pre id="var-docstr">Coerces argument (URL, URI, or String) to a java.net.URL.</pre>
-
+ <a href="http://github.com/richhickey/clojure-contrib/blob/cc4e2ec2bf558f059330ebc97a031d7806a1e364/src/clojure/contrib/java_utils.clj#L195" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -190,7 +172,7 @@ Example:
<pre id="var-docstr">Delete file f. Raise an exception if it fails unless silently is true.</pre>
-
+ <a href="http://github.com/richhickey/clojure-contrib/blob/cc4e2ec2bf558f059330ebc97a031d7806a1e364/src/clojure/contrib/java_utils.clj#L178" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -202,7 +184,7 @@ Example:
Raise an exception if any deletion fails unless silently is true.</pre>
-
+ <a href="http://github.com/richhickey/clojure-contrib/blob/cc4e2ec2bf558f059330ebc97a031d7806a1e364/src/clojure/contrib/java_utils.clj#L185" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -215,7 +197,7 @@ Raise an exception if any deletion fails unless silently is true.</pre>
<pre id="var-docstr">Returns a java.io.File from string or file args.</pre>
-
+ <a href="http://github.com/richhickey/clojure-contrib/blob/cc4e2ec2bf558f059330ebc97a031d7806a1e364/src/clojure/contrib/java_utils.clj#L83" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -227,7 +209,7 @@ Raise an exception if any deletion fails unless silently is true.</pre>
<pre id="var-docstr">Get a system property.</pre>
-
+ <a href="http://github.com/richhickey/clojure-contrib/blob/cc4e2ec2bf558f059330ebc97a031d7806a1e364/src/clojure/contrib/java_utils.clj#L117" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -238,7 +220,7 @@ Raise an exception if any deletion fails unless silently is true.</pre>
<pre id="var-docstr">Read properties from file-able.</pre>
-
+ <a href="http://github.com/richhickey/clojure-contrib/blob/cc4e2ec2bf558f059330ebc97a031d7806a1e364/src/clojure/contrib/java_utils.clj#L162" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -249,7 +231,7 @@ Raise an exception if any deletion fails unless silently is true.</pre>
Building block for clojure.contrib.java-utils/file.</pre>
-
+ <a href="http://github.com/richhickey/clojure-contrib/blob/cc4e2ec2bf558f059330ebc97a031d7806a1e364/src/clojure/contrib/java_utils.clj#L62" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -260,7 +242,7 @@ Building block for clojure.contrib.java-utils/file.</pre>
<pre id="var-docstr">Set some system properties. Nil clears a property.</pre>
-
+ <a href="http://github.com/richhickey/clojure-contrib/blob/cc4e2ec2bf558f059330ebc97a031d7806a1e364/src/clojure/contrib/java_utils.clj#L124" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -271,7 +253,7 @@ Building block for clojure.contrib.java-utils/file.</pre>
<pre id="var-docstr">Access to private or protected field.</pre>
-
+ <a href="http://github.com/richhickey/clojure-contrib/blob/cc4e2ec2bf558f059330ebc97a031d7806a1e364/src/clojure/contrib/java_utils.clj#L218" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -285,7 +267,7 @@ obj is nil for static methods, the instance object otherwise
the method name is given as a symbol or a keyword (something Named)</pre>
-
+ <a href="http://github.com/richhickey/clojure-contrib/blob/cc4e2ec2bf558f059330ebc97a031d7806a1e364/src/clojure/contrib/java_utils.clj#L208" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -300,7 +282,7 @@ sets the properties back to their original values. Values of nil are
translated to a clearing of the property.</pre>
-
+ <a href="http://github.com/richhickey/clojure-contrib/blob/cc4e2ec2bf558f059330ebc97a031d7806a1e364/src/clojure/contrib/java_utils.clj#L132" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -312,7 +294,7 @@ translated to a clearing of the property.</pre>
<pre id="var-docstr">Write properties to file-able.</pre>
-
+ <a href="http://github.com/richhickey/clojure-contrib/blob/cc4e2ec2bf558f059330ebc97a031d7806a1e364/src/clojure/contrib/java_utils.clj#L169" id="var-source">Source</a>
</div>