From e61d6780abaff6a750f56a75d6d68ebace0181df Mon Sep 17 00:00:00 2001 From: Tom Faulhaber Date: Fri, 7 Aug 2009 23:37:28 -0700 Subject: Updated documentation for commit 6dd2205627cd524894b1175da20ce9c5ac65aef7 --- java-utils-api.html | 46 ++++++++++++++-------------------------------- 1 file changed, 14 insertions(+), 32 deletions(-) (limited to 'java-utils-api.html') diff --git a/java-utils-api.html b/java-utils-api.html index 24a6a8e8..8df8d0d7 100644 --- a/java-utils-api.html +++ b/java-utils-api.html @@ -34,7 +34,7 @@ namespace. API Index
Namespaces: @@ -83,32 +83,14 @@ namespace.

API for java-utils

-by Stuart Halloway, Stephen C. Gilardi, Shawn Hoover, Perry Trolard, Stuart Sierra
+by Unknown

Usage: 
 (ns your-namespace
   (:require clojure.contrib.java-utils))

Overview

-
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.
+

 

 
Public Variables and Functions

 

@@ -119,7 +101,7 @@ let me (Stu) and the Clojure community know via the mailing list.
   
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.

-  Source
+  Source
 

   

   
as-properties

@@ -128,7 +110,7 @@ in most cases.
 
   
Convert any seq of pairs to a java.utils.Properties instance.
 Uses as-str to convert both keys and values into strings.

-  Source
+  Source
 

   

   
as-str

@@ -136,7 +118,7 @@ Uses as-str to convert both keys and values into strings.
   
Usage: (as-str x)
 

   
Returns the name or string representation of x

-  Source
+  Source
 

   

   
as-url

@@ -144,7 +126,7 @@ Uses as-str to convert both keys and values into strings.
   
Usage: (as-url arg)
 

   
Coerces argument (URL, URI, or String) to a java.net.URL.

-  Source
+  Source
 

   

   
file

@@ -154,7 +136,7 @@ Uses as-str to convert both keys and values into strings.
        (file parent child & more)
 
   
Returns a java.io.File from string or file args.

-  Source
+  Source
 

   

   
get-system-property

@@ -163,7 +145,7 @@ Uses as-str to convert both keys and values into strings.
        (get-system-property stringable default)
 
   
Get a system property.

-  Source
+  Source
 

   

   
read-properties

@@ -171,7 +153,7 @@ Uses as-str to convert both keys and values into strings.
   
Usage: (read-properties file-able)
 

   
Read properties from file-able.

-  Source
+  Source
 

   

   
relative-path-string

@@ -179,7 +161,7 @@ Uses as-str to convert both keys and values into strings.
   
No usage documentation available

   
Interpret a String or java.io.File as a relative path string. 
 Building block for clojure.contrib.java-utils/file.

-  Source
+  Source
 

   

   
set-system-properties

@@ -187,7 +169,7 @@ Building block for clojure.contrib.java-utils/file.
   
Usage: (set-system-properties settings)
 

   
Set some system properties. Nil clears a property.

-  Source
+  Source
 

   

   
with-system-properties

@@ -199,7 +181,7 @@ Building block for clojure.contrib.java-utils/file.
 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.
-  Source
+  Source
 

   

   
write-properties

@@ -208,7 +190,7 @@ translated to a clearing of the property.
        (write-properties m file-able comments)
 
   
Write properties to file-able.

-  Source
+  Source
 

 
 
-- 
cgit v1.2.3-70-g09d2