orchard.java
Info for Java classes and members
Info for Java classes and members
add-classpath!clj
(add-classpath! url)Similar to the deprecated clojure.core/add-classpath, adds the URL to the
classpath and returns it if successful, or nil otherwise.
Similar to the deprecated `clojure.core/add-classpath`, adds the URL to the classpath and returns it if successful, or nil otherwise.
cache?clj
(cache? info)Whether to cache the class info; this will be true if the source file is effectively immutable, and false otherwise. Specifically, this returns true if no source file is available, or if the source file is in a jar/zip archive.
Whether to cache the class info; this will be true if the source file is effectively immutable, and false otherwise. Specifically, this returns true if no source file is available, or if the source file is in a jar/zip archive.
class-infoclj
(class-info class)For the class symbol, return (possibly cached) Java class and member info. Members are indexed first by name, and then by argument types to list all overloads.
For the class symbol, return (possibly cached) Java class and member info. Members are indexed first by name, and then by argument types to list all overloads.
class-info*clj
(class-info* class)For the class symbol, return Java class and member info. Members are indexed first by name, and then by argument types to list all overloads.
For the class symbol, return Java class and member info. Members are indexed first by name, and then by argument types to list all overloads.
javadoc-urlclj
(javadoc-url class)(javadoc-url class member argtypes)Return the relative .html javadoc path and member fragment.
Return the relative `.html` javadoc path and member fragment.
jdk-resource-urlclj
(jdk-resource-url & path-segments)Returns url to file at PATH-SEGMENTS relative to jdk-root.
Returns url to file at PATH-SEGMENTS relative to `jdk-root`.
jdk-rootclj
The JDK root directory (parent of the java.home JRE directory)
The JDK root directory (parent of the `java.home` JRE directory)
jdk-sourcesclj
The JDK sources path. If available, this is added to the classpath. By
convention, this is the file src.zip in the root of the JDK directory.
The JDK sources path. If available, this is added to the classpath. By convention, this is the file `src.zip` in the root of the JDK directory.
jdk-toolsclj
The JDK tools.jar path. If available, this is added to the classpath.
The JDK `tools.jar` path. If available, this is added to the classpath.
member-infoclj
(member-info class member)For the class and member symbols, return Java member info. If the member is
overloaded, line number and javadoc signature are that of the first overload.
If the member's definition is in a superclass, info returned will be for the
implemention. If the member is an instance member, this is prepended to its
arglists.
For the class and member symbols, return Java member info. If the member is overloaded, line number and javadoc signature are that of the first overload. If the member's definition is in a superclass, info returned will be for the implemention. If the member is an instance member, `this` is prepended to its arglists.
resolve-classclj
(resolve-class ns sym)Given namespace and class symbols, search the imported classes and return class info. If not found, search all classes on the classpath (requires a qualified name).
Given namespace and class symbols, search the imported classes and return class info. If not found, search all classes on the classpath (requires a qualified name).
resolve-memberclj
(resolve-member ns sym)Given namespace and member symbols, search the imported classes and return a list of each matching member's info.
Given namespace and member symbols, search the imported classes and return a list of each matching member's info.
resolve-symbolclj
(resolve-symbol ns sym)Given a namespace and a class or member symbol, resolve the class/member.
Class symbols, constructors, and static calls are resolved to the class
unambiguously. Instance members are resolved unambiguously if defined by only
one imported class. If multiple imported classes have a member by that name, a
map of class names to member info is returned as :candidates.
Given a namespace and a class or member symbol, resolve the class/member. Class symbols, constructors, and static calls are resolved to the class unambiguously. Instance members are resolved unambiguously if defined by only one imported class. If multiple imported classes have a member by that name, a map of class names to member info is returned as `:candidates`.
source-infoclj
When tools.jar is available, return class info from its parsed source;
otherwise return nil.
When `tools.jar` is available, return class info from its parsed source; otherwise return nil.
type-infoclj
(type-info class)For the class or interface symbol, return Java type info. If the type has
defined contructors, the line and column returned will be for the first of
these for more convenient jump navigation.
For the class or interface symbol, return Java type info. If the type has defined contructors, the line and column returned will be for the first of these for more convenient `jump` navigation.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close