Skip to content

Java APIs

Java 21 SE (Standard Edition)

How to Read the Java API Documentation

The Java API documentation lists every class, interface, and method available in Java. It is the official reference that professional developers rely on every day. This guide will help you use it confidently without feeling overwhelmed.

A note before you start: The Java API may feel overwhelming at first. That is completely normal. Most developers do not read documentation from top to bottom. Instead, they use it to answer specific questions as they work. You will do the same.

What Is the Java API?

The Java API (Application Programming Interface) is the official catalog of everything built into Java. It tells you:

  • What classes and interfaces exist
  • What methods each class provides
  • What parameters those methods require
  • What each method returns

Think of it as Java's official instruction manual. You do not read it cover to cover. You open it when you need to know how something works.

Start With a Specific Question

The best way to use the Java API is to arrive with a question you are trying to answer. Random browsing is not helpful. Purposeful searching is.

Good examples of starting questions:

  • How do I sort a list?
  • What methods does ArrayList provide?
  • How do I split a string into pieces?
  • How do I read a file line by line?

Once you have a question, search for the class or method that is most likely to help. That is your entry point.

How to Navigate a Class Page

When you open a class page in the Java API, you will see several sections. Here is what each one means and when to use it.

Class Description

This is the paragraph at the top of the page. It explains what the class is for in general terms.

Example: The ArrayList page describes it as a resizable array that stores an ordered list of items.

Read this to confirm you are looking at the right class. If the description does not match what you need, you may be in the wrong place.

Constructors

This section shows how to create a new object from the class.

Example:

ArrayList<String> names = new ArrayList<>();

Check this section when you need to figure out how to instantiate the class.

Method Summary

This is a table listing all available methods with a short one-line description of each.

This is the most useful section for most tasks. Scan it to find the method you need, then click through to read the full details.

Method Detail

This section gives the full description of each method, including parameters, return values, and sometimes examples.

You do not need to read every method in this section. Focus only on the method you are trying to use.

How to Read a Method Signature

Every method in the Java API is listed with a signature that tells you exactly how to call it. Here is an example:

public boolean add(E element)

Breaking this down:

  • public means you can call this method from anywhere in your code.
  • boolean is the return type. This method returns either true or false.
  • add is the method name.
  • E element is the parameter. You pass in the item you want to add to the list.

Reading method signatures becomes easier with practice. Focus on the return type and parameters first.

Pay Attention to Parameters and Return Values

Two of the most important things to notice on any method page are:

  1. Parameters: What information does the method need from you?
  2. Return value: What does the method give back when it finishes?

Here is an example using the String class:

String substring(int beginIndex)
  • Parameter: beginIndex is an int. You provide the starting position (zero-indexed).
  • Return value: String. The method gives back a new string starting at that position.

So "hello".substring(2) returns "llo".

When you find a method you want to use, ask yourself: what do I need to pass in, and what will I get back?

Read the Examples

Many API pages include short code examples. If the formal description feels confusing, skip straight to the examples. Seeing the method used in context is often much clearer than reading the technical definition.

If you find an example that matches your situation, try adapting it to your code.

You Don't Need to Memorize Anything

This is worth saying directly: professional developers look things up constantly. Knowing every method signature by heart is not the goal. The goal is knowing where to find the information you need and how to read it once you get there.

Using documentation is not a sign that you do not know Java. It is a sign that you are working the way real developers work.

Quick Walkthrough: Finding a Method in ArrayList

Here is a step-by-step example using ArrayList.

Goal: You want to check if an ArrayList already contains a specific value before adding it.

  1. Open the Java 21 API documentation.
  2. Search for ArrayList in the search bar at the top.
  3. Click on java.util.ArrayList in the results.
  4. Scroll to the Method Summary section.
  5. Scan the table. You will see a method called contains.
  6. The one-line summary says: Returns true if this list contains the specified element.
  7. Click on contains to go to the Method Detail.
  8. You will see the signature:
public boolean contains(Object o)
  • Parameter: o is the object you want to look for.
  • Return value: boolean. Returns true if the item is in the list, false if it is not.

Now you have everything you need to use it:

if (!names.contains("Alice")) {
    names.add("Alice");
}

That is the full workflow: arrive with a question, find the class, scan the method summary, read the detail for the method you need, and use it.

Tips for Using the API Efficiently

  • Use the search bar at the top of the API site to go directly to the class you need.
  • Scan the Method Summary before reading Method Detail. It is much faster.
  • If a method name makes sense in plain English (contains, remove, size), it probably does what it sounds like.
  • If the return type is void, the method does something but does not give you a value back.
  • If you are unsure what a method does, check whether the page includes an example.

The Java API is a tool, not a test. Every time you use it, you are doing exactly what professional developers do.