Liking cljdoc? Tell your friends :D

orchard.java

Info for Java classes and members

Info for Java classes and members
raw docstring

*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.
sourceraw docstring

+thisclj

(+this xs)
source

cacheclj

source

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.
sourceraw docstring

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.
sourceraw docstring

extract-annotated-arglistsclj

(extract-annotated-arglists static? package {:keys [returns] :as x})
source

extract-arglistclj

(extract-arglist static? xs)
source

extract-parameter-typeclj

(extract-parameter-type static? xs)
source

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.
sourceraw docstring

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.
sourceraw docstring

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.
sourceraw docstring

module-nameclj

(module-name class-or-sym)

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
sourceraw docstring

parser-exceptionclj

The exception found, if any, when running any parser.

The exception found, if any, when running any parser.
sourceraw docstring

Reflectedcljprotocol

reflect-infoclj

(reflect-info o)
source

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).
sourceraw docstring

resolve-constructorclj

(resolve-constructor ns class-sym)

Given namespace and classname symbols, search the first constructor for the given class and return its info.

Given namespace and classname symbols, search the first constructor for the
given class and return its info.
sourceraw docstring

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.
sourceraw docstring

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.
sourceraw docstring

resolve-symbolclj

(resolve-symbol ns sym)

Return the info map for a Java member symbol. The following Java symbols are supported:

  • Java classes (Thread and java.lang.Thread)
  • Java classes with module prefix (java.base/java.lang.Thread)
  • constructors (Thread. and java.lang.Thread.)
  • static members (Thread/currentThread)
  • instance members for classes imported into ns (.start)
  • qualified instance members (Thread/.start)
  • Java-style printed member references (clojure.lang.AFn.run)

If multiple imported classes have a non-qualified instance 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. The following Java symbols are
supported:
- Java classes (`Thread` and `java.lang.Thread`)
- Java classes with module prefix (`java.base/java.lang.Thread`)
- constructors (`Thread.` and `java.lang.Thread.`)
- static members (`Thread/currentThread`)
- instance members for classes imported into `ns` (`.start`)
- qualified instance members (`Thread/.start`)
- Java-style printed member references (`clojure.lang.AFn.run`)

If multiple imported classes have a non-qualified instance member by that
name, a map of class names to member info is returned as `:candidates`.
sourceraw docstring

source-infoclj

(source-info class-symbol)
(source-info klass source-url)

Try to return class info from its parsed source if the source is available. Returns nil in case of any errors.

Try to return class info from its parsed source if the source is available.
Returns nil in case of any errors.
sourceraw docstring

typesymclj

(typesym o)
source

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close