A B C D E F G H I J L M N O P R S T U V W Y Z

A

actualSize(int, int) - Method in class com.palantir.javaformat.OpsBuilder

actualStartColumn(int) - Method in class com.palantir.javaformat.OpsBuilder

add(DocBuilder) - Method in enum com.palantir.javaformat.CloseOp

add(DocBuilder) - Method in class com.palantir.javaformat.doc.Break

add(DocBuilder) - Method in class com.palantir.javaformat.doc.Comment

add(DocBuilder) - Method in class com.palantir.javaformat.doc.NonBreakingSpace

add(DocBuilder) - Method in class com.palantir.javaformat.doc.Token

add(DocBuilder) - Method in interface com.palantir.javaformat.Op

Add an Op to a DocBuilder.

add(DocBuilder) - Method in class com.palantir.javaformat.OpenOp

addAll(List<Op>) - Method in class com.palantir.javaformat.OpsBuilder

Add a list of Ops.

append(State, String, Range<Integer>) - Method in class com.palantir.javaformat.java.JavaOutput

append(State, String, Range<Integer>) - Method in class com.palantir.javaformat.Output

Output a string.

applyReplacements(String, Collection<Replacement>) - Static method in class com.palantir.javaformat.Utils

B

blankLine(int, OpsBuilder.BlankLineWanted) - Method in class com.palantir.javaformat.java.InputMetadataBuilder

A blank line is or is not wanted here.

blankLines() - Method in interface com.palantir.javaformat.java.InputMetadata

Remembers preferences from the input about whether blank lines are wanted or not at a given token index.

blankLineWanted(OpsBuilder.BlankLineWanted) - Method in class com.palantir.javaformat.OpsBuilder

Force or suppress a blank line here in the output.

BlankLineWanted() - Constructor for class com.palantir.javaformat.OpsBuilder.BlankLineWanted

branchingCoefficient() - Method in class com.palantir.javaformat.doc.State

Counts how many times reached a branch, where multiple formattings would be considered.

Break - Class in com.palantir.javaformat.doc

A leaf node in a Doc for an optional break.

Break() - Constructor for class com.palantir.javaformat.doc.Break

Break.Builder - Class in com.palantir.javaformat.doc

breakabilityIfLastLevel() - Method in class com.palantir.javaformat.OpenOp

If it's the last level of its parent, when to inline this level rather than break the parent.

breakAndIndentTrailingComment() - Method in class com.palantir.javaformat.doc.Token

Force a line break and indent trailing javadoc or block comments.

BreakBehaviour - Class in com.palantir.javaformat

BreakBehaviour() - Constructor for class com.palantir.javaformat.BreakBehaviour

breakBehaviour() - Method in class com.palantir.javaformat.OpenOp

When this level doesn't fit on one line, controls whether this level is to be broken (its breaks taken) or partially inlined onto the current line.

BreakBehaviour.Cases<R> - Interface in com.palantir.javaformat

breakOnlyIfInnerLevelsThenFitOnOneLine(boolean) - Method in interface com.palantir.javaformat.BreakBehaviour.Cases

Break if by doing so all inner levels then fit on a single line.

breakOp() - Method in class com.palantir.javaformat.OpsBuilder

Emit a Break.

breakOp(Indent) - Method in class com.palantir.javaformat.OpsBuilder

Emit a Break.

breakOp(String) - Method in class com.palantir.javaformat.OpsBuilder

Emit a Break, with a specified flat value (e.g., " ").

breakOp(FillMode, String, Indent) - Method in class com.palantir.javaformat.OpsBuilder

Emit a generic Break.

breakOp(FillMode, String, Indent, Optional<BreakTag>) - Method in class com.palantir.javaformat.OpsBuilder

Emit a generic Break.

breakOp(Break) - Method in class com.palantir.javaformat.OpsBuilder

Emit a self-built Break.

breakStates() - Method in class com.palantir.javaformat.doc.State

BreakTag - Class in com.palantir.javaformat.doc

Unique identifier for a break.

BreakTag() - Constructor for class com.palantir.javaformat.doc.BreakTag

breakTagsTaken() - Method in class com.palantir.javaformat.doc.State

breakThisLevel() - Method in interface com.palantir.javaformat.BreakBehaviour.Cases

breakToFill() - Method in class com.palantir.javaformat.OpsBuilder

Emit a filled Break.

breakToFill(String) - Method in class com.palantir.javaformat.OpsBuilder

Emit a Break, with a specified flat value (e.g., " ").

build() - Method in class com.palantir.javaformat.doc.DocBuilder

Return the Doc.

build() - Method in class com.palantir.javaformat.java.InputMetadataBuilder

build() - Method in class com.palantir.javaformat.OpsBuilder

Build a list of Ops from the OpsBuilder.

builder() - Static method in class com.palantir.javaformat.doc.Break

Builder() - Constructor for class com.palantir.javaformat.doc.Break.Builder

builder() - Static method in class com.palantir.javaformat.doc.State

Builder() - Constructor for class com.palantir.javaformat.doc.State.Builder

builder() - Static method in class com.palantir.javaformat.OpenOp

Builder() - Constructor for class com.palantir.javaformat.OpenOp.Builder

C

characterRangesToTokenRanges(Collection<Range<Integer>>) - Method in class com.palantir.javaformat.java.JavaInput

checkClosed(int) - Method in class com.palantir.javaformat.OpsBuilder

Checks that all open ops in the op stream have matching close ops.

close() - Method in class com.palantir.javaformat.doc.DocBuilder

Close the current Level.

close() - Method in class com.palantir.javaformat.OpsBuilder

Close the current level, by emitting a CloseOp.

CloseOp - Enum in com.palantir.javaformat

A CloseOp closes a level.

column() - Method in class com.palantir.javaformat.doc.State

columnLimitBeforeLastBreak() - Method in class com.palantir.javaformat.OpenOp

Custom max column limit that contents of this level before the last break may not exceed.

com.palantir.javaformat - package com.palantir.javaformat

com.palantir.javaformat.doc - package com.palantir.javaformat.doc

com.palantir.javaformat.java - package com.palantir.javaformat.java

com.palantir.javaformat.java.javadoc - package com.palantir.javaformat.java.javadoc

Comment - Class in com.palantir.javaformat.doc

A leaf node in a Doc for a non-token.

CommentsHelper - Interface in com.palantir.javaformat

Rewrite comments.

complexity() - Method in class com.palantir.javaformat.OpenOp

A level is "simple" if it doesn't have multiple parameters (in the case of a method call), or multiple chained method calls.

computeBreaks(State, boolean) - Method in class com.palantir.javaformat.doc.Break

computeBreaks(CommentsHelper, int, State, Obs.ExplorationNode) - Method in class com.palantir.javaformat.doc.Break

computeBreaks(CommentsHelper, int, State, Obs.ExplorationNode) - Method in class com.palantir.javaformat.doc.Comment

computeBreaks(CommentsHelper, int, State, Obs.ExplorationNode) - Method in class com.palantir.javaformat.doc.Doc

Make breaking decisions for a Doc.

computeBreaks(CommentsHelper, int, State, Obs.ExplorationNode) - Method in class com.palantir.javaformat.doc.Level

computeBreaks(CommentsHelper, int, State, Obs.ExplorationNode) - Method in class com.palantir.javaformat.doc.NonBreakingSpace

computeBreaks(CommentsHelper, int, State, Obs.ExplorationNode) - Method in class com.palantir.javaformat.doc.Token

computeFlat() - Method in class com.palantir.javaformat.doc.Break

computeFlat() - Method in class com.palantir.javaformat.doc.Comment

computeFlat() - Method in class com.palantir.javaformat.doc.Doc

Compute the Doc's flat value.

computeFlat() - Method in class com.palantir.javaformat.doc.Level

computeFlat() - Method in class com.palantir.javaformat.doc.NonBreakingSpace

computeFlat() - Method in class com.palantir.javaformat.doc.Token

computeRange() - Method in class com.palantir.javaformat.doc.Break

computeRange() - Method in class com.palantir.javaformat.doc.Comment

computeRange() - Method in class com.palantir.javaformat.doc.Doc

Compute the Doc's Range of Input.Tokens.

computeRange() - Method in class com.palantir.javaformat.doc.Level

computeRange() - Method in class com.palantir.javaformat.doc.NonBreakingSpace

computeRange() - Method in class com.palantir.javaformat.doc.Token

computeRanges(List<? extends Input.Tok>) - Method in class com.palantir.javaformat.InputOutput

computeWidth() - Method in class com.palantir.javaformat.doc.Break

computeWidth() - Method in class com.palantir.javaformat.doc.Comment

computeWidth() - Method in class com.palantir.javaformat.doc.Doc

Compute the Doc's width.

computeWidth() - Method in class com.palantir.javaformat.doc.Level

computeWidth() - Method in class com.palantir.javaformat.doc.NonBreakingSpace

computeWidth() - Method in class com.palantir.javaformat.doc.Token

conditional(BreakTag) - Static method in class com.palantir.javaformat.OpsBuilder.BlankLineWanted

Emit a blank line if the given break is taken.

containsBreaks(String) - Static method in class com.palantir.javaformat.Newlines

Returns true if the input contains any line breaks.

count(String) - Static method in class com.palantir.javaformat.Newlines

Returns the number of line breaks in the input.

create() - Static method in class com.palantir.javaformat.java.Formatter

A new Formatter instance with default options.

createDiagnostic(int, String) - Method in class com.palantir.javaformat.Input

Construct a diagnostic.

createFormatter(JavaFormatterOptions) - Static method in class com.palantir.javaformat.java.Formatter

createRoot(Obs.Sink) - Static method in class com.palantir.javaformat.doc.Obs

D

debugName() - Method in class com.palantir.javaformat.OpenOp

DebugRenderer - Class in com.palantir.javaformat.java

DebugRenderer() - Constructor for class com.palantir.javaformat.java.DebugRenderer

depth() - Method in class com.palantir.javaformat.OpsBuilder

Returns the number of unclosed open ops in the input stream.

diagnostic(String) - Method in class com.palantir.javaformat.OpsBuilder

Create a FormatterDiagnostic at the current position.

diagnostics() - Method in error com.palantir.javaformat.FormattingError

Doc - Class in com.palantir.javaformat.doc

JavaInputAstVisitor outputs a sequence of Ops using OpsBuilder.

Doc() - Constructor for class com.palantir.javaformat.doc.Doc

DocBuilder - Class in com.palantir.javaformat.doc

A DocBuilder converts a sequence of Ops into a Doc.

DocBuilder() - Constructor for class com.palantir.javaformat.doc.DocBuilder

Start to build a DocBuilder.

DocVisitor<T> - Interface in com.palantir.javaformat.doc

drain() - Method in class com.palantir.javaformat.OpsBuilder

Output any remaining tokens from the input stream (e.g.

E

EMPTY_RANGE - Static variable in class com.palantir.javaformat.InputOutput

endTok(Input.Token) - Static method in class com.palantir.javaformat.java.JavaOutput

The last non-whitespace Tok in the Token.

eval(State) - Method in class com.palantir.javaformat.Indent.Const

eval(State) - Method in class com.palantir.javaformat.Indent

eval(State) - Method in class com.palantir.javaformat.Indent.If

evalPlusIndent(State) - Method in class com.palantir.javaformat.doc.Break

Return the Break's extra indent.

F

fillMode() - Method in class com.palantir.javaformat.doc.Break

FillMode - Enum in com.palantir.javaformat.doc

Each Break in a Level is either FillMode.UNIFIED or FillMode.INDEPENDENT.

finishNode(Level, State) - Method in interface com.palantir.javaformat.doc.Obs.FinishExplorationNode

Indicate that the exploration node was successful and produced this newState

finishNode(int) - Method in interface com.palantir.javaformat.doc.Obs.FinishLevelNode

firstBreak(String) - Static method in class com.palantir.javaformat.Newlines

Returns the index of the first break in the input, or -1.

flat() - Method in class com.palantir.javaformat.doc.Break

forcedBreak() - Method in class com.palantir.javaformat.OpsBuilder

Emit a forced Break.

forcedBreak(Indent) - Method in class com.palantir.javaformat.OpsBuilder

Emit a forced Break.

format(String...) - Method in class com.palantir.javaformat.java.Main

The main entry point for the formatter, with some number of file names to format.

formatJavadoc(String, int) - Method in class com.palantir.javaformat.java.javadoc.JavadocFormatter

Formats the given Javadoc comment, which must start with ∕✱✱ and end with ✱∕.

formatSource(CharSource, CharSink) - Method in class com.palantir.javaformat.java.Formatter

Format the given input (a Java compilation unit) into the output stream.

formatSource(String) - Method in class com.palantir.javaformat.java.Formatter

Format an input string (a Java compilation unit) into an output string.

formatSource(String, Collection<Range<Integer>>) - Method in class com.palantir.javaformat.java.Formatter

Format an input string (a Java compilation unit), for only the specified character ranges.

formatSourceAndFixImports(String) - Method in class com.palantir.javaformat.java.Formatter

Formats an input string (a Java compilation unit) and fixes imports.

formatSourceReflowStringsAndFixImports(String) - Method in class com.palantir.javaformat.java.FormatterServiceImpl

Formatter - Class in com.palantir.javaformat.java

This is google-java-format, a new Java formatter that follows the Google Java Style Guide quite precisely---to the letter and to the spirit.

FormatterServiceImpl - Class in com.palantir.javaformat.java

FormatterServiceImpl() - Constructor for class com.palantir.javaformat.java.FormatterServiceImpl

FormattingError - Error in com.palantir.javaformat

An unchecked formatting error.

FormattingError(FormatterDiagnostic) - Constructor for error com.palantir.javaformat.FormattingError

FormattingError(Iterable<FormatterDiagnostic>) - Constructor for error com.palantir.javaformat.FormattingError

G

getBreakState(Break) - Method in class com.palantir.javaformat.doc.State

getColumn() - Method in interface com.palantir.javaformat.Input.Tok

Return the Tok's 0-based column number.

getColumnLimitBeforeLastBreak() - Method in class com.palantir.javaformat.doc.Level

An optional, more restrictive column limit for inner breaks that are marked as Break.hasColumnLimit().

getColumnNumber(int) - Method in class com.palantir.javaformat.Input

Converts a character offset in the input to a 0-based column number.

getColumnNumber(int) - Method in class com.palantir.javaformat.java.JavaInput

getDebugName() - Method in class com.palantir.javaformat.doc.Level

getFlat() - Method in class com.palantir.javaformat.doc.Doc

Return a Doc's flat-string value; not defined (and never called) if the (@code Doc} contains forced breaks.

getFormatReplacements(String, Collection<Range<Integer>>) - Method in class com.palantir.javaformat.java.Formatter

Emit a list of Replacements to convert from input to output.

getFormatReplacements(String, Collection<Range<Integer>>) - Method in class com.palantir.javaformat.java.FormatterServiceImpl

getFormatReplacements(RangeSet<Integer>) - Method in class com.palantir.javaformat.java.JavaOutput

Emit a list of Replacements to convert from input to output.

getIndex() - Method in interface com.palantir.javaformat.Input.Tok

Return the Tok's index.

getInput() - Method in class com.palantir.javaformat.OpsBuilder

Get the OpsBuilder's Input.

getLine(int) - Method in class com.palantir.javaformat.InputOutput

Get a line.

getLineCount() - Method in class com.palantir.javaformat.InputOutput

Get the line count.

getLineEnding(String) - Static method in class com.palantir.javaformat.Newlines

Returns the terminating line break in the input, or null if the input does not end in a break.

getLineNumber(int) - Method in class com.palantir.javaformat.Input

Converts a character offset in the input to a line number.

getLineNumber(int) - Method in class com.palantir.javaformat.java.JavaInput

getLineSeparator() - Method in class com.palantir.javaformat.java.JavaInput

getOpenOp() - Method in class com.palantir.javaformat.doc.Level

getOriginalText() - Method in interface com.palantir.javaformat.Input.Tok

The Tok's original text (before processing escapes).

getOutput() - Method in class com.palantir.javaformat.doc.NoopSink

getOutput() - Method in interface com.palantir.javaformat.doc.Obs.Sink

getOutput() - Method in class com.palantir.javaformat.java.JsonSink

getPlusIndent() - Method in class com.palantir.javaformat.doc.Level

getPlusIndentCommentsBefore() - Method in class com.palantir.javaformat.doc.Token

How much extra to indent comments before the Token.

getPosition() - Method in interface com.palantir.javaformat.Input.Tok

Return the Tok's 0-based position.

getPositionToColumnMap() - Method in class com.palantir.javaformat.Input

getPositionToColumnMap() - Method in class com.palantir.javaformat.java.JavaInput

getPositionTokenMap() - Method in class com.palantir.javaformat.Input

A map from [start, end] position ranges to Input.Tokens.

getPositionTokenMap() - Method in class com.palantir.javaformat.java.JavaInput

Get the navigable map from position to Token.

getRanges(int) - Method in class com.palantir.javaformat.InputOutput

Get the Range of Input.Toks lying in any part on a line.

getText() - Method in class com.palantir.javaformat.Input

getText() - Method in interface com.palantir.javaformat.Input.Tok

The Tok's text.

getText() - Method in class com.palantir.javaformat.java.JavaInput

Get the input text.

getTok() - Method in interface com.palantir.javaformat.Input.Token

Get the token's Input.Tok.

getToken() - Method in class com.palantir.javaformat.doc.Token

Return the wrapped Input.Token.

getTokens() - Method in class com.palantir.javaformat.Input

Get the input tokens.

getTokens() - Method in class com.palantir.javaformat.java.JavaInput

Get the input tokens.

getToksAfter() - Method in interface com.palantir.javaformat.Input.Token

Get the later Input.Toks assigned to this Token.

getToksBefore() - Method in interface com.palantir.javaformat.Input.Token

Get the earlier Input.Toks assigned to this Token.

guessLineSeparator(String) - Static method in class com.palantir.javaformat.Newlines

Returns the first line separator in the text, or "\n" if the text does not contain a single line separator.

guessToken(String) - Method in class com.palantir.javaformat.OpsBuilder

Emit an optional token iff it exists on the input.

H

hasColumnLimit() - Method in class com.palantir.javaformat.doc.Break

If this break is restricted by its parent Level's Level.getColumnLimitBeforeLastBreak().

hasNewlineAt(String, int) - Static method in class com.palantir.javaformat.Newlines

Returns the length of the newline sequence at the current offset, or -1.

HasUniqueId - Class in com.palantir.javaformat.doc

This class exists in order to provide a stable Ord implementation for Doc and BreakTag, so that we can store them inside ordered immutable types like Set and HashMap.

HasUniqueId() - Constructor for class com.palantir.javaformat.doc.HasUniqueId

I

id() - Method in class com.palantir.javaformat.doc.HasUniqueId

id() - Method in interface com.palantir.javaformat.doc.Obs.ExplorationNode

ImportOrderer - Class in com.palantir.javaformat.java

Orders imports in Java source code.

indent() - Method in class com.palantir.javaformat.doc.State

Next indent, if the level is about to be broken.

Indent - Class in com.palantir.javaformat

An indent for a Level or Break.

Indent() - Constructor for class com.palantir.javaformat.Indent

indent(int) - Method in class com.palantir.javaformat.java.JavaOutput

indent(int) - Method in class com.palantir.javaformat.Output

Indent by outputting indent spaces.

Indent.Const - Class in com.palantir.javaformat

A constant function, returning a constant indent.

Indent.If - Class in com.palantir.javaformat

A conditional function, whose value depends on whether a break was taken.

inlineSuffix() - Method in interface com.palantir.javaformat.BreakBehaviour.Cases

Attempt to inline the suffix of this level (which must be a Level and the last doc), recursing into the Level just before the last Level (if there is such a level) to see if that can be broken instead.

Input - Class in com.palantir.javaformat

An input to the formatter.

Input() - Constructor for class com.palantir.javaformat.Input

Input.Tok - Interface in com.palantir.javaformat

A Tok ("tock") is a token, or a comment, or a newline, or a maximal string of blanks.

Input.Token - Interface in com.palantir.javaformat

A Token is a language-level token.

InputMetadata - Interface in com.palantir.javaformat.java

Records metadata about the input, namely existing blank lines that we might want to preserve, as well as what ranges can be partially formatted.

inputMetadata() - Method in interface com.palantir.javaformat.OpsBuilder.OpsOutput

InputMetadataBuilder - Class in com.palantir.javaformat.java

InputMetadataBuilder() - Constructor for class com.palantir.javaformat.java.InputMetadataBuilder

InputOutput - Class in com.palantir.javaformat

This interface defines methods common to an Input or an Output.

InputOutput() - Constructor for class com.palantir.javaformat.InputOutput

isComment() - Method in interface com.palantir.javaformat.Input.Tok

Is the Tok a comment?

isForced() - Method in class com.palantir.javaformat.doc.Break

Is the Break forced?

isJavadocComment() - Method in interface com.palantir.javaformat.Input.Tok

Is the Tok a javadoc comment?

isNewline() - Method in interface com.palantir.javaformat.Input.Tok

Is the Tok a newline?

isNewline(String) - Static method in class com.palantir.javaformat.Newlines

Returns true if the entire input string is a recognized line break.

isSimple(boolean) - Method in class com.palantir.javaformat.OpenOp.Builder

isSlashSlashComment() - Method in interface com.palantir.javaformat.Input.Tok

Is the Tok a "//" comment?

isSlashStarComment() - Method in interface com.palantir.javaformat.Input.Tok

Is the Tok a "//" comment?

J

JavaCommentsHelper - Class in com.palantir.javaformat.java

JavaCommentsHelper extends CommentsHelper to rewrite Java comments.

JavaCommentsHelper(String, JavaFormatterOptions, JavaFormatterInternalOptions) - Constructor for class com.palantir.javaformat.java.JavaCommentsHelper

JavadocFormatter - Class in com.palantir.javaformat.java.javadoc

Entry point for formatting Javadoc.

JavadocFormatter(int) - Constructor for class com.palantir.javaformat.java.javadoc.JavadocFormatter

JavaInput - Class in com.palantir.javaformat.java

JavaInput extends Input to represent a Java input document.

JavaInput(String) - Constructor for class com.palantir.javaformat.java.JavaInput

Input constructor.

JavaInputAstVisitor - Class in com.palantir.javaformat.java

An AST visitor that builds a stream of Ops to format from the given CompilationUnitTree.

JavaInputAstVisitor(OpsBuilder, int) - Constructor for class com.palantir.javaformat.java.JavaInputAstVisitor

The Visitor constructor.

JavaOutput - Class in com.palantir.javaformat.java

JavaOutput extends Output to represent a Java output document.

JavaOutput(JavaInput, InputMetadata) - Constructor for class com.palantir.javaformat.java.JavaOutput

JavaOutput constructor.

JsonDocVisitor - Class in com.palantir.javaformat.doc

JsonDocVisitor(State) - Constructor for class com.palantir.javaformat.doc.JsonDocVisitor

JsonSink - Class in com.palantir.javaformat.java

JsonSink() - Constructor for class com.palantir.javaformat.java.JsonSink

L

lastIndent() - Method in class com.palantir.javaformat.doc.State

Last indent that was actually taken.

LastLevelBreakability - Enum in com.palantir.javaformat

How to decide whether to break the last inner level ("this level") of a parent level with BreakBehaviour.Cases.preferBreakingLastInnerLevel(boolean).

length() - Method in interface com.palantir.javaformat.Input.Tok

The length of the Tok's original text.

Level - Class in com.palantir.javaformat.doc

A Level inside a Doc.

LevelDelimitedFlatValueDocVisitor - Class in com.palantir.javaformat.doc

LevelDelimitedFlatValueDocVisitor(State) - Constructor for class com.palantir.javaformat.doc.LevelDelimitedFlatValueDocVisitor

levelStates() - Method in class com.palantir.javaformat.doc.State

lineIterator(String) - Static method in class com.palantir.javaformat.Newlines

Returns an iterator over lines in the input, including trailing whitespace.

lineOffsetIterator(String) - Static method in class com.palantir.javaformat.Newlines

Returns an iterator over the start offsets of lines in the input.

lineRangesToCharRanges(String, RangeSet<Integer>) - Static method in class com.palantir.javaformat.Utils

Converts zero-indexed, [closed, open) line ranges in the given source file to character ranges.

M

Main - Class in com.palantir.javaformat.java

The main class for the Java formatter CLI.

Main(PrintWriter, PrintWriter, InputStream) - Constructor for class com.palantir.javaformat.java.Main

main(String[]) - Static method in class com.palantir.javaformat.java.Main

The main method for the formatter, with some number of file names to format.

make() - Static method in enum com.palantir.javaformat.CloseOp

Make a CloseOp, returning a singleton since they are all the same.

make(FillMode, String, Indent) - Static method in class com.palantir.javaformat.doc.Break

Make a Break.

make(FillMode, String, Indent, Optional<BreakTag>) - Static method in class com.palantir.javaformat.doc.Break

Make a Break.

make(Input.Tok) - Static method in class com.palantir.javaformat.doc.Comment

Factory method for a Tok.

make() - Static method in class com.palantir.javaformat.doc.NonBreakingSpace

make(Input.Token, Token.RealOrImaginary, Indent, Optional<Indent>) - Static method in class com.palantir.javaformat.doc.Token

Make a Token.

make(int, int) - Static method in class com.palantir.javaformat.Indent.Const

make(BreakTag, Indent, Indent) - Static method in class com.palantir.javaformat.Indent.If

make(Indent) - Static method in class com.palantir.javaformat.OpenOp

Make an ordinary OpenOp.

makeForced() - Static method in class com.palantir.javaformat.doc.Break

Make a forced Break.

makeKToIJ(InputOutput) - Static method in class com.palantir.javaformat.InputOutput

Given an InputOutput, compute the map from tok indices to line ranges.

markForPartialFormat(Input.Token, Input.Token) - Method in class com.palantir.javaformat.java.InputMetadataBuilder

Marks a region that can be partially formatted.

markForPartialFormat() - Method in class com.palantir.javaformat.OpsBuilder

Make the boundary of a region that can be partially formatted.

match(BreakBehaviour.Cases<R>) - Method in class com.palantir.javaformat.BreakBehaviour

merge(OpsBuilder.BlankLineWanted) - Method in class com.palantir.javaformat.OpsBuilder.BlankLineWanted

Merge this blank line request with another.

mostRecentTokenFollowedByNewline() - Method in class com.palantir.javaformat.OpsBuilder

Return whether the last token emitted is followed by a newline.

mustBreak() - Method in class com.palantir.javaformat.doc.State

N

newChildNode(Level, State) - Method in interface com.palantir.javaformat.doc.Obs.ExplorationNode

Newlines - Class in com.palantir.javaformat

Platform-independent newline handling.

Newlines() - Constructor for class com.palantir.javaformat.Newlines

NO - Static variable in class com.palantir.javaformat.OpsBuilder.BlankLineWanted

Never emit a blank line.

NonBreakingSpace - Class in com.palantir.javaformat.doc

A Leaf node in a Doc for a non-breaking space.

NoopSink - Class in com.palantir.javaformat.doc

NoopSink() - Constructor for class com.palantir.javaformat.doc.NoopSink

numLines() - Method in class com.palantir.javaformat.doc.State

Counts how many lines a particular formatting took.

O

Obs - Class in com.palantir.javaformat.doc

These classes exist purely for observing the operation of Doc.computeBreaks(com.palantir.javaformat.CommentsHelper, int, com.palantir.javaformat.doc.State, com.palantir.javaformat.doc.Obs.ExplorationNode), including all the alternative hypotheses it has considered and rejected before deciding on the final formatting.

Obs.ExplorationNode - Interface in com.palantir.javaformat.doc

Within an 'exploration', allows you to descend into child levels.

Obs.FinishExplorationNode - Interface in com.palantir.javaformat.doc

Obs.FinishLevelNode - Interface in com.palantir.javaformat.doc

Obs.Sink - Interface in com.palantir.javaformat.doc

Op - Interface in com.palantir.javaformat

An Op is a member of the sequence of formatting operations emitted by OpsBuilder and transformed by DocBuilder into a Doc.

op(String) - Method in class com.palantir.javaformat.OpsBuilder

Emit a single- or multi-character op by breaking it into single-character Tokens.

open(OpenOp) - Method in class com.palantir.javaformat.doc.DocBuilder

Open a new Level.

open(Indent) - Method in class com.palantir.javaformat.OpsBuilder

Open a new level by emitting an OpenOp.

open(String, Indent) - Method in class com.palantir.javaformat.OpsBuilder

Open a new level by emitting an OpenOp.

open(Indent, BreakBehaviour, LastLevelBreakability) - Method in class com.palantir.javaformat.OpsBuilder

Open a new level by emitting an OpenOp.

open(OpenOp) - Method in class com.palantir.javaformat.OpsBuilder

OpenOp - Class in com.palantir.javaformat

An OpenOp opens a level.

OpenOp() - Constructor for class com.palantir.javaformat.OpenOp

OpenOp.Builder - Class in com.palantir.javaformat

OpenOp.Complexity - Enum in com.palantir.javaformat

ops() - Method in interface com.palantir.javaformat.OpsBuilder.OpsOutput

OpsBuilder - Class in com.palantir.javaformat

An OpsBuilder creates a list of Ops, which is turned into a Doc by DocBuilder.

OpsBuilder(Input) - Constructor for class com.palantir.javaformat.OpsBuilder

The OpsBuilder constructor.

OpsBuilder.BlankLineWanted - Class in com.palantir.javaformat

A request to add or remove a blank line in the output.

OpsBuilder.OpsOutput - Interface in com.palantir.javaformat

optTag() - Method in class com.palantir.javaformat.doc.Break

Output - Class in com.palantir.javaformat

An output from the formatter.

Output() - Constructor for class com.palantir.javaformat.Output

P

partialFormatRanges() - Method in interface com.palantir.javaformat.java.InputMetadata

Marks regions that can be partially formatted, used to determine the actual ranges that will be formatted when ranges are requested.

partialInlineability() - Method in class com.palantir.javaformat.doc.Level

partialInlineability() - Method in class com.palantir.javaformat.OpenOp

PartialInlineability - Enum in com.palantir.javaformat

What are the conditions for a level to be partially inlineable.

peekToken() - Method in class com.palantir.javaformat.OpsBuilder

Return the text of the next Input.Token, or absent if there is none.

peekToken(int) - Method in class com.palantir.javaformat.OpsBuilder

Return the text of an upcoming Input.Token, or absent if there is none.

plusIndent() - Method in class com.palantir.javaformat.doc.Break

plusIndent() - Method in class com.palantir.javaformat.OpenOp

The extra indent inside this level.

preferBreakingLastInnerLevel(boolean) - Method in interface com.palantir.javaformat.BreakBehaviour.Cases

If the last level is breakable, prefer breaking it if it will keep the rest of this level on line line.

PRESERVE - Static variable in class com.palantir.javaformat.OpsBuilder.BlankLineWanted

Explicitly preserve blank lines from the input (e.g.

processArgs(String...) - Static method in class com.palantir.javaformat.java.Main

Parses and validates command-line flags.

R

ranges - Variable in class com.palantir.javaformat.InputOutput

The Ranges of the tokens or comments lying on each line, in any part.

realOrImaginary() - Method in class com.palantir.javaformat.doc.Token

Is the token good? That is, does it match an Input.Token?

RemoveUnusedImports - Class in com.palantir.javaformat.java

Removes unused imports from a source file.

RemoveUnusedImports() - Constructor for class com.palantir.javaformat.java.RemoveUnusedImports

removeUnusedImports(String) - Static method in class com.palantir.javaformat.java.RemoveUnusedImports

reorderImports(String, JavaFormatterOptions.Style) - Static method in class com.palantir.javaformat.java.ImportOrderer

Reorder the inputs in text, a complete Java program.

reorderImports(String) - Static method in class com.palantir.javaformat.java.ImportOrderer

Deprecated.

Use #reorderImports(String, Style) instead

representation(State) - Method in class com.palantir.javaformat.doc.Level

An indented representation of this level and all nested levels inside it.

rewrite(Input.Tok, int, int) - Method in interface com.palantir.javaformat.CommentsHelper

Try to rewrite comments, returning rewritten text.

rewrite(Input.Tok, int, int) - Method in class com.palantir.javaformat.java.JavaCommentsHelper

S

scan(Tree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

setCompilationUnit(JCTree.JCCompilationUnit) - Method in class com.palantir.javaformat.java.JavaInput

setLines(ImmutableList<String>) - Method in class com.palantir.javaformat.InputOutput

Set the lines.

space() - Method in class com.palantir.javaformat.OpsBuilder

Emit a NonBreakingSpace.

startExplorationNode(int, OptionalInt, String, int, Optional<State>) - Method in class com.palantir.javaformat.doc.NoopSink

startExplorationNode(int, OptionalInt, String, int, Optional<State>) - Method in interface com.palantir.javaformat.doc.Obs.Sink

startExplorationNode(int, OptionalInt, String, int, Optional<State>) - Method in class com.palantir.javaformat.java.JsonSink

startingState() - Static method in class com.palantir.javaformat.doc.State

startPosition(Input.Token) - Static method in class com.palantir.javaformat.java.JavaOutput

The earliest position of any Tok in the Token, including leading whitespace.

startTok(Input.Token) - Static method in class com.palantir.javaformat.java.JavaOutput

The earliest non-whitespace Tok in the Token.

State - Class in com.palantir.javaformat.doc

State for writing.

State() - Constructor for class com.palantir.javaformat.doc.State

State.Builder - Class in com.palantir.javaformat.doc

STRING_CONCAT_DELIMITER - Static variable in class com.palantir.javaformat.java.StringWrapper

StringWrapper - Class in com.palantir.javaformat.java

Wraps string literals that exceed the column limit.

sync(int) - Method in class com.palantir.javaformat.OpsBuilder

Sync to position in the input.

T

Token - Class in com.palantir.javaformat.doc

A leaf Doc for a token.

token(String, Token.RealOrImaginary, Indent, Optional<Indent>) - Method in class com.palantir.javaformat.OpsBuilder

Token.RealOrImaginary - Enum in com.palantir.javaformat.doc

Is a Token a real token, or imaginary (e.g., a token generated incorrectly, or an EOF)?

tokStates() - Method in class com.palantir.javaformat.doc.State

Keep track of how each Comment was written (these are mostly comments), which can differ depending on the starting column and the maxLength.

toString() - Method in class com.palantir.javaformat.BreakBehaviour

For LevelDelimitedFlatValueDocVisitor.

toString() - Method in enum com.palantir.javaformat.CloseOp

toString() - Method in class com.palantir.javaformat.doc.Comment

toString() - Method in class com.palantir.javaformat.doc.DocBuilder

toString() - Method in class com.palantir.javaformat.doc.Level

toString() - Method in class com.palantir.javaformat.doc.NonBreakingSpace

toString() - Method in class com.palantir.javaformat.doc.Token

toString() - Method in class com.palantir.javaformat.Indent.Const

toString() - Method in class com.palantir.javaformat.Indent.If

toString() - Method in class com.palantir.javaformat.Input

toString() - Method in class com.palantir.javaformat.InputOutput

toString() - Method in class com.palantir.javaformat.java.JavaInput

toString() - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

toString() - Method in class com.palantir.javaformat.java.JavaOutput

toString() - Method in class com.palantir.javaformat.OpsBuilder

toString() - Method in class com.palantir.javaformat.Output

TypeNameClassifier - Class in com.palantir.javaformat.java

Heuristics for classifying qualified names as types.

TypeNameClassifier.JavaCaseFormat - Enum in com.palantir.javaformat.java

Case formats used in Java identifiers.

U

Utils - Class in com.palantir.javaformat

V

valueOf(String) - Static method in enum com.palantir.javaformat.CloseOp

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.palantir.javaformat.doc.FillMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.palantir.javaformat.doc.Token.RealOrImaginary

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.palantir.javaformat.java.TypeNameClassifier.JavaCaseFormat

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.palantir.javaformat.LastLevelBreakability

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.palantir.javaformat.OpenOp.Complexity

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.palantir.javaformat.PartialInlineability

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.palantir.javaformat.CloseOp

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.palantir.javaformat.doc.FillMode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.palantir.javaformat.doc.Token.RealOrImaginary

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.palantir.javaformat.java.TypeNameClassifier.JavaCaseFormat

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.palantir.javaformat.LastLevelBreakability

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.palantir.javaformat.OpenOp.Complexity

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.palantir.javaformat.PartialInlineability

Returns an array containing the constants of this enum type, in the order they are declared.

visit(Doc) - Method in interface com.palantir.javaformat.doc.DocVisitor

visit(Name) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitAnnotatedType(AnnotatedTypeTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitAnnotation(AnnotationTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitAnnotationArgument(AssignmentTree) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitAnnotationType(ClassTree) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitArrayAccess(ArrayAccessTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitArrayInitializer(List<? extends ExpressionTree>) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitArrayType(ArrayTypeTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitAssert(AssertTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitAssignment(AssignmentTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitBinary(BinaryTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitBlock(BlockTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitBreak(Break) - Method in interface com.palantir.javaformat.doc.DocVisitor

visitBreak(Break) - Method in class com.palantir.javaformat.doc.JsonDocVisitor

visitBreak(Break) - Method in class com.palantir.javaformat.doc.LevelDelimitedFlatValueDocVisitor

visitBreak(BreakTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitCase(CaseTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitCatch(CatchTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitClass(ClassTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitClassDeclaration(ClassTree) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitComment(Comment) - Method in interface com.palantir.javaformat.doc.DocVisitor

visitComment(Comment) - Method in class com.palantir.javaformat.doc.JsonDocVisitor

visitComment(Comment) - Method in class com.palantir.javaformat.doc.LevelDelimitedFlatValueDocVisitor

visitCompilationUnit(CompilationUnitTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitCompoundAssignment(CompoundAssignmentTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitConditionalExpression(ConditionalExpressionTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitContinue(ContinueTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitDoWhileLoop(DoWhileLoopTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitEmptyStatement(EmptyStatementTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitEnhancedForLoop(EnhancedForLoopTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitEnumDeclaration(ClassTree) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitExports(ExportsTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitExpressionStatement(ExpressionStatementTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitForLoop(ForLoopTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitIdentifier(IdentifierTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitIf(IfTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitImport(ImportTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitInstanceOf(InstanceOfTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitIntersectionType(IntersectionTypeTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitLabeledStatement(LabeledStatementTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitLambdaExpression(LambdaExpressionTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitLevel(Level) - Method in interface com.palantir.javaformat.doc.DocVisitor

visitLevel(Level) - Method in class com.palantir.javaformat.doc.JsonDocVisitor

visitLevel(Level) - Method in class com.palantir.javaformat.doc.LevelDelimitedFlatValueDocVisitor

visitLiteral(LiteralTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitMemberReference(MemberReferenceTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitMemberSelect(MemberSelectTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitMethod(MethodTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitMethodInvocation(MethodInvocationTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitModifiers(ModifiersTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitModule(ModuleTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitNewArray(NewArrayTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitNewClass(NewClassTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitOpens(OpensTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitParameterizedType(ParameterizedTypeTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitParenthesized(ParenthesizedTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitPrimitiveType(PrimitiveTypeTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitProvides(ProvidesTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitRequires(RequiresTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitReturn(ReturnTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitSpace(NonBreakingSpace) - Method in interface com.palantir.javaformat.doc.DocVisitor

visitSpace(NonBreakingSpace) - Method in class com.palantir.javaformat.doc.JsonDocVisitor

visitSpace(NonBreakingSpace) - Method in class com.palantir.javaformat.doc.LevelDelimitedFlatValueDocVisitor

visitSwitch(SwitchTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitSynchronized(SynchronizedTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitThrow(ThrowTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitToken(Token) - Method in interface com.palantir.javaformat.doc.DocVisitor

visitToken(Token) - Method in class com.palantir.javaformat.doc.JsonDocVisitor

visitToken(Token) - Method in class com.palantir.javaformat.doc.LevelDelimitedFlatValueDocVisitor

visitTry(TryTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitTypeCast(TypeCastTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitTypeParameter(TypeParameterTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitUnary(UnaryTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitUnionType(UnionTypeTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitUses(UsesTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitVariable(VariableTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitWhileLoop(WhileLoopTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

visitWildcard(WildcardTree, Void) - Method in class com.palantir.javaformat.java.JavaInputAstVisitor

W

wanted(State) - Method in class com.palantir.javaformat.OpsBuilder.BlankLineWanted

Is the blank line wanted?

wasBreakTaken(BreakTag) - Method in class com.palantir.javaformat.doc.State

withOps(List<Op>) - Method in class com.palantir.javaformat.doc.DocBuilder

Add a list of Ops to the OpsBuilder.

write(State, Output) - Method in class com.palantir.javaformat.doc.Break

write(State, Output) - Method in class com.palantir.javaformat.doc.Comment

write(State, Output) - Method in class com.palantir.javaformat.doc.Doc

Write a Doc to an Output, after breaking decisions have been made.

write(State, Output) - Method in class com.palantir.javaformat.doc.Level

write(State, Output) - Method in class com.palantir.javaformat.doc.NonBreakingSpace

write(State, Output) - Method in class com.palantir.javaformat.doc.Token

writeLevelNode(int, int, State, Level) - Method in class com.palantir.javaformat.doc.NoopSink

writeLevelNode(int, int, State, Level) - Method in interface com.palantir.javaformat.doc.Obs.Sink

writeLevelNode(int, int, State, Level) - Method in class com.palantir.javaformat.java.JsonSink

Y

YES - Static variable in class com.palantir.javaformat.OpsBuilder.BlankLineWanted

Always emit a blank line.

Z

ZERO - Static variable in class com.palantir.javaformat.Indent.Const

A B C D E F G H I J L M N O P R S T U V W Y Z