diff options
author | Tom Faulhaber <git_net@infolace.com> | 2009-08-15 07:38:37 -0700 |
---|---|---|
committer | Tom Faulhaber <git_net@infolace.com> | 2009-08-15 07:38:37 -0700 |
commit | 488cda8862d3394ee6f0219dfdda6d8375b7d240 (patch) | |
tree | f4b8ca3c6bc26e3c57dba91f1ca11fac1c971acc | |
parent | 14b98e36c3a8b110e5aee897f3d4a5b6b427c244 (diff) |
Updated documentation for commit d596fee7fbe2f428a34ebecbaaf9451e215d5bdf
-rw-r--r-- | api-index.html | 4 | ||||
-rw-r--r-- | api-index.json | 34 | ||||
-rw-r--r-- | jmx-api.html | 34 |
3 files changed, 38 insertions, 34 deletions
diff --git a/api-index.html b/api-index.html index 4e0a11fd..3dfdd9f2 100644 --- a/api-index.html +++ b/api-index.html @@ -106,7 +106,7 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="duck-streams-api.html#append-writer">append-writer</a><span id="line-content"> function duck-streams Like writer but opens file for appending. Does no... </span></span><span id="section-content"> <a href="generic.math-functions-api.html#approx=">approx=</a><span id="line-content"> function generic.math-functions Return true if the absolute value of the diffe... </span></span><span id="section-content"> <a href="java-utils-api.html#as-file">as-file</a><span id="line-content"> multimethod java-utils Interpret a String or a java.io.File as a File. Bu... -</span></span><span id="section-content"> <a href="jmx-api.html#as-object-name">as-object-name</a><span id="line-content"> multimethod jmx Interpret an object as a JMX ObjectName. +</span></span><span id="section-content"> <a href="jmx-api.html#as-object-name">as-object-name</a><span id="line-content"> multimethod jmx Interpret an object as a JMX ObjectName.. </span></span><span id="section-content"> <a href="java-utils-api.html#as-properties">as-properties</a><span id="line-content"> function java-utils Convert any seq of pairs to a java.utils.Propertie... </span></span><span id="section-content"> <a href="java-utils-api.html#as-str">as-str</a><span id="line-content"> function java-utils Returns the name or string representation of x. </span></span><span id="section-content"> <a href="java-utils-api.html#as-url">as-url</a><span id="line-content"> multimethod java-utils Coerces argument (URL, URI, or String) to a java.n... @@ -362,7 +362,7 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="jar-api.html#jar-file?">jar-file?</a><span id="line-content"> function jar Returns true if file is a normal file with a .jar ... </span></span><span id="section-content"> <a href="logging-api.html#java-logging">java-logging</a><span id="line-content"> macro logging Creates a log-system struct using the java.util.lo... </span></span><span id="section-content"> <a href="repl-utils-api.html#javadoc">javadoc</a><span id="line-content"> function repl-utils Opens a browser window displaying the javadoc for ... -</span></span><span id="section-content"> <a href="jmx-api.html#jmx->clj">jmx->clj</a><span id="line-content"> multimethod jmx Coerce JMX data structures into Clojure data. +</span></span><span id="section-content"> <a href="jmx-api.html#jmx->clj">jmx->clj</a><span id="line-content"> multimethod jmx Coerce JMX data structures into Clojure data. Hand... </span></span><span id="section-content"> <a href="jmx-api.html#jmx-url">jmx-url</a><span id="line-content"> function jmx Build a JMX URL from options.. </span></span><span id="section-content"> <a href="str-utils2-api.html#join">join</a><span id="line-content"> function str-utils2 Returns a string of all elements in coll, separate... </span></span><span id="section-content"> <a href="probabilities.finite-distributions-api.html#join-with">join-with</a><span id="line-content"> function probabilities.finite-distributions Returns the distribution of (f x y... diff --git a/api-index.json b/api-index.json index a226028e..94960722 100644 --- a/api-index.json +++ b/api-index.json @@ -242,7 +242,7 @@ "author":"Christophe Grand", "doc":"Start a web browser from Clojure"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx.clj", + "http://github.com/richhickey/clojure-contrib/blob/d596fee7fbe2f428a34ebecbaaf9451e215d5bdf/src/clojure/contrib/jmx.clj", "wiki-url": "http://richhickey.github.com/clojure-contrib/jmx-api.html", "name":"clojure.contrib.jmx", @@ -2543,7 +2543,7 @@ "doc":"Opens url (a string) in a Swing window.", "name":"open-url-in-swing"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx.clj#L86", + "http://github.com/richhickey/clojure-contrib/blob/d596fee7fbe2f428a34ebecbaaf9451e215d5bdf/src/clojure/contrib/jmx.clj#L83", "wiki-url": "http://richhickey.github.com/clojure-contrib//jmx-api.html#jmx/*connection*", "namespace":"clojure.contrib.jmx", @@ -2551,11 +2551,12 @@ "The connection to be used for JMX ops. Defaults to the local process.", "name":"*connection*"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx/data.clj#L26", + "http://github.com/richhickey/clojure-contrib/blob/d596fee7fbe2f428a34ebecbaaf9451e215d5bdf/src/clojure/contrib/jmx/data.clj#L26", "wiki-url": "http://richhickey.github.com/clojure-contrib//jmx-api.html#jmx/as-object-name", "namespace":"clojure.contrib.jmx", - "doc":"Interpret an object as a JMX ObjectName", + "arglists":[["string-or-name"]], + "doc":"Interpret an object as a JMX ObjectName.", "name":"as-object-name"}, {"source-url": "http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx/client.clj#L69", @@ -2566,7 +2567,7 @@ "doc":"Get the MBeanAttributeInfo for an attribute", "name":"attribute-info"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx.clj#L98", + "http://github.com/richhickey/clojure-contrib/blob/d596fee7fbe2f428a34ebecbaaf9451e215d5bdf/src/clojure/contrib/jmx.clj#L95", "wiki-url": "http://richhickey.github.com/clojure-contrib//jmx-api.html#jmx/attribute-names", "namespace":"clojure.contrib.jmx", @@ -2574,7 +2575,7 @@ "doc":"All attribute names available on an MBean.", "name":"attribute-names"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx/data.clj#L88", + "http://github.com/richhickey/clojure-contrib/blob/d596fee7fbe2f428a34ebecbaaf9451e215d5bdf/src/clojure/contrib/jmx/data.clj#L91", "wiki-url": "http://richhickey.github.com/clojure-contrib//jmx-api.html#jmx/build-attribute-info", "namespace":"clojure.contrib.jmx", @@ -2585,7 +2586,7 @@ "Construct an MBeanAttributeInfo. Normally called with a key/value pair from a Clojure map.", "name":"build-attribute-info"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx/data.clj#L82", + "http://github.com/richhickey/clojure-contrib/blob/d596fee7fbe2f428a34ebecbaaf9451e215d5bdf/src/clojure/contrib/jmx/data.clj#L85", "wiki-url": "http://richhickey.github.com/clojure-contrib//jmx-api.html#jmx/guess-attribute-typename", "namespace":"clojure.contrib.jmx", @@ -2594,14 +2595,15 @@ "Guess the attribute typename for MBeanAttributeInfo based on the attribute value.", "name":"guess-attribute-typename"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx/data.clj#L63", + "http://github.com/richhickey/clojure-contrib/blob/d596fee7fbe2f428a34ebecbaaf9451e215d5bdf/src/clojure/contrib/jmx/data.clj#L64", "wiki-url": "http://richhickey.github.com/clojure-contrib//jmx-api.html#jmx/jmx->clj", "namespace":"clojure.contrib.jmx", - "doc":"Coerce JMX data structures into Clojure data", + "doc": + "Coerce JMX data structures into Clojure data.\nHandles CompositeData, TabularData, maps, and atoms.", "name":"jmx->clj"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx/data.clj#L19", + "http://github.com/richhickey/clojure-contrib/blob/d596fee7fbe2f428a34ebecbaaf9451e215d5bdf/src/clojure/contrib/jmx/data.clj#L19", "wiki-url": "http://richhickey.github.com/clojure-contrib//jmx-api.html#jmx/jmx-url", "namespace":"clojure.contrib.jmx", @@ -2609,7 +2611,7 @@ "doc":"Build a JMX URL from options.", "name":"jmx-url"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx/data.clj#L97", + "http://github.com/richhickey/clojure-contrib/blob/d596fee7fbe2f428a34ebecbaaf9451e215d5bdf/src/clojure/contrib/jmx/data.clj#L100", "wiki-url": "http://richhickey.github.com/clojure-contrib//jmx-api.html#jmx/map->attribute-infos", "namespace":"clojure.contrib.jmx", @@ -2618,7 +2620,7 @@ "Construct an MBeanAttributeInfo[] from a Clojure associative.", "name":"map->attribute-infos"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx/data.clj#L43", + "http://github.com/richhickey/clojure-contrib/blob/d596fee7fbe2f428a34ebecbaaf9451e215d5bdf/src/clojure/contrib/jmx/data.clj#L44", "wiki-url": "http://richhickey.github.com/clojure-contrib//jmx-api.html#jmx/maybe-atomize", "namespace":"clojure.contrib.jmx", @@ -2627,7 +2629,7 @@ "Convert a list of length 1 into its contents, leaving other things alone.\nUsed to simplify keys in the tabular data API.", "name":"maybe-atomize"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx/data.clj#L37", + "http://github.com/richhickey/clojure-contrib/blob/d596fee7fbe2f428a34ebecbaaf9451e215d5bdf/src/clojure/contrib/jmx/data.clj#L38", "wiki-url": "http://richhickey.github.com/clojure-contrib//jmx-api.html#jmx/maybe-keywordize", "namespace":"clojure.contrib.jmx", @@ -2636,7 +2638,7 @@ "Convert a string key to a keyword, leaving other types alone. Used to\nsimplify keys in the tabular data API.", "name":"maybe-keywordize"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx.clj#L117", + "http://github.com/richhickey/clojure-contrib/blob/d596fee7fbe2f428a34ebecbaaf9451e215d5bdf/src/clojure/contrib/jmx.clj#L114", "wiki-url": "http://richhickey.github.com/clojure-contrib//jmx-api.html#jmx/mbean", "namespace":"clojure.contrib.jmx", @@ -2645,7 +2647,7 @@ "Like clojure.core/bean, but for JMX beans. Returns a read-only map of\na JMX bean's attributes. If an attribute it not supported, value is\nset to the exception thrown.", "name":"mbean"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx.clj#L93", + "http://github.com/richhickey/clojure-contrib/blob/d596fee7fbe2f428a34ebecbaaf9451e215d5bdf/src/clojure/contrib/jmx.clj#L90", "wiki-url": "http://richhickey.github.com/clojure-contrib//jmx-api.html#jmx/mbean-names", "namespace":"clojure.contrib.jmx", @@ -2672,7 +2674,7 @@ "The MBeanOperationInfo for operation op on mbean n. Used for invoke.", "name":"operation"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx.clj#L104", + "http://github.com/richhickey/clojure-contrib/blob/d596fee7fbe2f428a34ebecbaaf9451e215d5bdf/src/clojure/contrib/jmx.clj#L101", "wiki-url": "http://richhickey.github.com/clojure-contrib//jmx-api.html#jmx/operation-names", "namespace":"clojure.contrib.jmx", diff --git a/jmx-api.html b/jmx-api.html index 393fc7bb..0a10ec7f 100644 --- a/jmx-api.html +++ b/jmx-api.html @@ -122,14 +122,15 @@ by <span id="author">Unknown</span><br /> <span id="var-type">var</span><br /> <pre id="var-usage"></pre> <pre id="var-docstr">The connection to be used for JMX ops. Defaults to the local process.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx.clj#L86" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/d596fee7fbe2f428a34ebecbaaf9451e215d5bdf/src/clojure/contrib/jmx.clj#L83" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="jmx/as-object-name">as-object-name</h2> <span id="var-type">multimethod</span><br /> - <pre id="var-usage">No usage documentation available</pre> - <pre id="var-docstr">Interpret an object as a JMX ObjectName</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx/data.clj#L26" id="var-source">Source</a> + <pre id="var-usage">Usage: (as-object-name string-or-name) +</pre> + <pre id="var-docstr">Interpret an object as a JMX ObjectName.</pre> + <a href="http://github.com/richhickey/clojure-contrib/blob/d596fee7fbe2f428a34ebecbaaf9451e215d5bdf/src/clojure/contrib/jmx/data.clj#L26" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="jmx/attribute-info">attribute-info</h2> @@ -145,7 +146,7 @@ by <span id="author">Unknown</span><br /> <pre id="var-usage">Usage: (attribute-names n) </pre> <pre id="var-docstr">All attribute names available on an MBean.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx.clj#L98" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/d596fee7fbe2f428a34ebecbaaf9451e215d5bdf/src/clojure/contrib/jmx.clj#L95" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="jmx/build-attribute-info">build-attribute-info</h2> @@ -154,7 +155,7 @@ by <span id="author">Unknown</span><br /> (build-attribute-info name type desc readable? writable? is?) </pre> <pre id="var-docstr">Construct an MBeanAttributeInfo. Normally called with a key/value pair from a Clojure map.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx/data.clj#L88" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/d596fee7fbe2f428a34ebecbaaf9451e215d5bdf/src/clojure/contrib/jmx/data.clj#L91" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="jmx/guess-attribute-typename">guess-attribute-typename</h2> @@ -162,14 +163,15 @@ by <span id="author">Unknown</span><br /> <pre id="var-usage">Usage: (guess-attribute-typename value) </pre> <pre id="var-docstr">Guess the attribute typename for MBeanAttributeInfo based on the attribute value.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx/data.clj#L82" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/d596fee7fbe2f428a34ebecbaaf9451e215d5bdf/src/clojure/contrib/jmx/data.clj#L85" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="jmx/jmx->clj">jmx->clj</h2> <span id="var-type">multimethod</span><br /> <pre id="var-usage">No usage documentation available</pre> - <pre id="var-docstr">Coerce JMX data structures into Clojure data</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx/data.clj#L63" id="var-source">Source</a> + <pre id="var-docstr">Coerce JMX data structures into Clojure data. +Handles CompositeData, TabularData, maps, and atoms.</pre> + <a href="http://github.com/richhickey/clojure-contrib/blob/d596fee7fbe2f428a34ebecbaaf9451e215d5bdf/src/clojure/contrib/jmx/data.clj#L64" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="jmx/jmx-url">jmx-url</h2> @@ -178,7 +180,7 @@ by <span id="author">Unknown</span><br /> (jmx-url overrides) </pre> <pre id="var-docstr">Build a JMX URL from options.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx/data.clj#L19" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/d596fee7fbe2f428a34ebecbaaf9451e215d5bdf/src/clojure/contrib/jmx/data.clj#L19" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="jmx/map->attribute-infos">map->attribute-infos</h2> @@ -186,7 +188,7 @@ by <span id="author">Unknown</span><br /> <pre id="var-usage">Usage: (map->attribute-infos attr-map) </pre> <pre id="var-docstr">Construct an MBeanAttributeInfo[] from a Clojure associative.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx/data.clj#L97" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/d596fee7fbe2f428a34ebecbaaf9451e215d5bdf/src/clojure/contrib/jmx/data.clj#L100" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="jmx/maybe-atomize">maybe-atomize</h2> @@ -195,7 +197,7 @@ by <span id="author">Unknown</span><br /> </pre> <pre id="var-docstr">Convert a list of length 1 into its contents, leaving other things alone. Used to simplify keys in the tabular data API.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx/data.clj#L43" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/d596fee7fbe2f428a34ebecbaaf9451e215d5bdf/src/clojure/contrib/jmx/data.clj#L44" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="jmx/maybe-keywordize">maybe-keywordize</h2> @@ -204,7 +206,7 @@ Used to simplify keys in the tabular data API.</pre> </pre> <pre id="var-docstr">Convert a string key to a keyword, leaving other types alone. Used to simplify keys in the tabular data API.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx/data.clj#L37" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/d596fee7fbe2f428a34ebecbaaf9451e215d5bdf/src/clojure/contrib/jmx/data.clj#L38" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="jmx/mbean">mbean</h2> @@ -214,7 +216,7 @@ simplify keys in the tabular data API.</pre> <pre id="var-docstr">Like clojure.core/bean, but for JMX beans. Returns a read-only map of a JMX bean's attributes. If an attribute it not supported, value is set to the exception thrown.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx.clj#L117" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/d596fee7fbe2f428a34ebecbaaf9451e215d5bdf/src/clojure/contrib/jmx.clj#L114" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="jmx/mbean-names">mbean-names</h2> @@ -222,7 +224,7 @@ set to the exception thrown.</pre> <pre id="var-usage">Usage: (mbean-names n) </pre> <pre id="var-docstr">Finds all MBeans matching a name on the current *connection*.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx.clj#L93" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/d596fee7fbe2f428a34ebecbaaf9451e215d5bdf/src/clojure/contrib/jmx.clj#L90" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="jmx/op-param-types">op-param-types</h2> @@ -246,7 +248,7 @@ set to the exception thrown.</pre> <pre id="var-usage">Usage: (operation-names n) </pre> <pre id="var-docstr">All operation names available on an MBean.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/f92114c9cce5e892765549cdb0df640dc3ab52a5/src/clojure/contrib/jmx.clj#L104" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/d596fee7fbe2f428a34ebecbaaf9451e215d5bdf/src/clojure/contrib/jmx.clj#L101" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="jmx/operations">operations</h2> |