- *analyze-sources*
- +this
- cache
- cache-initializer
- class-info
- class-info*
- ensure-jdk-sources
- extract-annotated-arglists
- extract-arglist
- extract-parameter-type
- initialize-cache-silently?
- javadoc-base-url
- javadoc-url
- jdk-find
- jdk-sources
- jdk-tools
- member-info
- module-name
- parser-available-exception
- parser-next-available?
- Reflected
- resolve-class
- resolve-javadoc-path
- resolve-member
- resolve-symbol
- resolve-type
- source-info
- source-info*
- trim-one-dot
- type-info
- typesym
orchard.java
Info for Java classes and members
Info for Java classes and members
*analyze-sources*clj
Whether to analyze .java sources in addition to reflection-gathered info.
Bind this to false in order to increase performance / decrease the amount of information returned.
Whether to analyze .java sources in addition to reflection-gathered info. Bind this to `false` in order to increase performance / decrease the amount of information returned.
cache-initializerclj
Cache info for a few classes.
This also warms up the cache for some underlying, commonly needed classes (e.g. Object).
This is a def for allowing others to wait for this workload to complete (can be useful sometimes).
Cache info for a few classes. This also warms up the cache for some underlying, commonly needed classes (e.g. `Object`). This is a def for allowing others to wait for this workload to complete (can be useful sometimes).
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.
extract-annotated-arglistsclj
(extract-annotated-arglists static? package {:keys [returns] :as x})initialize-cache-silently?clj
Should #'cache-initializer refrain from printing to System/out?
Should `#'cache-initializer` refrain from printing to `System/out`?
javadoc-base-urlclj
(javadoc-base-url jdk-version)Re-implementation of clojure.java.javadoc/*core-java-api* because it doesn't
contain newer JDK versions, especially in older Clojure.
Re-implementation of `clojure.java.javadoc/*core-java-api*` because it doesn't contain newer JDK versions, especially in older Clojure.
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-findcljdeprecated
(jdk-find _)Search common JDK path configurations for a specified file name and return a
URL if found. This accommodates java.home being set to either the JDK root
(JDK11+) or a JRE directory within this (JDK 8), and searches both the home and
lib directories.
Search common JDK path configurations for a specified file name and return a URL if found. This accommodates `java.home` being set to either the JDK root (JDK11+) or a JRE directory within this (JDK 8), and searches both the home and `lib` directories.
jdk-toolsclj
The tools.jar path, for JDK8 and earlier. If found on the existing
classpath, this is the corresponding classpath entry. Otherwise, if available,
this is added to the classpath.
The `tools.jar` path, for JDK8 and earlier. If found on the existing classpath, this is the corresponding classpath entry. Otherwise, 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
implementation. 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 implementation. If the member is an instance member, `this` is prepended to its arglists.
module-nameclj
(module-name klass)On JDK11+, return module name from the class if present; otherwise return nil
On JDK11+, return module name from the class if present; otherwise return nil
parser-available-exceptionclj
The exception found, if any, while trying to load any of the parser namespaces.
The exception found, if any, while trying to load any of the parser namespaces.
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-javadoc-pathclj
(resolve-javadoc-path path)Resolve a relative javadoc path to a URL and return as a map. Prefer javadoc resources on the classpath; then use online javadoc content for core API classes. If no source is available, return the relative path as is.
Resolve a relative javadoc path to a URL and return as a map. Prefer javadoc resources on the classpath; then use online javadoc content for core API classes. If no source is available, return the relative path as is.
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)Return the info map for a Java member symbol.
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.
Return the info map for a Java member symbol. 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`.
resolve-typeclj
(resolve-type ns sym)Return type info, for a Java class, interface or record.
Return type info, for a Java class, interface or record.
source-infoclj
(source-info class)Ensure that JDK sources are visible on the classpath if present, and return class info from its parsed source if available.
Ensure that JDK sources are visible on the classpath if present, and return class info from its parsed source if available.
source-info*clj
(source-info* & args)When a Java parser is available, return class info from its parsed source; otherwise return nil.
When a Java parser 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 constructors, 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 constructors, 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