# Google Java Style Guide

<!-- mdformat off -->
* TOC
{:toc}
<!-- mdformat on -->

<!-- GitHub pages run markdown through Liquid templating which uses two open
     braces which also shows up in our code examples. Disable parsing for the
     whole document as we don't use Liquid templating anywhere -- the HTML
     conversion is via Kramdown.

     NB: Must come after the [TOC].
     {% raw %} -->

<a id="s1-introduction"></a>

## 1 Introduction

This document serves as the **complete** definition of Google's coding standards
for source code in the Java™ Programming Language. A Java source file is
described as being *in Google Style* if and only if it adheres to the rules
herein.

Like other programming style guides, the issues covered span not only aesthetic
issues of formatting, but other types of conventions or coding standards as
well. However, this document focuses primarily on the **hard-and-fast rules**
that we follow universally, and avoids giving *advice* that isn't clearly
enforceable (whether by human or tool).

<a id="s1.1-terminology"></a>

### 1.1 Terminology notes

In this document, unless otherwise clarified:

1.  The term *class* is used inclusively to mean a normal class, record class,
    enum class, interface or annotation type (`@interface`).
2.  The term *member* (of a class) is used inclusively to mean a nested class,
    field, method, *or constructor*; that is, all top-level contents of a class
    except initializers.
3.  The term *comment* always refers to *implementation* comments. We do not use
    the phrase "documentation comments", and instead use the common term
    "Javadoc."

Other "terminology notes" will appear occasionally throughout the document.

<a id="s1.2-guide-notes"></a>

### 1.2 Guide notes

Example code in this document is **non-normative**. That is, while the examples
are in Google Style, they may not illustrate the *only* stylish way to represent
the code. Optional formatting choices made in examples should not be enforced as
rules.

<a id="s2-source-file-basics"></a>

## 2 Source file basics

<a id="s2.1-file-name"></a>

### 2.1 File name

For a source file containing classes, the file name consists of the
case-sensitive name of the top-level class (of which there is
[exactly one](#s3.4.1-one-top-level-class)), plus the `.java` extension.

<a id="s2.2-file-encoding"></a>

### 2.2 File encoding: UTF-8

Source files are encoded in **UTF-8**.

<a id="s2.3-special-characters"></a>

### 2.3 Special characters

<a id="s2.3.1-whitespace-characters"></a>

#### 2.3.1 Whitespace characters

Aside from the line terminator sequence, the **ASCII horizontal space
character** (**0x20**) is the only whitespace character that appears anywhere in
a source file. This implies that:

1.  All other whitespace characters are escaped in `char` and string literals
    and in text blocks.
2.  Tab characters are **not** used for indentation.

<a id="s2.3.2-special-escape-sequences"></a>

#### 2.3.2 Special escape sequences

For any character that has a
[special escape sequence](http://docs.oracle.com/javase/tutorial/java/data/characters.html)
(`\b`, `\t`, `\n`, `\f`, `\r`, `\s`, `\"`, `\'` and `\\ `), that sequence is
used rather than the corresponding octal (e.g. `\012`) or Unicode (e.g.
`\u000a`) escape.

<a id="s2.3.3-non-ascii-characters"></a>

#### 2.3.3 Non-ASCII characters

For the remaining non-ASCII characters, either the actual Unicode character
(e.g. `∞`) or the equivalent Unicode escape (e.g. `\u221e`) is used. The choice
depends only on which makes the code **easier to read and understand**, although
Unicode escapes outside string literals and comments are strongly discouraged.

**Tip:** In the Unicode escape case, and occasionally even when actual Unicode
characters are used, an explanatory comment can be very helpful.

Examples:

<!-- mdformat off -->

| Example                                                  | Discussion                                                                |
| :------------------------------------------------------- | :------------------------------------------------------------------------ |
| `String unitAbbrev = "μs";`                              | Best: perfectly clear even without a comment.                             |
| `String unitAbbrev = "\u03bcs"; // "μs"`                 | Allowed, but there's no reason to do this.                                |
| `String unitAbbrev = "\u03bcs"; // Greek letter mu, "s"` | Allowed, but awkward and prone to mistakes.                               |
| `String unitAbbrev = "\u03bcs";`                         | Poor: the reader has no idea what this is.                                |
| `return '\ufeff' + content; // byte order mark`          | Good: use escapes for non-printable characters, and comment if necessary. |

<!-- mdformat on -->

**Tip:** Never make your code less readable simply out of fear that some
programs might not handle non-ASCII characters properly. If that should happen,
those programs are **broken** and they must be **fixed**.

<a id="filestructure"></a>

<a id="s3-source-file-structure"></a>

## 3 Source file structure

An ordinary source file consists of these sections, **in order**:

1.  License or copyright information, if present
2.  Package declaration
3.  Imports
4.  Exactly one top-level class declaration

**Exactly one blank line** separates each section that is present.

A `package-info.java` file is the same, but without the class declaration.

A `module-info.java` file does not contain a package declaration and replaces
the class declaration with a module declaration, but otherwise follows the same
structure.

<a id="s3.1-copyright-statement"></a>

### 3.1 License or copyright information, if present

If license or copyright information belongs in a file, it belongs here.

<a id="s3.2-package-statement"></a> <!-- historical link -->

<a id="s3.2-package-declaration"></a>

### 3.2 Package declaration

Every source file must have a package declaration.
[Compact source files](https://openjdk.org/jeps/512) are not used. (This rule
obviously does not apply to `module-info.java` files, which have a different
syntax that does not include a package declaration.)

The package declaration is **not line-wrapped**. The column limit (Section 4.4,
[Column limit: 100](#s4.4-column-limit)) does not apply to package declarations.

<a id="imports"></a>

<a id="s3.3-import-statements"></a>

### 3.3 Imports

<a id="s3.3.1-wildcard-imports"></a>

#### 3.3.1 No wildcard imports

**Wildcard ("on-demand") imports**, static or otherwise, **are not used**.

<a id="s3.3.1.1-module-imports"></a>

#### 3.3.1.1 No module imports

[Module imports](https://docs.oracle.com/en/java/javase/25/language/module-import-declarations.html)
**are not used**.

Example:

```java
import module java.base;
```

<a id="s3.3.2-import-line-wrapping"></a>

#### 3.3.2 No line-wrapping

Imports are **not line-wrapped**. The column limit (Section 4.4,
[Column limit: 100](#s4.4-column-limit)) does not apply to imports.

<a id="s3.3.3-import-ordering-and-spacing"></a>

#### 3.3.3 Ordering and spacing

Imports are ordered as follows:

1.  All static imports in a single group.
2.  All non-static imports in a single group.

If there are both static and non-static imports, a single blank line separates
the two groups. There are no other blank lines between imports.

Within each group the imported names appear in ASCII sort order. (**Note:** this
is not the same as the import *lines* being in ASCII sort order, since '.' sorts
before ';'.)

<a id="s3.3.4-import-class-not-static"></a>

#### 3.3.4 No static import for classes

Static import is not used for static nested classes. They are imported with
normal imports.

<a id="s3.4-class-declaration"></a>

### 3.4 Class declaration

<a id="oneclassperfile"></a>

<a id="s3.4.1-one-top-level-class"></a>

#### 3.4.1 Exactly one top-level class declaration

Each top-level class resides in a source file of its own.

<a id="s3.4.2-class-member-ordering"></a> <!-- historical link -->

<a id="s3.4.2-ordering-class-contents"></a>

#### 3.4.2 Ordering of class contents

The order you choose for the members and initializers of your class can have a
great effect on learnability. However, there's no single correct recipe for how
to do it; different classes may order their contents in different ways.

What is important is that each class uses ***some* logical order**, which its
maintainer could explain if asked. For example, new methods are not just
habitually added to the end of the class, as that would yield "chronological by
date added" ordering, which is not a logical ordering.

<a id="overloads"></a>

<a id="s3.4.2.1-overloads-never-split"></a>

##### 3.4.2.1 Overloads: never split

Methods of a class that share the same name appear in a single contiguous group
with no other members in between. The same applies to multiple constructors.
This rule applies even when modifiers such as `static` or `private` differ
between the methods or constructors.

<a id="s3.5-module-declaration"></a>

### 3.5 Module declaration

<a id="s3.5.1-ordering-module-directives"></a>

#### 3.5.1 Ordering and spacing of module directives

Module directives are ordered as follows:

1.  All `requires` directives in a single block.
2.  All `exports` directives in a single block.
3.  All `opens` directives in a single block.
4.  All `uses` directives in a single block.
5.  All `provides` directives in a single block.

A single blank line separates each block that is present.

<a id="s4-formatting"></a>

## 4 Formatting

**Terminology Note:** *block-like construct* refers to the body of a class,
method, constructor, or switch. Note that, by Section 4.8.3.1 on
[array initializers](#s4.8.3.1-array-initializers), any array initializer *may*
optionally be treated as if it were a block-like construct.

<a id="braces"></a>

<a id="s4.1-braces"></a>

### 4.1 Braces

<a id="s4.1.1-braces-always-used"></a>

#### 4.1.1 Use of optional braces

Braces are used with `if`, `else`, `for`, `do` and `while` statements, even when
the body is empty or contains only a single statement.

Other optional braces, such as those in a lambda expression, remain optional.

<a id="s4.1.2-blocks-k-r-style"></a>

#### 4.1.2 Nonempty blocks: K & R style

Braces follow the Kernighan and Ritchie style for *nonempty* blocks and
block-like constructs:

*   No line break before the opening brace, except as detailed below.
*   Line break after the opening brace.
*   Line break before the closing brace.
*   Line break after the closing brace, *only if* that brace terminates a
    statement or terminates the body of a method, constructor, or *named* class.
    For example, there is *no* line break after the brace if it is followed by
    `else` or a comma.

Exception: In places where these rules allow a single statement ending with a
semicolon (`;`), a block of statements can appear, and the opening brace of this
block is preceded by a line break. Blocks like these are typically introduced to
limit the scope of local variables.

Examples:

```java
return () -> {
  while (condition()) {
    method();
  }
};

return new MyClass() {
  @Override public void method() {
    if (condition()) {
      try {
        something();
      } catch (ProblemException e) {
        recover();
      }
    } else if (otherCondition()) {
      somethingElse();
    } else {
      lastThing();
    }
    {
      int x = foo();
      frob(x);
    }
  }
};
```

A few exceptions for enum classes are given in Section 4.8.1,
[Enum classes](#s4.8.1-enum-classes).

<a id="emptyblocks"></a>

<a id="s4.1.3-braces-empty-blocks"></a>

#### 4.1.3 Empty blocks: may be concise

An empty block or block-like construct may be in K & R style (as described in
[Section 4.1.2](#s4.1.2-blocks-k-r-style)). Alternatively, it may be closed
immediately after it is opened, with no characters or line break in between
(`{}`), **unless** it is part of a *multi-block statement* (one that directly
contains multiple blocks: `if/else` or `try/catch/finally`).

Examples:

<div class='goodcode'></div>

```java
  // This is acceptable
  void doNothing() {}

  // This is equally acceptable
  void doNothingElse() {
  }
```

<div class='badcode'></div>

```java
  // This is not acceptable: No concise empty blocks in a multi-block statement
  try {
    doSomething();
  } catch (Exception e) {}
```

<a id="s4.2-block-indentation"></a>

### 4.2 Block indentation: +2 spaces

Each time a new block or block-like construct is opened, the indent increases by
two spaces. When the block ends, the indent returns to the previous indent
level. The indent level applies to both code and comments throughout the block.
(See the example in Section 4.1.2,
[Nonempty blocks: K & R Style](#s4.1.2-blocks-k-r-style).)

<a id="s4.3-one-statement-per-line"></a>

### 4.3 One statement per line

Each statement is followed by a line break.

<a id="columnlimit"></a>

<a id="s4.4-column-limit"></a>

### 4.4 Column limit: 100

Java code has a column limit of 100 characters. A "character" means any Unicode
code point. Except as noted below, any line that would exceed this limit must be
line-wrapped, as explained in Section 4.5, [Line-wrapping](#s4.5-line-wrapping).

**Tip:** Each Unicode code point counts as one character, even if its display
width is greater or less. For example, if using
[fullwidth characters](https://en.wikipedia.org/wiki/Halfwidth_and_fullwidth_forms),
you may choose to wrap the line earlier than where this rule strictly requires.

**Exceptions:**

1.  Lines where obeying the column limit is not possible (for example, a long
    URL in Javadoc, or a long JSNI method reference).
2.  `package` declarations and imports (see Sections 3.2
    [Package declarations](#s3.2-package-statement) and 3.3
    [Imports](#s3.3-import-statements)).
3.  Contents of [text blocks](#s4.8.9-text-blocks).
4.  Command lines in a comment that may be copied-and-pasted into a shell.
5.  Very long identifiers, on the rare occasions they are called for, are
    allowed to exceed the column limit. In that case, the valid wrapping for the
    surrounding code is as produced by
    [google-java-format](https://github.com/google/google-java-format).

<a id="s4.5-line-wrapping"></a>

### 4.5 Line-wrapping

**Terminology Note:** When code that might otherwise occupy a single line is
divided into multiple lines, this activity is called *line-wrapping*.

There is no comprehensive, deterministic formula showing *exactly* how to
line-wrap in every situation. Very often there are several valid ways to
line-wrap the same piece of code.

**Note:** While the typical reason for line-wrapping is to avoid overflowing the
column limit, even code that would in fact fit within the column limit *may* be
line-wrapped at the author's discretion.

**Tip:** Extracting a method or local variable may solve the problem without the
need to line-wrap.

<a id="s4.5.1-line-wrapping-where-to-break"></a>

#### 4.5.1 Where to break

The prime directive of line-wrapping is: prefer to break at a **higher syntactic
level**. Also:

1.  When a line is broken at a *non-assignment* operator the break comes
    *before* the symbol. (Note that this is not the same practice used in Google
    style for other languages, such as C++ and JavaScript.)

    *   This also applies to the following "operator-like" symbols:

        *   the dot separator (`.`)
        *   the two colons of a method reference (`::`)
        *   an ampersand in a type bound (`<T extends Foo & Bar>`)
        *   a pipe in a catch block (`catch (FooException | BarException e)`).

2.  When a line is broken at an *assignment* operator the break typically comes
    *after* the symbol, but either way is acceptable.

    *   This also applies to the colon in an enhanced `for` ("foreach")
        statement.

3.  A method, constructor, or record-class name stays attached to the open
    parenthesis (`(`) that follows it.

4.  A comma (`,`) stays attached to the token that precedes it.

5.  A line is never broken adjacent to the arrow in a lambda or a switch rule,
    except that a break may come immediately after the arrow if the text
    following it consists of a single unbraced expression. Examples:

    ```java
    MyLambda<String, Long, Object> lambda =
        (String label, Long value, Object obj) -> {
          ...
        };

    Predicate<String> predicate = str ->
        longExpressionInvolving(str);

    switch (x) {
      case ColorPoint(Color color, Point(int x, int y)) ->
          handleColorPoint(color, x, y);
      ...
    }
    ```

**Note:** The primary goal for line wrapping is to have clear code, *not
necessarily* code that fits in the smallest number of lines.

<a id="indentation"></a>

<a id="s4.5.2-line-wrapping-indent"></a>

#### 4.5.2 Indent continuation lines at least +4 spaces

When line-wrapping, each line after the first (each *continuation line*) is
indented at least +4 from the original line.

When there are multiple continuation lines, indentation may be varied beyond +4
as desired. In general, two continuation lines use the same indentation level if
and only if they begin with syntactically parallel elements.

Section 4.6.3 on [Horizontal alignment](#s4.6.3-horizontal-alignment) addresses
the discouraged practice of using a variable number of spaces to align certain
tokens with previous lines.

<a id="s4.6-whitespace"></a>

### 4.6 Whitespace

<a id="s4.6.1-vertical-whitespace"></a>

#### 4.6.1 Vertical whitespace (blank lines)

A single blank line always appears:

1.  *Between* consecutive members or initializers of a class: fields,
    constructors, methods, nested classes, static initializers, and instance
    initializers.

    *   **Exception:** A blank line between two consecutive fields (having no
        other code between them) is optional. Such blank lines are used as
        needed to create *logical groupings* of fields.
    *   **Exception:** Blank lines between enum constants are covered in
        [Section 4.8.1](#s4.8.1-enum-classes).

2.  As required by other sections of this document (such as Section 3,
    [Source file structure](#s3-source-file-structure), and Section 3.3,
    [Imports](#s3.3-import-statements)).

A single blank line may also appear anywhere it improves readability, for
example between statements to organize the code into logical subsections. A
blank line before the first member or initializer, or after the last member or
initializer of the class, is neither encouraged nor discouraged.

*Multiple* consecutive blank lines are permitted, but never required (or
encouraged).

<a id="s4.6.2-horizontal-whitespace"></a>

#### 4.6.2 Horizontal whitespace

Beyond where required by the language or other style rules, and apart from
within literals, comments and Javadoc, a single ASCII space also appears in the
following places **only**.

1.  Separating any keyword, such as `if`, `for` or `catch`, from an open
    parenthesis (`(`) that follows it on that line

2.  Separating any keyword, such as `else` or `catch`, from a closing curly
    brace (`}`) that precedes it on that line

3.  Before any open curly brace (`{`), with two exceptions:

    *   `@SomeAnnotation({a, b})` (no space is used)
    *   `String[][] x = {{"foo"}};` (no space is required between `{{`, by item
        10 below)

4.  On both sides of any binary or ternary operator. This also applies to the
    following "operator-like" symbols:

    *   the ampersand that separates multiple type bounds:
        `<T extends Foo & Bar>`
    *   the pipe for a catch block that handles multiple exceptions:
        `catch (FooException | BarException e)`
    *   the colon (`:`) in an enhanced `for` ("foreach") statement
    *   the arrow in a lambda expression: `(String str) -> str.length()` \
        or switch rule: `case "FOO" -> bar();`

    but not

    *   the two colons (`::`) of a method reference, which is written like
        `Object::toString`
    *   the dot separator (`.`), which is written like `object.toString()`

5.  After `,:;` or the closing parenthesis (`)`) of a cast

6.  Between any content and a double slash (`//`) which begins a comment.
    Multiple spaces are allowed.

7.  Between a double slash (`//`) which begins a comment and the comment's text.
    Multiple spaces are allowed.

8.  Between the type and identifier of a declaration: `List<String> list`

9.  *Optional* just inside both braces of an array initializer

    *   `new int[] {5, 6}` and `new int[] { 5, 6 }` are both valid

10. Between a type annotation and `[]` or `...`.

This rule is never interpreted as requiring or forbidding additional space at
the start or end of a line; it addresses only *interior* space.

<a id="s4.6.3-horizontal-alignment"></a>

#### 4.6.3 Horizontal alignment: never required

**Terminology Note:** *Horizontal alignment* is the practice of adding a
variable number of additional spaces in your code with the goal of making
certain tokens appear directly below certain other tokens on previous lines.

This practice is permitted, but is **never required** by Google Style. It is not
even required to *maintain* horizontal alignment in places where it was already
used.

Here is an example without alignment, then using alignment:

```java
private int x; // this is fine
private Color color; // this too

private int   x;      // permitted, but future edits
private Color color;  // may leave it unaligned
```

**Tip:** Alignment can aid readability, but attempting to preserve alignment for
its own sake creates future problems. For example, consider a change that
touches only one line. If that change disrupts the previous alignment, it's
important **not** to introduce additional changes on nearby lines simply to
realign them. Introducing formatting changes on otherwise unaffected lines
corrupts version history, slows down reviewers, and exacerbates merge conflicts.
These practical concerns take priority over alignment.

<a id="parentheses"></a>

<a id="s4.7-grouping-parentheses"></a>

### 4.7 Grouping parentheses: recommended

Optional grouping parentheses are omitted only when author and reviewer agree
that there is no reasonable chance the code will be misinterpreted without them,
nor would they have made the code easier to read. It is *not* reasonable to
assume that every reader has the entire Java operator precedence table
memorized.

<a id="s4.8-specific-constructs"></a>

### 4.8 Specific constructs

<a id="s4.8.1-enum-classes"></a>

#### 4.8.1 Enum classes

After the comma that follows an enum constant, a line break is optional.
Additional blank lines (usually just one) are also allowed. This is one
possibility:

```java
private enum Answer {
  YES {
    @Override public String toString() {
      return "yes";
    }
  },

  NO,
  MAYBE
}
```

An enum class with no methods and no documentation on its constants may
optionally be formatted as if it were an array initializer (see Section 4.8.3.1
on [array initializers](#s4.8.3.1-array-initializers)).

```java
private enum Suit { CLUBS, HEARTS, SPADES, DIAMONDS }
```

Since enum classes *are classes*, all other rules for formatting classes apply.

<a id="localvariables"></a>

<a id="s4.8.2-variable-declarations"></a>

#### 4.8.2 Variable declarations

<a id="s4.8.2.1-variables-per-declaration"></a>

##### 4.8.2.1 One variable per declaration

Every variable declaration (field or local) declares only one variable:
declarations such as `int a, b;` are not used.

**Exception:** Multiple variable declarations are acceptable in the header of a
`for` loop.

<a id="s4.8.2.2-variables-limited-scope"></a>

##### 4.8.2.2 Declared when needed

Local variables are **not** habitually declared at the start of their containing
block or block-like construct. Instead, local variables are declared close to
the point they are first used (within reason), to minimize their scope. Local
variable declarations typically have initializers, or are initialized
immediately after declaration.

<a id="s4.8.3-arrays"></a>

#### 4.8.3 Arrays

<a id="s4.8.3.1-array-initializers"></a>

##### 4.8.3.1 Array initializers: can be "block-like"

Any array initializer may *optionally* be formatted as if it were a "block-like
construct." For example, the following are all valid (**not** an exhaustive
list):

```java
new int[] {           new int[] {
  0, 1, 2, 3            0,
}                       1,
                        2,
new int[] {             3,
  0, 1,               }
  2, 3
}                     new int[]
                          {0, 1, 2, 3}
```

<a id="s4.8.3.2-array-declarations"></a>

##### 4.8.3.2 No C-style array declarations

The square brackets form a part of the *type*, not the variable:
`String[] args`, not `String args[]`.

<a id="s4.8.4-switch"></a>

#### 4.8.4 Switch statements and expressions

For historical reasons, the Java language has two distinct syntaxes for
`switch`, which we can call *old-style* and *new-style*. New-style switches use
an arrow (`->`) after the switch labels, while old-style switches use a colon
(`:`).

**Terminology Note:** Inside the braces of a *switch block* are either one or
more *switch rules* (new-style); or one or more *statement groups* (old-style).
A *switch rule* consists of a *switch label* (`case ...` or `default`) followed
by `->` and an expression, block, or `throw`. A statement group consists of one
or more switch labels each followed by a colon, then one or more statements, or,
for the *last* statement group, *zero* or more statements. (These definitions
match the Java Language Specification,
[§14.11](https://docs.oracle.com/javase/specs/jls/se21/html/jls-14.html#jls-14.11).)

<a id="s4.8.4.1-switch-indentation"></a>

##### 4.8.4.1 Indentation

As with any other block, the contents of a switch block are indented +2. Each
switch label starts with this +2 indentation.

In a new-style switch, a switch rule can be written on a single line if it
otherwise follows Google style. (It must not exceed the column limit, and if it
contains a non-empty block then there must be a line break after `{`.) The
line-wrapping rules of [Section 4.5](#s4.5-line-wrapping) apply, including the
+4 indent for continuation lines. For a switch rule with a non-empty block after
the arrow, the same rules apply as for blocks elsewhere: lines between `{` and
`}` are indented a further +2 relative to the line with the switch label.

```java
switch (number) {
  case 0, 1 -> handleZeroOrOne();
  case 2 ->
      handleTwoWithAnExtremelyLongMethodCallThatWouldNotFitOnTheSameLine();
  default -> {
    logger.atInfo().log("Surprising number %s", number);
    handleSurprisingNumber(number);
  }
}
```

In an old-style switch, the colon of each switch label is followed by a line
break. The statements within a statement group are indented a further +2.

<a id="fallthrough"></a>

<a id="s4.8.4.2-switch-fall-through"></a>

##### 4.8.4.2 Fall-through: commented

Within an old-style switch block, each statement group either terminates
abruptly (with a `break`, `continue`, `return` or thrown exception), or is
marked with a comment to indicate that execution will or *might* continue into
the next statement group. Any comment that communicates the idea of fall-through
is sufficient (typically `// fall through`). This special comment is not
required in the last statement group of the switch block. Example:

```java
switch (input) {
  case 1:
  case 2:
    prepareOneOrTwo();
  // fall through
  case 3:
    handleOneTwoOrThree();
    break;
  default:
    handleLargeNumber(input);
}
```

Notice that no comment is needed after `case 1:`, only at the end of the
statement group.

There is no fall-through in new-style switches.

<a id="s4.8.4.3-switch-default"></a>

##### 4.8.4.3 Exhaustiveness and presence of the `default` label

The Java language requires switch expressions and many kinds of switch
statements to be *exhaustive*. That effectively means that every possible value
that could be switched on will be matched by one of the switch labels. A switch
is exhaustive if it has a `default` label, but also for example if the value
being switched on is an enum and every value of the enum is matched by a switch
label. Google Style requires *every* switch to be exhaustive, even those where
the language itself does not require it. This may require adding a `default`
label, even if it contains no code.

<a id="s4.8.4.4-switch-expressions"></a>

##### 4.8.4.4 Switch expressions

Switch expressions must be new-style switches:

```java
  return switch (list.size()) {
    case 0 -> "";
    case 1 -> list.getFirst();
    default -> String.join(", ", list);
  };
```

<a id="annotations"></a>

<a id="s4.8.5-annotations"></a>

#### 4.8.5 Annotations

<a id="s4.8.5.1-type-use-annotation-style"></a>

##### 4.8.5.1 Type-use annotations

Type-use annotations appear immediately before the annotated type. An annotation
is a type-use annotation if it is meta-annotated with
`@Target(ElementType.TYPE_USE)`. Example:

```java
final @Nullable String name;

public @Nullable Person getPersonByName(String name);
```

<a id="s4.8.5.2-class-annotation-style"></a>

##### 4.8.5.2 Class, package, and module annotations

Annotations applying to a class, package, or module declaration appear
immediately after the documentation block, and each annotation is listed on a
line of its own (that is, one annotation per line). These line breaks do not
constitute line-wrapping (Section 4.5, [Line-wrapping](#s4.5-line-wrapping)), so
the indentation level is not increased. Examples:

```java
/// This is a class.
@Deprecated
@CheckReturnValue
public final class Frozzler { ... }
```

```java
/// This is a package.
@Deprecated
@CheckReturnValue
package com.example.frozzler;
```

```java
/// This is a module.
@Deprecated
@SuppressWarnings("CheckReturnValue") // TODO(b/12345): Fix existing CRV violations.
module com.example.frozzler { ... }
```

<a id="s4.8.5.3-method-annotation-style"></a>

##### 4.8.5.3 Method and constructor annotations

The rules for annotations on method and constructor declarations are the same as
the [previous section](#s4.8.5.2-class-annotation-style). Example:

```java
@Deprecated
@Override
public String getNameIfPresent() { ... }
```

**Exception:** If the method or constructor only has a *single*, *parameterless*
annotation, it *may* appear together with the first line of the signature, for
example:

```java
@Override public int hashCode() { ... }
```

<a id="s4.8.5.4-field-annotation-style"></a>

##### 4.8.5.4 Field annotations

Annotations applying to a field also appear immediately after the documentation
block, but in this case, *multiple* annotations (possibly parameterized) may be
listed on the same line; for example:

```java
@Partial @Mock DataLoader loader;
```

<a id="s4.8.5.5-local-parameter-annotation-style"></a>

##### 4.8.5.5 Parameter and local variable annotations

There are no specific rules for formatting annotations on parameters or local
variables (except, of course, when the annotation is a type-use annotation).

<a id="comments"></a>

<a id="s4.8.6-comments"></a>

#### 4.8.6 Comments

This section addresses *implementation comments*. Javadoc is addressed
separately in Section 7, [Javadoc](#s7-javadoc).

Any line break may be preceded by arbitrary whitespace followed by an
implementation comment. Such a comment renders the line non-blank.

<a id="s4.8.6.1-block-comment-style"></a>

##### 4.8.6.1 Block comment style

Block comments are indented at the same level as the surrounding code. They may
be in `/* ... */` style or `// ...` style. For multi-line `/* ... */` comments,
subsequent lines must start with `*` aligned with the `*` on the previous line.

```java
/*
 * This is          // And so           /* Or you can
 * okay.            // is this.          * even do this. */
 */
```

Comments are not enclosed in boxes drawn with asterisks or other characters.

**Tip:** When writing multi-line comments, use the `/* ... */` style if you want
automatic code formatters to re-wrap the lines when necessary (paragraph-style).
Most formatters don't re-wrap lines in `// ...` style comment blocks.

<a id="todo"></a>

<a id="s4.8.6.2-todo-comments"></a>

##### 4.8.6.2 TODO comments

Use `TODO` comments for code that is temporary, a short-term solution, or
good-enough but not perfect.

A `TODO` comment begins with the word `TODO` in all caps, a following colon, and
a link to a resource that contains the context, ideally a bug reference. A bug
reference is preferable because bugs are tracked and have follow-up comments.
Follow this piece of context with an explanatory string introduced with a hyphen
`-`.

The purpose is to have a consistent `TODO` format that can be searched to find
out how to get more details.

<div class='goodcode'></div>

```java
// TODO: example.com/12345678 - Remove this after the 2047q4 compatibility window expires.
```

Avoid adding TODOs that refer to an individual or team as the context:

<div class='badcode'></div>

```java
// TODO: username - File an issue and use a '*' for repetition.
```

If your `TODO` is of the form "At a future date do something" make sure that you
either include a very specific date ("Fix by November 2005") or a very specific
event ("Remove this code when all clients can handle XML responses.").

<a id="modifiers"></a>

<a id="s4.8.7-modifiers"></a>

#### 4.8.7 Modifiers

Class and member modifiers, when present, appear in the order recommended by the
Java Language Specification:

```java
public protected private abstract default static final sealed non-sealed
  transient volatile synchronized native strictfp
```

Modifiers on `requires` module directives, when present, appear in the following
order:

```java
transitive static
```

<a id="s4.8.8-numeric-literals"></a>

#### 4.8.8 Numeric Literals

`long`-valued integer literals use an uppercase `L` suffix, never lowercase (to
avoid confusion with the digit `1`). For example, `3000000000L` rather than
`3000000000l`.

<a id="s4.8.9-text-blocks"></a>

#### 4.8.9 Text Blocks

The opening `"""` of a text block is always on a new line. That line may either
follow the same indentation rules as other constructs, or it may have no
indentation at all (so it starts at the left margin). The closing `"""` is on a
new line with the same indentation as the opening `"""`, and may be followed on
the same line by further code. Each line of text in the text block is indented
at least as much as the opening and closing `"""`. (If a line is indented
further, then the string literal defined by the text block will have space at
the start of that line.)

The contents of a text block may exceed the [column limit](#columnlimit).

<a id="naming"></a>

<a id="s5-naming"></a>

## 5 Naming

<a id="s5.1-identifier-names"></a>

### 5.1 Rules common to all identifiers

Identifiers use only ASCII letters and digits, and, in a small number of cases
noted below, underscores. Thus each valid identifier name is matched by the
regular expression `\w+` .

In Google Style, special prefixes or suffixes are **not** used. For example,
these names are not Google Style: `name_`, `mName`, `s_name` and `kName`.

<a id="s5.2-specific-identifier-names"></a>

### 5.2 Rules by identifier type

<a id="s5.2.1-package-names"></a>

#### 5.2.1 Package and module names

Package and module names use only lowercase letters and digits (no underscores).
Consecutive words are simply concatenated together. For example,
`com.example.deepspace`, not `com.example.deepSpace` or
`com.example.deep_space`.

<a id="s5.2.2-class-names"></a>

#### 5.2.2 Class names

Class names are written in [UpperCamelCase](#s5.3-camel-case).

Class names are typically nouns or noun phrases. For example, `Character` or
`ImmutableList`. Interface names may also be nouns or noun phrases (for example,
`List`), but may sometimes be adjectives or adjective phrases instead (for
example, `Readable`).

There are no specific rules or even well-established conventions for naming
annotation types.

A *test* class has a name that ends with `Test`, for example,
`HashIntegrationTest`. If it covers a single class, its name is the name of that
class plus `Test`, for example `HashImplTest`.

<a id="s5.2.3-method-names"></a>

#### 5.2.3 Method names

Method names are written in [lowerCamelCase](#s5.3-camel-case).

Method names are typically verbs or verb phrases. For example, `sendMessage` or
`stop`.

Underscores may appear in JUnit *test* method names to separate logical
components of the name, with *each* component written in
[lowerCamelCase](#s5.3-camel-case), for example
`transferMoney_deductsFromSource`. There is no One Correct Way to name test
methods.

<a id="constants"></a>

<a id="s5.2.4-constant-names"></a>

#### 5.2.4 Constant names

Constant names use `UPPER_SNAKE_CASE`: all uppercase letters, with each word
separated from the next by a single underscore. But what *is* a constant,
exactly?

Constants are static final fields whose contents are deeply immutable and whose
methods have no detectable side effects. Examples include primitives, strings,
immutable value classes, and anything set to `null`. If any of the instance's
observable state can change, it is not a constant. Merely *intending* to never
mutate the object is not enough. Examples:

```java
// Constants
static final int NUMBER = 5;
static final ImmutableList<String> NAMES = ImmutableList.of("Ed", "Ann");
static final Map<String, Integer> AGES = ImmutableMap.of("Ed", 35, "Ann", 32);
static final Joiner COMMA_JOINER = Joiner.on(','); // because Joiner is immutable
static final SomeMutableType[] EMPTY_ARRAY = {};

// Not constants
static String nonFinal = "non-final";
final String nonStatic = "non-static";
static final Set<String> mutableCollection = new HashSet<String>();
static final ImmutableSet<SomeMutableType> mutableElements = ImmutableSet.of(mutable);
static final ImmutableMap<String, SomeMutableType> mutableValues =
    ImmutableMap.of("Ed", mutableInstance, "Ann", mutableInstance2);
static final Logger logger = Logger.getLogger(MyClass.getName());
static final String[] nonEmptyArray = {"these", "can", "change"};
```

These names are typically nouns or noun phrases.

<a id="s5.2.5-non-constant-field-names"></a>

#### 5.2.5 Non-constant field names

Non-constant field names (static or otherwise) are written in
[lowerCamelCase](#s5.3-camel-case).

These names are typically nouns or noun phrases. For example, `computedValues`
or `index`.

<a id="s5.2.6-parameter-names"></a>

#### 5.2.6 Parameter names

Parameter names are written in [lowerCamelCase](#s5.3-camel-case).

One-character parameter names in public methods should be avoided.

<a id="s5.2.7-local-variable-names"></a>

#### 5.2.7 Local variable names

Local variable names are written in [lowerCamelCase](#s5.3-camel-case).

Even when final and immutable, local variables are not considered to be
constants, and should not be styled as constants.

<a id="s5.2.8-type-variable-names"></a>

#### 5.2.8 Type variable names

Each type variable is named in one of two styles:

*   A single capital letter, optionally followed by a single numeral (such as
    `E`, `T`, `X`, `T2`)
*   A name in the form used for classes (see Section 5.2.2,
    [Class names](#s5.2.2-class-names)), followed by the capital letter `T`
    (examples: `RequestT`, `FooBarT`).

<a id="s5.2.9-unnamed-variables"></a>

#### 5.2.9 Unnamed variables

The `_` syntax for unnamed variables and parameters is allowed wherever it is
applicable. For example:

```java
Predicate<String> alwaysTrue = _ -> true;
```

<a id="acronyms"></a>

<a id="camelcase"></a>

<a id="s5.3-camel-case"></a>

### 5.3 Camel case: defined

Sometimes there is more than one reasonable way to convert an English phrase
into camel case, such as when acronyms or unusual constructs like "IPv6" or
"iOS" are present. To improve predictability, Google Style specifies the
following (nearly) deterministic scheme.

Beginning with the prose form of the name:

1.  Convert the phrase to plain ASCII and remove any apostrophes. For example,
    "Müller's algorithm" might become "Muellers algorithm".

2.  Divide this result into words, splitting on spaces and any remaining
    punctuation (typically hyphens).

    *   *Recommended:* if any word already has a conventional camel-case
        appearance in common usage, split this into its constituent parts (e.g.,
        "AdWords" becomes "ad words"). Note that a word such as "iOS" is not
        really in camel case *per se*; it defies *any* convention, so this
        recommendation does not apply.

3.  Now lowercase *everything* (including acronyms), then uppercase only the
    first character of:

    *   ... each word, to yield *upper camel case*, or
    *   ... each word except the first, to yield *lower camel case*

4.  Finally, join all the words into a single identifier. Note that the casing
    of the original words is almost entirely disregarded.

In very rare circumstances (for example, multipart version numbers), you may
need to use underscores to separate adjacent numbers, since numbers do not have
upper and lower case variants.

Examples:

<!-- mdformat off -->

| Prose form              | Correct                                  | Incorrect           |
| :---------------------- | :--------------------------------------- | :------------------ |
| "XML HTTP request"      | `XmlHttpRequest`                         | `XMLHTTPRequest`    |
| "new customer ID"       | `newCustomerId`                          | `newCustomerID`     |
| "inner stopwatch"       | `innerStopwatch`                         | `innerStopWatch`    |
| "supports IPv6 on iOS?" | `supportsIpv6OnIos`                      | `supportsIPv6OnIOS` |
| "YouTube importer"      | `YouTubeImporter`<br>`YoutubeImporter`\* |                     |
| "Turn on 2SV"           | `turnOn2sv`                              | `turnOn2Sv`         |
| "Guava 33.4.6"          | `guava33_4_6`                            | `guava3346`         |

<!-- mdformat on -->

\*Acceptable, but not recommended.

**Note:** Some words are ambiguously hyphenated in the English language: for
example "nonempty" and "non-empty" are both correct, so the method names
`checkNonempty` and `checkNonEmpty` are likewise both correct.

<a id="s6-programming-practices"></a>

## 6 Programming Practices

<a id="s6.1-override-annotation"></a>

### 6.1 `@Override`: always used

A method is marked with the `@Override` annotation whenever it is legal. This
includes a class method overriding a superclass method, a class method
implementing an interface method, an interface method respecifying a
superinterface method, and an explicitly declared accessor method for a record
component.

**Exception:** `@Override` may be omitted when the parent method is
`@Deprecated`.

<a id="caughtexceptions"></a>

<a id="s6.2-caught-exceptions"></a>

### 6.2 Caught exceptions: not ignored

It is very rarely correct to do nothing in response to a caught exception.
(Typical responses are to log it, or if it is considered "impossible", rethrow
it as an `AssertionError`.)

When it truly is appropriate to take no action whatsoever in a catch block, the
reason this is justified is explained in a comment.

```java
try {
  int i = Integer.parseInt(response);
  return handleNumericResponse(i);
} catch (NumberFormatException _) {
  // it's not numeric; that's fine, just continue
}
return handleTextResponse(response);
```

<a id="s6.3-static-members"></a>

### 6.3 Static members: qualified using class

When a reference to a static class member must be qualified, it is qualified
with that class's name, not with a reference or expression of that class's type.

```java
Foo aFoo = ...;
Foo.aStaticMethod(); // good
aFoo.aStaticMethod(); // bad
somethingThatYieldsAFoo().aStaticMethod(); // very bad
```

<a id="finalizers"></a>

<a id="s6.4-finalizers"></a>

### 6.4 Finalizers: not used

Do not override `Object.finalize`. Finalization support is
[*scheduled for removal*](https://openjdk.org/jeps/421).

<a id="javadoc"></a>

<a id="s7-javadoc"></a>

## 7 Javadoc

<a id="s7.1-javadoc-formatting"></a>

### 7.1 Formatting

<a id="s7.1.1-javadoc-multi-line"></a>

#### 7.1.1 General form

Both Markdown Javadoc and Traditional Javadoc are acceptable. Markdown Javadoc
looks like this example:

```java
/// Javadoc text is written here,
/// wrapped normally...
public int method(String p1) { ... }
```

The *basic* formatting of Traditional Javadoc blocks is as seen in this example:

```java
/**
 * Multiple lines of Javadoc text are written here,
 * wrapped normally...
 */
public int method(String p1) { ... }
```

... or in this single-line example:

```java
/** An especially short bit of Javadoc. */
```

The basic form is always acceptable. The single-line form may be substituted
when the entirety of the Javadoc block (including comment markers) can fit on a
single line. Note that this only applies when there are no block tags such as
`@param`.

<a id="s7.1.2-javadoc-paragraphs"></a>

#### 7.1.2 Paragraphs

With Traditional Javadoc, one blank line—that is, a line containing only the
aligned leading asterisk (`*`)—appears between paragraphs, and before the group
of block tags if present. Each paragraph except the first has `<p>` immediately
before the first word, with no space after it. HTML tags for other block-level
elements, such as `<ul>` or `<table>`, are *not* preceded with `<p>`.

With Markdown Javadoc, paragraphs are separated as usual for Markdown, by a line
that is blank apart from the leading `///`. No `<p>` is needed.

<a id="s7.1.3-javadoc-at-clauses"></a> <!-- historical link -->

<a id="s7.1.3-javadoc-block-tags"></a>

#### 7.1.3 Block tags

Any of the standard "block tags" that are used appear in the order `@param`,
`@return`, `@throws`, `@deprecated`, and these four types never appear with an
empty description. When a block tag doesn't fit on a single line, continuation
lines are indented four (or more) spaces from the position of the `@` for
Traditional Javadoc, and exactly two spaces for Markdown Javadoc. (A four-space
indentation in Markdown is interpreted as an indented code block in some
contexts.)

<a id="s7.2-summary-fragment"></a>

### 7.2 The summary fragment

Each Javadoc block begins with a brief **summary fragment**. This fragment is
very important: it is the only part of the text that appears in certain contexts
such as class and method indexes.

This is a fragment—a noun phrase or verb phrase, not a complete sentence. It
does **not** begin with ``A `Foo` is a...``, or `This method returns...`, nor
does it form a complete imperative sentence like `Save the record.`. However,
the fragment is capitalized and punctuated as if it were a complete sentence.

**Tip:** A common mistake is to write simple Javadoc in the form
`/// @return the customer ID`. This is incorrect, and should be changed to
`/// Returns the customer ID.` or `/// {@return the customer ID}`.

<a id="s7.3.3-javadoc-optional"></a> <!-- historical link -->

<a id="s7.3-javadoc-where-required"></a>

### 7.3 Where Javadoc is used

At the *minimum*, Javadoc is present for every *visible* class, member, or
record component, with a few exceptions noted below. A top-level class is
visible if it is `public`; a member is visible if it is `public` or `protected`
and its containing class is visible; and a record component is visible if its
containing record is visible.

Additional Javadoc content may also be present, as explained in Section 7.3.4,
[Non-required Javadoc](#s7.3.4-javadoc-non-required).

<a id="s7.3.1-javadoc-exception-self-explanatory"></a>

#### 7.3.1 Exception: self-explanatory members

Javadoc is optional for "simple, obvious" members and record components, such as
a `getFoo()` method, *if* there *really and truly* is nothing else worthwhile to
say but "the foo".

**Important:** it is not appropriate to cite this exception to justify omitting
relevant information that a typical reader might need to know. For example, for
a record component named `canonicalName`, don't omit its documentation (with the
rationale that it would say only `@param canonicalName the canonical name`) if a
typical reader may have no idea what the term "canonical name" means!

<a id="s7.3.2-javadoc-exception-overrides"></a>

#### 7.3.2 Exception: overrides

Javadoc is not always present on a method that overrides a supertype method.

<a id="s7.3.4-javadoc-non-required"></a>

#### 7.3.4 Non-required Javadoc

Other classes, members, and record components have Javadoc *as needed or
desired*.

Whenever an implementation comment would be used to define the overall purpose
or behavior of a class or member, that comment is written as Javadoc instead
(using `///` or `/**`).

Non-required Javadoc is not strictly required to follow the formatting rules of
Sections 7.1.1, 7.1.2, 7.1.3, and 7.2, though it is of course recommended.

<!-- NB: Keep this at the end of the file. See comment at top for details.
     {% endraw %} -->
