com.google.googlejavaformat

Class Input

java.lang.Object

com.google.googlejavaformat.InputOutput

com.google.googlejavaformat.Input

Direct Known Subclasses:

JavaInput

public abstract class Input
extends InputOutput

An input to the formatter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Input.Tok A Tok ("tock") is a token, or a comment, or a newline, or a maximal string of blanks.
static interface	Input.Token A Token is a language-level token.

Field Summary

Fields inherited from class com.google.googlejavaformat.InputOutput

EMPTY_RANGE, range0s, range1s, ranges

Constructor Summary

Constructors

Constructor and Description
Input()

Method Summary

Modifier and Type	Method and Description
FormatterDiagnostic	createDiagnostic(int inputPosition, String message) Construct a diagnostic.
abstract String	filename() The input filename.
abstract int	getColumnNumber(int inputPosition) Converts a character offset in the input to a 0-based column number.
abstract int	getLineNumber(int inputPosition) Converts a character offset in the input to a line number.
abstract ImmutableMap<Integer,Integer>	getPositionToColumnMap()
abstract NavigableMap<Integer,? extends Input.Token>	getPositionTokenMap() Get the navigable map from position to Input.Token.
abstract String	getText()
abstract ImmutableList<? extends Input.Token>	getTokens() Get the input tokens.
String	toString()

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

Input

public Input()

Method Detail

getTokens

public abstract ImmutableList<? extends Input.Token> getTokens()

Get the input tokens.

Returns:

the input tokens

getPositionTokenMap

public abstract NavigableMap<Integer,? extends Input.Token> getPositionTokenMap()

Get the navigable map from position to Input.Token. Used to look for tokens following a given one.

Returns:

the navigable map from position to Input.Token

getPositionToColumnMap

public abstract ImmutableMap<Integer,Integer> getPositionToColumnMap()

getText

public abstract String getText()

toString

public String toString()

Overrides:

toString in class InputOutput

filename

public abstract String filename()

The input filename.

getLineNumber

public abstract int getLineNumber(int inputPosition)

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

getColumnNumber

public abstract int getColumnNumber(int inputPosition)

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

createDiagnostic

public FormatterDiagnostic createDiagnostic(int inputPosition,
                                            String message)

Construct a diagnostic. Populates the input filename, and converts character offsets to numbers.