diff options
author | Tom Faulhaber <git_net@infolace.com> | 2009-10-28 18:58:19 -0700 |
---|---|---|
committer | Tom Faulhaber <git_net@infolace.com> | 2009-10-28 18:58:19 -0700 |
commit | 21b552e0dc6632268c93f7657343cfc00e75a751 (patch) | |
tree | 06531f87edfc0f54710b11d2af3177cd6483b68e | |
parent | 156edc8d9a13d38a3cb9620449e057b793d10c33 (diff) |
Updated documentation for commit 8eef617aac7b077421d4aa9c84a2df189af6ee17
-rw-r--r-- | api-index.html | 2 | ||||
-rw-r--r-- | api-index.json | 42 | ||||
-rw-r--r-- | index.html | 2 | ||||
-rw-r--r-- | java-utils-api.html | 45 |
4 files changed, 67 insertions, 24 deletions
diff --git a/api-index.html b/api-index.html index 81ddec3c..383e8ce2 100644 --- a/api-index.html +++ b/api-index.html @@ -218,6 +218,8 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="def-api.html#defunbound-">defunbound-</a><span id="line-content"> macro def Same as defunbound but yields a private definition. </span></span><span id="section-content"> <a href="def-api.html#defvar">defvar</a><span id="line-content"> macro def Defines a var with an optional intializer and doc ... </span></span><span id="section-content"> <a href="def-api.html#defvar-">defvar-</a><span id="line-content"> macro def Same as defvar but yields a private definition. +</span></span><span id="section-content"> <a href="java-utils-api.html#delete-file">delete-file</a><span id="line-content"> function java-utils Delete file f. Raise an exception if it fails unle... +</span></span><span id="section-content"> <a href="java-utils-api.html#delete-file-recursively">delete-file-recursively</a><span id="line-content"> function java-utils Delete file f. If it's a directory, recursively de... </span></span><span id="section-content"> <a href="sql-api.html#delete-rows">delete-rows</a><span id="line-content"> function sql Deletes rows from a table. where-params is a vecto... </span></span><span id="section-content"> <a href="graph-api.html#dependency-list">dependency-list</a><span id="line-content"> function graph Similar to a topological sort, this returns a vect... </span></span><span id="section-content"> <a href="zip-filter-api.html#descendants">descendants</a><span id="line-content"> function zip-filter Returns a lazy sequence of all descendants of loca... diff --git a/api-index.json b/api-index.json index e36e1e46..c3c6d307 100644 --- a/api-index.json +++ b/api-index.json @@ -244,7 +244,7 @@ "author":"Stuart Sierra", "doc":"Utilities for working with Java JAR files"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/6b763062af9568c1b069d5f86c8d5481a3fdfeea/src/clojure/contrib/java_utils.clj", + "http://github.com/richhickey/clojure-contrib/blob/8eef617aac7b077421d4aa9c84a2df189af6ee17/src/clojure/contrib/java_utils.clj", "wiki-url": "http://richhickey.github.com/clojure-contrib/java-utils-api.html", "name":"clojure.contrib.java-utils", @@ -2545,7 +2545,7 @@ "Returns true if file is a normal file with a .jar or .JAR extension.", "name":"jar-file?"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/6b763062af9568c1b069d5f86c8d5481a3fdfeea/src/clojure/contrib/java_utils.clj#L75", + "http://github.com/richhickey/clojure-contrib/blob/8eef617aac7b077421d4aa9c84a2df189af6ee17/src/clojure/contrib/java_utils.clj#L75", "wiki-url": "http://richhickey.github.com/clojure-contrib//java-utils-api.html#java-utils/as-file", "namespace":"clojure.contrib.java-utils", @@ -2553,7 +2553,7 @@ "Interpret a String or a java.io.File as a File. Building block\nfor clojure.contrib.java-utils/file, which you should prefer\nin most cases.", "name":"as-file"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/6b763062af9568c1b069d5f86c8d5481a3fdfeea/src/clojure/contrib/java_utils.clj#L152", + "http://github.com/richhickey/clojure-contrib/blob/8eef617aac7b077421d4aa9c84a2df189af6ee17/src/clojure/contrib/java_utils.clj#L152", "wiki-url": "http://richhickey.github.com/clojure-contrib//java-utils-api.html#java-utils/as-properties", "namespace":"clojure.contrib.java-utils", @@ -2562,7 +2562,7 @@ "Convert any seq of pairs to a java.utils.Properties instance.\nUses as-str to convert both keys and values into strings.", "name":"as-properties"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/6b763062af9568c1b069d5f86c8d5481a3fdfeea/src/clojure/contrib/java_utils.clj#L92", + "http://github.com/richhickey/clojure-contrib/blob/8eef617aac7b077421d4aa9c84a2df189af6ee17/src/clojure/contrib/java_utils.clj#L92", "wiki-url": "http://richhickey.github.com/clojure-contrib//java-utils-api.html#java-utils/as-str", "namespace":"clojure.contrib.java-utils", @@ -2571,7 +2571,7 @@ "Like clojure.core/str, but if an argument is a keyword or symbol,\nits name will be used instead of its literal representation.\n\nExample:\n (str :foo :bar) ;;=> \":foo:bar\"\n (as-str :foo :bar) ;;=> \"foobar\" \n\nNote that this does not apply to keywords or symbols nested within\ndata structures; they will be rendered as with str.\n\nExample:\n (str {:foo :bar}) ;;=> \"{:foo :bar}\"\n (as-str {:foo :bar}) ;;=> \"{:foo :bar}\" ", "name":"as-str"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/6b763062af9568c1b069d5f86c8d5481a3fdfeea/src/clojure/contrib/java_utils.clj#L178", + "http://github.com/richhickey/clojure-contrib/blob/8eef617aac7b077421d4aa9c84a2df189af6ee17/src/clojure/contrib/java_utils.clj#L195", "wiki-url": "http://richhickey.github.com/clojure-contrib//java-utils-api.html#java-utils/as-url", "namespace":"clojure.contrib.java-utils", @@ -2579,7 +2579,25 @@ "doc":"Coerces argument (URL, URI, or String) to a java.net.URL.", "name":"as-url"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/6b763062af9568c1b069d5f86c8d5481a3fdfeea/src/clojure/contrib/java_utils.clj#L83", + "http://github.com/richhickey/clojure-contrib/blob/8eef617aac7b077421d4aa9c84a2df189af6ee17/src/clojure/contrib/java_utils.clj#L178", + "wiki-url": + "http://richhickey.github.com/clojure-contrib//java-utils-api.html#java-utils/delete-file", + "namespace":"clojure.contrib.java-utils", + "arglists":[["f", "&", ["silently"]]], + "doc": + "Delete file f. Raise an exception if it fails unless silently is true.", + "name":"delete-file"}, + {"source-url": + "http://github.com/richhickey/clojure-contrib/blob/8eef617aac7b077421d4aa9c84a2df189af6ee17/src/clojure/contrib/java_utils.clj#L185", + "wiki-url": + "http://richhickey.github.com/clojure-contrib//java-utils-api.html#java-utils/delete-file-recursively", + "namespace":"clojure.contrib.java-utils", + "arglists":[["f", "&", ["silently"]]], + "doc": + "Delete file f. If it's a directory, recursively delete all its contents.\nRaise an exception if any deletion fails unless silently is true.", + "name":"delete-file-recursively"}, + {"source-url": + "http://github.com/richhickey/clojure-contrib/blob/8eef617aac7b077421d4aa9c84a2df189af6ee17/src/clojure/contrib/java_utils.clj#L83", "wiki-url": "http://richhickey.github.com/clojure-contrib//java-utils-api.html#java-utils/file", "namespace":"clojure.contrib.java-utils", @@ -2588,7 +2606,7 @@ "doc":"Returns a java.io.File from string or file args.", "name":"file"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/6b763062af9568c1b069d5f86c8d5481a3fdfeea/src/clojure/contrib/java_utils.clj#L117", + "http://github.com/richhickey/clojure-contrib/blob/8eef617aac7b077421d4aa9c84a2df189af6ee17/src/clojure/contrib/java_utils.clj#L117", "wiki-url": "http://richhickey.github.com/clojure-contrib//java-utils-api.html#java-utils/get-system-property", "namespace":"clojure.contrib.java-utils", @@ -2596,7 +2614,7 @@ "doc":"Get a system property.", "name":"get-system-property"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/6b763062af9568c1b069d5f86c8d5481a3fdfeea/src/clojure/contrib/java_utils.clj#L162", + "http://github.com/richhickey/clojure-contrib/blob/8eef617aac7b077421d4aa9c84a2df189af6ee17/src/clojure/contrib/java_utils.clj#L162", "wiki-url": "http://richhickey.github.com/clojure-contrib//java-utils-api.html#java-utils/read-properties", "namespace":"clojure.contrib.java-utils", @@ -2604,7 +2622,7 @@ "doc":"Read properties from file-able.", "name":"read-properties"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/6b763062af9568c1b069d5f86c8d5481a3fdfeea/src/clojure/contrib/java_utils.clj#L62", + "http://github.com/richhickey/clojure-contrib/blob/8eef617aac7b077421d4aa9c84a2df189af6ee17/src/clojure/contrib/java_utils.clj#L62", "wiki-url": "http://richhickey.github.com/clojure-contrib//java-utils-api.html#java-utils/relative-path-string", "namespace":"clojure.contrib.java-utils", @@ -2612,7 +2630,7 @@ "Interpret a String or java.io.File as a relative path string. \nBuilding block for clojure.contrib.java-utils/file.", "name":"relative-path-string"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/6b763062af9568c1b069d5f86c8d5481a3fdfeea/src/clojure/contrib/java_utils.clj#L124", + "http://github.com/richhickey/clojure-contrib/blob/8eef617aac7b077421d4aa9c84a2df189af6ee17/src/clojure/contrib/java_utils.clj#L124", "wiki-url": "http://richhickey.github.com/clojure-contrib//java-utils-api.html#java-utils/set-system-properties", "namespace":"clojure.contrib.java-utils", @@ -2620,7 +2638,7 @@ "doc":"Set some system properties. Nil clears a property.", "name":"set-system-properties"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/6b763062af9568c1b069d5f86c8d5481a3fdfeea/src/clojure/contrib/java_utils.clj#L132", + "http://github.com/richhickey/clojure-contrib/blob/8eef617aac7b077421d4aa9c84a2df189af6ee17/src/clojure/contrib/java_utils.clj#L132", "wiki-url": "http://richhickey.github.com/clojure-contrib//java-utils-api.html#java-utils/with-system-properties", "namespace":"clojure.contrib.java-utils", @@ -2629,7 +2647,7 @@ "setting => property-name value\n\nSets the system properties to the supplied values, executes the body, and\nsets the properties back to their original values. Values of nil are\ntranslated to a clearing of the property.", "name":"with-system-properties"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/6b763062af9568c1b069d5f86c8d5481a3fdfeea/src/clojure/contrib/java_utils.clj#L169", + "http://github.com/richhickey/clojure-contrib/blob/8eef617aac7b077421d4aa9c84a2df189af6ee17/src/clojure/contrib/java_utils.clj#L169", "wiki-url": "http://richhickey.github.com/clojure-contrib//java-utils-api.html#java-utils/write-properties", "namespace":"clojure.contrib.java-utils", @@ -1050,7 +1050,7 @@ And you could write the response directly to a file like this: <pre id="namespace-docstr"></pre> Public variables and functions: - <span id="var-link"><a href="java-utils-api.html#java-utils/as-file" id="var-tag">as-file</a> </span><span id="var-link"><a href="java-utils-api.html#java-utils/as-properties" id="var-tag">as-properties</a> </span><span id="var-link"><a href="java-utils-api.html#java-utils/as-str" id="var-tag">as-str</a> </span><span id="var-link"><a href="java-utils-api.html#java-utils/as-url" id="var-tag">as-url</a> </span><span id="var-link"><a href="java-utils-api.html#java-utils/file" id="var-tag">file</a> </span><span id="var-link"><a href="java-utils-api.html#java-utils/get-system-property" id="var-tag">get-system-property</a> </span><span id="var-link"><a href="java-utils-api.html#java-utils/read-properties" id="var-tag">read-properties</a> </span><span id="var-link"><a href="java-utils-api.html#java-utils/relative-path-string" id="var-tag">relative-path-string</a> </span><span id="var-link"><a href="java-utils-api.html#java-utils/set-system-properties" id="var-tag">set-system-properties</a> </span><span id="var-link"><a href="java-utils-api.html#java-utils/with-system-properties" id="var-tag">with-system-properties</a> </span><span id="var-link"><a href="java-utils-api.html#java-utils/write-properties" id="var-tag">write-properties</a> </span><br /> + <span id="var-link"><a href="java-utils-api.html#java-utils/as-file" id="var-tag">as-file</a> </span><span id="var-link"><a href="java-utils-api.html#java-utils/as-properties" id="var-tag">as-properties</a> </span><span id="var-link"><a href="java-utils-api.html#java-utils/as-str" id="var-tag">as-str</a> </span><span id="var-link"><a href="java-utils-api.html#java-utils/as-url" id="var-tag">as-url</a> </span><span id="var-link"><a href="java-utils-api.html#java-utils/delete-file" id="var-tag">delete-file</a> </span><span id="var-link"><a href="java-utils-api.html#java-utils/delete-file-recursively" id="var-tag">delete-file-recursively</a> </span><span id="var-link"><a href="java-utils-api.html#java-utils/file" id="var-tag">file</a> </span><span id="var-link"><a href="java-utils-api.html#java-utils/get-system-property" id="var-tag">get-system-property</a> </span><span id="var-link"><a href="java-utils-api.html#java-utils/read-properties" id="var-tag">read-properties</a> </span><span id="var-link"><a href="java-utils-api.html#java-utils/relative-path-string" id="var-tag">relative-path-string</a> </span><span id="var-link"><a href="java-utils-api.html#java-utils/set-system-properties" id="var-tag">set-system-properties</a> </span><span id="var-link"><a href="java-utils-api.html#java-utils/with-system-properties" id="var-tag">with-system-properties</a> </span><span id="var-link"><a href="java-utils-api.html#java-utils/write-properties" id="var-tag">write-properties</a> </span><br /> </div><div id="namespace-entry"> <br /> diff --git a/java-utils-api.html b/java-utils-api.html index b1cd54be..e475edff 100644 --- a/java-utils-api.html +++ b/java-utils-api.html @@ -56,6 +56,10 @@ namespace. </div><div style="margin-left: 1em;" class="toc-entry"> <a href="#java-utils/as-url">as-url</a> </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#java-utils/delete-file">delete-file</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#java-utils/delete-file-recursively">delete-file-recursively</a> + </div><div style="margin-left: 1em;" class="toc-entry"> <a href="#java-utils/file">file</a> </div><div style="margin-left: 1em;" class="toc-entry"> <a href="#java-utils/get-system-property">get-system-property</a> @@ -94,7 +98,7 @@ by <span id="author">Unknown</span><br /> <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> - <a href="http://github.com/richhickey/clojure-contrib/blob/6b763062af9568c1b069d5f86c8d5481a3fdfeea/src/clojure/contrib/java_utils.clj#L75" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/8eef617aac7b077421d4aa9c84a2df189af6ee17/src/clojure/contrib/java_utils.clj#L75" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -104,7 +108,7 @@ in most cases.</pre> </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> - <a href="http://github.com/richhickey/clojure-contrib/blob/6b763062af9568c1b069d5f86c8d5481a3fdfeea/src/clojure/contrib/java_utils.clj#L152" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/8eef617aac7b077421d4aa9c84a2df189af6ee17/src/clojure/contrib/java_utils.clj#L152" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -127,7 +131,7 @@ data structures; they will be rendered as with str. Example: (str {:foo :bar}) ;;=> "{:foo :bar}" (as-str {:foo :bar}) ;;=> "{:foo :bar}" </pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/6b763062af9568c1b069d5f86c8d5481a3fdfeea/src/clojure/contrib/java_utils.clj#L92" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/8eef617aac7b077421d4aa9c84a2df189af6ee17/src/clojure/contrib/java_utils.clj#L92" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -136,7 +140,26 @@ Example: <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> - <a href="http://github.com/richhickey/clojure-contrib/blob/6b763062af9568c1b069d5f86c8d5481a3fdfeea/src/clojure/contrib/java_utils.clj#L178" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/8eef617aac7b077421d4aa9c84a2df189af6ee17/src/clojure/contrib/java_utils.clj#L195" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="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> + <a href="http://github.com/richhickey/clojure-contrib/blob/8eef617aac7b077421d4aa9c84a2df189af6ee17/src/clojure/contrib/java_utils.clj#L178" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="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> + <a href="http://github.com/richhickey/clojure-contrib/blob/8eef617aac7b077421d4aa9c84a2df189af6ee17/src/clojure/contrib/java_utils.clj#L185" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -147,7 +170,7 @@ Example: (file parent child & more) </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/6b763062af9568c1b069d5f86c8d5481a3fdfeea/src/clojure/contrib/java_utils.clj#L83" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/8eef617aac7b077421d4aa9c84a2df189af6ee17/src/clojure/contrib/java_utils.clj#L83" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -157,7 +180,7 @@ Example: (get-system-property stringable default) </pre> <pre id="var-docstr">Get a system property.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/6b763062af9568c1b069d5f86c8d5481a3fdfeea/src/clojure/contrib/java_utils.clj#L117" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/8eef617aac7b077421d4aa9c84a2df189af6ee17/src/clojure/contrib/java_utils.clj#L117" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -166,7 +189,7 @@ Example: <pre id="var-usage">Usage: (read-properties file-able) </pre> <pre id="var-docstr">Read properties from file-able.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/6b763062af9568c1b069d5f86c8d5481a3fdfeea/src/clojure/contrib/java_utils.clj#L162" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/8eef617aac7b077421d4aa9c84a2df189af6ee17/src/clojure/contrib/java_utils.clj#L162" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -175,7 +198,7 @@ Example: <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> - <a href="http://github.com/richhickey/clojure-contrib/blob/6b763062af9568c1b069d5f86c8d5481a3fdfeea/src/clojure/contrib/java_utils.clj#L62" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/8eef617aac7b077421d4aa9c84a2df189af6ee17/src/clojure/contrib/java_utils.clj#L62" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -184,7 +207,7 @@ Building block for clojure.contrib.java-utils/file.</pre> <pre id="var-usage">Usage: (set-system-properties settings) </pre> <pre id="var-docstr">Set some system properties. Nil clears a property.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/6b763062af9568c1b069d5f86c8d5481a3fdfeea/src/clojure/contrib/java_utils.clj#L124" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/8eef617aac7b077421d4aa9c84a2df189af6ee17/src/clojure/contrib/java_utils.clj#L124" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -197,7 +220,7 @@ Building block for clojure.contrib.java-utils/file.</pre> 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> - <a href="http://github.com/richhickey/clojure-contrib/blob/6b763062af9568c1b069d5f86c8d5481a3fdfeea/src/clojure/contrib/java_utils.clj#L132" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/8eef617aac7b077421d4aa9c84a2df189af6ee17/src/clojure/contrib/java_utils.clj#L132" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -207,7 +230,7 @@ translated to a clearing of the property.</pre> (write-properties m file-able comments) </pre> <pre id="var-docstr">Write properties to file-able.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/6b763062af9568c1b069d5f86c8d5481a3fdfeea/src/clojure/contrib/java_utils.clj#L169" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/8eef617aac7b077421d4aa9c84a2df189af6ee17/src/clojure/contrib/java_utils.clj#L169" id="var-source">Source</a> </div> |