Documentation menu

jdx hierarchy

IDE equivalent: Type hierarchy

Show a type's hierarchy: supertypes upward (full transitive chain, interfaces included) and subtypes/implementors downward across the workspace. --up/--down select directions (default both), --direct shows one level, --depth N caps transitive levels, --in/--exclude filter subtypes by artifact label. Member refs exit 3 (takes a type); unknown types exit 1, ambiguous short names exit 2.

Usage#

jdx hierarchy [<options>] <ref>

Example#

jdx hierarchy com.google.gson.JsonElement --coord com.google.code.gson:gson:2.14.0
hierarchy of 'com.google.gson.JsonElement'
  supertypes
    extends java.lang.Object  java.base
  subtypes in workspace (4)
    class com.google.gson.JsonArray  gson-2.14.0.jar
    class com.google.gson.JsonNull  gson-2.14.0.jar
    class com.google.gson.JsonObject  gson-2.14.0.jar
    class com.google.gson.JsonPrimitive  gson-2.14.0.jar
warning MULTI_RELEASE_VARIANT: multi-release gson-2.14.0.jar serves version-specific variants for this JDK (21)

Real output — this example ran against the current jdx when the page was built.

Options#

OptionDescription
--upShow supertypes upward (default when neither --up nor --down is given).
--downShow subtypes downward (default when neither --up nor --down is given).
--directShow one level only (direct supertypes and direct subtypes).
--depth=<int>Maximum transitive levels shown (default unlimited).
--in=<text>Only subtypes whose artifact label matches this glob (jar file name, JDK module or class-dir name).
--exclude=<text>Skip subtypes whose artifact label matches this glob.
--limit=<int>Maximum subtypes shown (default 50); the rest become a truncation footer.
--jars=<text>Binary roots: jar files, class directories or globs (repeatable). Merge in front of the selected workspace's roots.
-w, --workspace=<text>Use a named workspace (see jdx ws). Explicit --jars merge in front of it.
--no-jdkDo not include the running JDK's stdlib (included by default).
--coord=<text>Maven coordinate root group:artifact:version (repeatable). Resolved from ~/.gradle/caches and ~/.m2 first; with --fetch, downloaded from Maven repositories into <cache-dir>/m2 with checksum verification. Merges in front of the workspace.
--repo=<text>Maven repository base URL for --coord fetches (repeatable, e.g. --repo https://repo.example.com/maven2). Tried in flag order before Maven Central, which stays last as the fallback. Must be an http(s) URL.
--fetchAllow downloading --coord artifacts (and their -sources.jar) from Maven repositories (Central by default, --repo to add mirrors). Without it, coordinates resolve from the local caches only.
--jsonEmit machine-readable JSON instead of human-readable text (same information, D-007).
--no-colorDisable ANSI colors even on a TTY (piped output is always plain).
--no-daemonForce in-process execution: do not forward this query to the background daemon even when its socket answers (PROPOSAL.md §14.1).
-h, --helpShow this message and exit

Arguments#

ArgumentDescription
<ref>Type reference to show the hierarchy of (full or short form).

Full help text#

Show jdx hierarchy --help
jdx hierarchy --help
Usage: jdx hierarchy [<options>] <ref>

  Show a type's hierarchy: supertypes upward (full transitive chain, interfaces included) and subtypes/implementors downward across the workspace. --up/--down select directions (default both), --direct shows one level, --depth N caps transitive levels, --in/--exclude filter subtypes by artifact label. Member refs exit 3 (takes a type); unknown types exit 1, ambiguous short names exit 2.

Options:
  --up                    Show supertypes upward (default when neither --up nor --down is given).
  --down                  Show subtypes downward (default when neither --up nor --down is given).
  --direct                Show one level only (direct supertypes and direct subtypes).
  --depth=<int>           Maximum transitive levels shown (default unlimited).
  --in=<text>             Only subtypes whose artifact label matches this glob (jar file name, JDK module or class-dir name).
  --exclude=<text>        Skip subtypes whose artifact label matches this glob.
  --limit=<int>           Maximum subtypes shown (default 50); the rest become a truncation footer.
  --jars=<text>           Binary roots: jar files, class directories or globs (repeatable). Merge in front of the selected workspace's roots.
  -w, --workspace=<text>  Use a named workspace (see jdx ws). Explicit --jars merge in front of it.
  --no-jdk                Do not include the running JDK's stdlib (included by default).
  --coord=<text>          Maven coordinate root group:artifact:version (repeatable). Resolved from ~/.gradle/caches and ~/.m2 first; with --fetch, downloaded from Maven repositories into <cache-dir>/m2 with checksum verification. Merges in front of the workspace.
  --repo=<text>           Maven repository base URL for --coord fetches (repeatable, e.g. --repo https://repo.example.com/maven2). Tried in flag order before Maven Central, which stays last as the fallback. Must be an http(s) URL.
  --fetch                 Allow downloading --coord artifacts (and their -sources.jar) from Maven repositories (Central by default, --repo to add mirrors). Without it, coordinates resolve from the local caches only.
  --json                  Emit machine-readable JSON instead of human-readable text (same information, D-007).
  --no-color              Disable ANSI colors even on a TTY (piped output is always plain).
  --no-daemon             Force in-process execution: do not forward this query to the background daemon even when its socket answers (PROPOSAL.md §14.1).
  -h, --help              Show this message and exit

Arguments:
  <ref>  Type reference to show the hierarchy of (full or short form).

Real output — this example ran against the current jdx when the page was built.

Learn more#

Guide: Usages, hierarchy & calls · All commands

View as Markdown · Updated