Java | Packages and APIs

Packages organize Java types into meaningful namespaces, while an API is the set of types and members other code can depend on. Keep package names stable, expose only deliberate public contracts and use imports to clarify dependencies. Good package boundaries reduce naming collisions and limit the blast radius of implementation changes.

Package by Responsibility

Place related types under a coherent package such as com.algogalaxy.catalog. Avoid one giant util package; it hides ownership and makes unrelated code depend on one another.

Keep Public APIs Small

A public class or method is a promise to callers. Expose the smallest stable surface and keep helpers package-private or private until a genuine external use requires them.

Use Imports Deliberately

An import names a dependency. Prefer explicit imports over wildcard imports so a reader can see which external types a file actually uses and avoid ambiguous names.

Separate Contract From Implementation

An interface or public service type can state what callers may do while a package-private implementation decides how. This keeps changes behind the API boundary.

Worked Examples

Example 1: Declare a Package

The package declaration belongs at the top of the source file. It gives the class a stable fully qualified name and groups it with related application code.

Java

package com.algogalaxy.catalog;

public class Course {
    private final String title;

    public Course(String title) {
        this.title = title;
    }
}

Expected Result

Course belongs to com.algogalaxy.catalog

Example 2: Expose a Small Public Contract

The public interface tells callers what can be done without exposing storage, SQL or framework details. Implementations can change while the contract stays stable.

Java

package com.algogalaxy.catalog;

public interface CourseFinder {
    String findTitle(long id);
}

Expected Result

Callers depend on CourseFinder, not storage details

Example 3: Use an Explicit Import

The import makes the standard library dependency visible. The code then uses List by its simple name without obscuring which collection abstraction it chose.

Java

import java.util.List;

public class Main {
    public static void main(String[] args) {
        List<String> names = List.of("Ada", "Lin");
        System.out.println(names.size());
    }
}

Expected Result

Build and Practice Plan

Build confidence by changing one rule at a time. Start with the normal case, make the expected value visible, then add the nearest boundary and a rejected input. Keep Java syntax in service of the contract: a program is useful only when its behavior remains understandable as inputs, scale and failure conditions change.

Step 1: create one normal case, one boundary case and one rejected or failure case for package by responsibility before expanding the implementation.
Step 2: create one normal case, one boundary case and one rejected or failure case for keep public apis small before expanding the implementation.
Step 3: create one normal case, one boundary case and one rejected or failure case for use imports deliberately before expanding the implementation.
Step 4: create one normal case, one boundary case and one rejected or failure case for separate contract from implementation before expanding the implementation.

Design Review Questions

Before accepting a change, identify the valid values, the owner of mutable state, the behavior for missing or invalid input and the test that proves the important boundary. Keep I/O, storage and framework wiring outside the small Java rule until the local behavior is proven.

A clear result is better than a hidden side effect. Name the condition, return the calculation where possible and let the outer layer decide whether to print, store or transmit it.

Example 4: Make the input visible

Start by naming the value the next line depends on. This keeps the lesson input explicit before we apply a transformation or call an external boundary. We are applying that habit while revisiting Java Packages & API.

Keep the example small enough to trace. First predict the normal result; then change one input and explain the boundary result in your own words.

Java

public class Main {
    public static void main(String[] args) {
        String lesson = "Java Packages API";
        System.out.println(lesson.toUpperCase());
    }
}

Expected Result

JAVA PACKAGES API

Try next: Replace the sample value with one from your own notes, predict the result, and then run it.

Example 5: Make the input visible

Keep the example small enough to trace. First predict the normal result; then change one input and explain the boundary result in your own words.

Java

public class Main {
    public static void main(String[] args) {
        String lesson = "Java Packages API";
        System.out.println(lesson.toUpperCase());
    }
}

Expected Result

JAVA PACKAGES API

Try next: Replace the sample value with one from your own notes, predict the result, and then run it.

Example 6: Make the input visible

Keep the example small enough to trace. First predict the normal result; then change one input and explain the boundary result in your own words.

Java

public class Main {
    public static void main(String[] args) {
        String lesson = "Java Packages API";
        System.out.println(lesson.toUpperCase());
    }
}

Expected Result

JAVA PACKAGES API

Try next: Replace the sample value with one from your own notes, predict the result, and then run it.

Example 7: Guard an empty boundary

A small guard makes the allowed and rejected path visible. We want a caller to receive an intentional result instead of discovering an unexplained failure later. We are applying that habit while revisiting Java Packages & API.

Keep the example small enough to trace. First predict the normal result; then change one input and explain the boundary result in your own words.

Java

public class Main {
    static boolean accepted(String value) {
        return value != null && !value.isBlank();
    }

    public static void main(String[] args) {
        System.out.println(accepted("Java Packages API"));
    }
}

Expected Result

true

Try next: Try an empty value as well as the normal value and describe why the two outcomes differ.

Example 8: Keep the transformation pure

This step returns a value instead of mixing the rule with display or storage work. That separation gives us a small unit we can run, test, and reuse. We are applying that habit while revisiting Java Packages & API.

Keep the example small enough to trace. First predict the normal result; then change one input and explain the boundary result in your own words.

Java

public class Main {
    static int doubleValue(int value) { return value * 2; }

    public static void main(String[] args) {
        System.out.println(doubleValue(6));
    }
}

Expected Result

Try next: Call the same rule twice with different inputs and confirm that each result depends only on its input.

Example 9: Make a branch deliberate

Use a named branch where the business rule changes. A future reader should be able to point at the condition and state the result for both sides. We are applying that habit while revisiting Java Packages & API.

Keep the example small enough to trace. First predict the normal result; then change one input and explain the boundary result in your own words.

Java

public class Main {
    public static void main(String[] args) {
        int score = 7;
        String result = score >= 5 ? "ready" : "review";
        System.out.println(result);
    }
}

Expected Result

ready

Try next: Change the boundary value by one and explain exactly which branch becomes active.

Example 10: Use a collection without hidden mutation

Collections become safer when we can see which value is read, which value is derived, and whether the original collection remains owned by the caller. We are applying that habit while revisiting Java Packages & API.

Keep the example small enough to trace. First predict the normal result; then change one input and explain the boundary result in your own words.

Java

import java.util.List;

public class Main {
    public static void main(String[] args) {
        List<String> lessons = List.of("Java Packages API", "boundary");
        System.out.println(String.join(" | ", lessons));
    }
}

Expected Result

Java Packages API | boundary

Try next: Add one more item and predict the derived result before executing the code.

Example 11: Return a named outcome

A named outcome is easier to test than an implied side effect. We can now distinguish a successful path from a rejected path without guessing from console noise. We are applying that habit while revisiting Java Packages & API.

Keep the example small enough to trace. First predict the normal result; then change one input and explain the boundary result in your own words.

Java

public class Main {
    record Outcome(String status, String lesson) {}

    public static void main(String[] args) {
        Outcome outcome = new Outcome("ready", "Java Packages API");
        System.out.println(outcome.status());
    }
}

Expected Result

ready

Try next: Rename the outcome in your own words while preserving the same success and failure rule.

Example 12: Trace a small loop

Work through one value at a time. The point is not to memorize syntax; it is to see how the accumulator or output changes after each repeatable step. We are applying that habit while revisiting Java Packages & API.

Keep the example small enough to trace. First predict the normal result; then change one input and explain the boundary result in your own words.

Java

public class Main {
    public static void main(String[] args) {
        int total = 0;
        for (int value : new int[] {1, 2, 3}) total += value;
        System.out.println(total);
    }
}

Expected Result

Try next: Use a shorter collection first, then add one value and trace the extra iteration aloud.

Example 13: Keep display at the edge

The core rule prepares a value, while the outer line decides how to show it. That keeps the result usable by a UI, test, API, or command-line caller. We are applying that habit while revisiting Java Packages & API.

Keep the example small enough to trace. First predict the normal result; then change one input and explain the boundary result in your own words.

Java

public class Main {
    static String display(String value) { return "Lesson: " + value; }

    public static void main(String[] args) {
        System.out.println(display("Java Packages API"));
    }
}

Expected Result

Lesson: Java Packages API

Try next: Change only the display text and verify that the underlying rule and result stay unchanged.

Example 14: Test the closest boundary

A useful example includes the nearest boundary, not only the happy path. We are making the behavior inspectable before a real caller relies on it. We are applying that habit while revisiting Java Packages & API.

Keep the example small enough to trace. First predict the normal result; then change one input and explain the boundary result in your own words.

Java

public class Main {
    static int quantity(int value) {
        if (value < 1) throw new IllegalArgumentException("quantity must be positive");
        return value;
    }

    public static void main(String[] args) {
        System.out.println(quantity(1));
    }
}

Expected Result

Try next: Try the lowest supported value and then one value just outside the accepted range.

Example 15: Write a tiny regression check

A compact assertion turns the lesson into a repeatable promise. It helps us catch a changed rule before a larger program hides the source of the mistake. We are applying that habit while revisiting Java Packages & API.

Keep the example small enough to trace. First predict the normal result; then change one input and explain the boundary result in your own words.

Java

public class Main {
    public static void main(String[] args) {
        String result = "Java Packages API".toUpperCase();
        if (!result.equals("JAVA PACKAGES API")) throw new AssertionError("contract failed");
        System.out.println("contract holds");
    }
}

Expected Result

contract holds

Try next: Deliberately change the expected value once, observe the failed check, and then restore the correct contract.

Common Mistakes

Avoid: treating package by responsibility as a syntax trick while leaving the domain rule, ownership or error behavior implicit.
Avoid: treating keep public apis small as a syntax trick while leaving the domain rule, ownership or error behavior implicit.
Avoid: treating use imports deliberately as a syntax trick while leaving the domain rule, ownership or error behavior implicit.
Avoid: treating separate contract from implementation as a syntax trick while leaving the domain rule, ownership or error behavior implicit.

Interview Checklist

State the input domain and the boundary value before explaining the syntax.
Explain the failure or rejected-input outcome rather than assuming the happy path.
Identify mutation, ownership and any value that must not be changed by a caller.
Name a focused test that would prove the rule still holds after a future change.
Separate the local Java decision from printing, persistence, networking or framework code.