Reading Javadocs

Last updated 4 months ago

Most public APIs and libraries offer documentation in the form of Javadocs. Javadocs outline what features of a library are publicly accessible to developers.

Here are a few links to some commonly referenced Javadocs: Java SE 8 Javadocs Spigot Javadocs

Fully qualified names

A fully qualified name is composed of a class's package and name. On the Javadoc of a class, this may be found near the top of the page. Fully qualified names are used when importing classes.

The fully qualified name of this class is org.bukkit.entity.Player
Classes may have an inheritance hierarchy which shows the fully qualified name of the class

If the name of the class contains a ., that is because the class is nested within another class. When referring to these classes, you must replace the . with a $.

The fully qualified name of this class is org.bukkit.Effect$Type

Typically, nested classes should be imported under an alias!

Non-public APIs

Javadocs do not describe everything available in a library. Most libraries include private classes, methods, fields, and constructors reserved for internal use. Using skript-mirror, these internal APIs are accessible just like any public API.

Usually, private APIs are private for a reason! Make sure you know what you're doing before you start digging around!

Built-in inspection

skript-mirror has built-in tools for dumping all of the available members of an object. If you need a list of these members, including their return types and input parameters, you can use the Members expression. If you only need a list of names, you can use the Member Names expression.

Source code

The best way to learn about how a library works is to read the source code! Many libraries will have their source code easily available online, though you may have to resort to decompiling libraries that are not open source.

Craftbukkit source code Online Java decompiler