Package com.google.googlejavaformat.java

Class JavaFormatterOptions

java.lang.Object

com.google.googlejavaformat.java.JavaFormatterOptions

@Immutable
public class JavaFormatterOptions
extends Object

Options for a google-java-format invocation.

Like gofmt, the google-java-format CLI exposes no configuration options (aside from --aosp).

The goal of google-java-format is to provide consistent formatting, and to free developers from arguments over style choices. It is an explicit non-goal to support developers' individual preferences, and in fact it would work directly against our primary goals.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JavaFormatterOptions.Builder	A builder for JavaFormatterOptions.
static enum	JavaFormatterOptions.Style

Method Summary

Modifier and Type	Method	Description
static JavaFormatterOptions.Builder	builder()	Returns a builder for JavaFormatterOptions.
static JavaFormatterOptions	defaultOptions()	Returns the default formatting options.
boolean	formatJavadoc()
int	indentationMultiplier()	Returns the multiplier for the unit of indent.
JavaFormatterOptions.Style	style()	Returns the code style.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

indentationMultiplier

public int indentationMultiplier()

Returns the multiplier for the unit of indent.

formatJavadoc

public boolean formatJavadoc()

style

public JavaFormatterOptions.Style style()

Returns the code style.

defaultOptions

public static JavaFormatterOptions defaultOptions()

Returns the default formatting options.

builder

public static JavaFormatterOptions.Builder builder()

Returns a builder for JavaFormatterOptions.