com.google.googlejavaformat.java

Class JavaOutput

java.lang.Object

com.google.googlejavaformat.InputOutput

com.google.googlejavaformat.Output

com.google.googlejavaformat.java.JavaOutput

public final class JavaOutput
extends Output

JavaOutput extends Output to represent a Java output document. It includes methods to emit the output document.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.googlejavaformat.Output

Output.BreakTag

Field Summary

Fields inherited from class com.google.googlejavaformat.InputOutput

EMPTY_RANGE, range0s, range1s, ranges

Constructor Summary

Constructors

Constructor and Description
JavaOutput(JavaInput javaInput, CommentsHelper commentsHelper) JavaOutput constructor.

Method Summary

Modifier and Type	Method and Description
void	append(String text, Range<Integer> range) Output a string.
void	blankLine(int k, OpsBuilder.BlankLineWanted wanted) A blank line is or is not wanted here.
static Input.Tok	endTok(Input.Token token) The last non-whitespace Tok in the Token.
CommentsHelper	getCommentsHelper() Get the CommentsHelper.
ImmutableList<Replacement>	getFormatReplacements(RangeSet<Integer> iRangeSet0) Emit a list of Replacements to convert from input to output.
void	indent(int indent) Indent by outputting indent spaces.
void	markForPartialFormat(int k) Marks the boundary of a region that can be partially formatted.
static int	startPosition(Input.Token token) The earliest position of any Tok in the Token, including leading whitespace.
static Input.Tok	startTok(Input.Token token) The earliest non-whitespace Tok in the Token.
String	toString()
void	writeMerged(Appendable writer, RangeSet<Integer> iRangeSet0) Merge the (un-reformatted) input lines and the (reformatted) output lines.

Methods inherited from class com.google.googlejavaformat.InputOutput

computeRanges, getLine, getLineCount, getRange0s, getRange1s, getRanges, makeKToIJ, setLines

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaOutput

public JavaOutput(JavaInput javaInput,
                  CommentsHelper commentsHelper)

JavaOutput constructor.

Parameters:

javaInput - the JavaInput, used to match up blank lines in the output

commentsHelper - the CommentsHelper, used to rewrite comments

Method Detail

blankLine

public void blankLine(int k,
                      OpsBuilder.BlankLineWanted wanted)

Description copied from class: Output

A blank line is or is not wanted here.

Specified by:

blankLine in class Output

Parameters:

k - the Input.Tok index

wanted - whether a blank line is wanted here

markForPartialFormat

public void markForPartialFormat(int k)

Description copied from class: Output

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

Specified by:

markForPartialFormat in class Output

Parameters:

k - the token index

append

public void append(String text,
                   Range<Integer> range)

Description copied from class: Output

Output a string.

Specified by:

append in class Output

Parameters:

text - the string

range - the Range corresponding to the string

indent

public void indent(int indent)

Description copied from class: Output

Indent by outputting indent spaces.

Specified by:

indent in class Output

Parameters:

indent - the current indent

getCommentsHelper

public CommentsHelper getCommentsHelper()

Description copied from class: Output

Get the CommentsHelper.

Specified by:

getCommentsHelper in class Output

Returns:

the CommentsHelper

getFormatReplacements

public ImmutableList<Replacement> getFormatReplacements(RangeSet<Integer> iRangeSet0)

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

Returns:

a list of Replacements, sorted by start index, without overlaps

writeMerged

public void writeMerged(Appendable writer,
                        RangeSet<Integer> iRangeSet0)
                 throws IOException

Merge the (un-reformatted) input lines and the (reformatted) output lines. The result will contain all of the toks from the input and output.

Parameters:

writer - the destination Writer

iRangeSet0 - the canonical Range of tokens to reformat

Throws:

IOException

startPosition

public static int startPosition(Input.Token token)

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

startTok

public static Input.Tok startTok(Input.Token token)

The earliest non-whitespace Tok in the Token.

endTok

public static Input.Tok endTok(Input.Token token)

The last non-whitespace Tok in the Token.

toString

public String toString()

Overrides:

toString in class Output