com.google.googlejavaformat.java.CommandLineOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-java-format Show documentation
A Java source code formatter that follows Google Java Style.
There is a newer version: 1.25.0
/*
 * Copyright 2016 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */

package com.google.googlejavaformat.java;

import com.google.auto.value.AutoValue;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableRangeSet;

/** Command line options for google-java-format. */
@AutoValue
abstract class CommandLineOptions {

  /** The files to format. */
  abstract ImmutableList files();

  /** Format files in place. */
  abstract boolean inPlace();

  /** Line ranges to format. */
  abstract ImmutableRangeSet lines();

  /** Character offsets for partial formatting, paired with {@code lengths}. */
  abstract ImmutableList offsets();

  /** Partial formatting region lengths, paired with {@code offsets}. */
  abstract ImmutableList lengths();

  /** Use AOSP style instead of Google Style (4-space indentation). */
  abstract boolean aosp();

  /** Print the version. */
  abstract boolean version();

  /** Print usage information. */
  abstract boolean help();

  /** Format input from stdin. */
  abstract boolean stdin();

  /** Fix imports, but do no formatting. */
  abstract boolean fixImportsOnly();

  /**
   * When fixing imports, remove imports that are used only in javadoc and fully-qualify any
   * {@code @link} tags referring to the imported types.
   */
  abstract boolean removeJavadocOnlyImports();

  /** Returns true if partial formatting was selected. */
  boolean isSelection() {
    return !lines().isEmpty() || !offsets().isEmpty() || !lengths().isEmpty();
  }

  static Builder builder() {
    return new AutoValue_CommandLineOptions.Builder()
        .inPlace(false)
        .aosp(false)
        .version(false)
        .help(false)
        .stdin(false)
        .fixImportsOnly(false)
        .removeJavadocOnlyImports(false);
  }

  @AutoValue.Builder
  abstract static class Builder {
    abstract Builder inPlace(boolean inPlace);

    abstract ImmutableList.Builder filesBuilder();

    abstract ImmutableRangeSet.Builder linesBuilder();

    abstract ImmutableList.Builder offsetsBuilder();

    abstract ImmutableList.Builder lengthsBuilder();

    abstract Builder aosp(boolean aosp);

    abstract Builder version(boolean version);

    abstract Builder help(boolean help);

    abstract Builder stdin(boolean stdin);

    abstract Builder fixImportsOnly(boolean fixImportsOnly);

    abstract Builder removeJavadocOnlyImports(boolean removeJavadocOnlyImports);

    abstract CommandLineOptions build();
  }
}