| Type | Convention | Example |
|------|-----------|---------|
| Classes/Interfaces | PascalCase | `SuggestIndexer`, `ReadingConverter` |
| Methods | camelCase | `createIndexIfNothing()` |
| Constants | UPPER_SNAKE_CASE | `DEFAULT_MAX_READING_NUM` |
| Packages | lowercase | `org.codelibs.fess.suggest` |

### JavaDoc Requirements

All public classes and methods require JavaDoc with `@param`, `@return`, and `@throws` tags.

    void testTargetPath() {
        Build build = mock(Build.class);
        when(build.getDirectory()).thenReturn("target");
        when(build.getOutputDirectory()).thenReturn("target/classes");
        when(build.getTestOutputDirectory()).thenReturn("target/test-classes");

        Project project = mock(Project.class);
        when(project.getBuild()).thenReturn(build);
        when(project.getBasedir()).thenReturn(Path.of("myproject"));

 * which processes classes annotated with {@link org.apache.maven.api.di.Named} and creates an index file
 * that allows for efficient discovery of injectable components at runtime.
 * <p>
 * The generated index is stored at {@code META-INF/maven/org.apache.maven.api.di.Inject} and contains
 * the fully qualified names of all classes annotated with {@code @Named}.
 *
 * @since 4.0.0
 */

  </properties>

  <build>
    <directory>${project.basedir}/target</directory>
    <outputDirectory>${project.build.directory}/classes</outputDirectory>
    <finalName>${project.artifactId}-${project.version}</finalName>
    <testOutputDirectory>${project.build.directory}/test-classes</testOutputDirectory>
    <sourceDirectory>${project.basedir}/src/main/java</sourceDirectory>

 * specific language governing permissions and limitations
 * under the License.
 */

/**
 * Maven Immutable POM (Project Object Model) classes, generated from <code>maven.mdo</code> model.
 * <p>
 * This package contains the data model classes that represent the structure of Maven POM files.
 * These classes are immutable to ensure thread safety and prevent unintended modifications.

 * classes and the classes they depend on. The classes are not relocated, they all
 * remain in their original namespace. This reduces the final Gradle distribution
 * size and makes us more conscious of which parts of a library we really need.
 *
 * WARNING: if you decide to do the minification by hand, make sure that you cover all paths of loading classes:

 *   <li>{@link Stopwatch}
 *   <li>{@link Throwables}
 *   <li>{@link Verify}
 * </ul>
 *
 * <h3>The rest</h3>
 *
 * This package also contains some classes with niche use cases (e.g., {@link Utf8} and {@link
 * Defaults}), as well as a number of classes that have been superseded by additions to the JDK.
 */
@CheckReturnValue
@NullMarked
package com.google.common.base;

# Custom Response Classes - File, HTML, Redirect, Streaming, etc.

There are several custom response classes you can use to create an instance and return them directly from your *path operations*.

Read more about it in the [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/).

You can import them directly from `fastapi.responses`:

```python
from fastapi.responses import (
    FileResponse,

    shadowPackage: String
) {

    private
    val classes: MutableMap<String, ClassDetails> = linkedMapOf()

    val entryPoints: MutableSet<ClassDetails> = linkedSetOf()

    val shadowPackagePrefix =
        shadowPackage.takeIf(String::isNotEmpty)
            ?.let { it.replace('.', '/') + "/" }
            ?: ""

    operator fun get(className: String) =
        classes.computeIfAbsent(className) {

import org.jspecify.annotations.NullUnmarked;

/** Basic sanity tests for classes in {@code common.base}. */

@GwtIncompatible
@NullUnmarked
public class PackageSanityTests extends AbstractPackageSanityTests {
  public PackageSanityTests() {
    // package private classes like FunctionalEquivalence are tested through the public API.
    publicApiOnly();
  }