Class CodeWriter

java.lang.Object

com.squareup.javapoet.CodeWriter

final class CodeWriter
extends Object

Converts a JavaFile to a string suitable to both human- and javac-consumption. This honors imports, indentation, and deferred variable names.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	comment
private final Map<String, ClassName>	importableTypes
private final Map<String, ClassName>	importedTypes
private final String	indent
private int	indentLevel
private boolean	javadoc
private static final String	NO_PACKAGE	Sentinel value that indicates that no user-provided package has been set.
private final Appendable	out
private String	packageName
private final Set<String>	referencedNames
(package private) int	statementLine	When emitting a statement, this is the line of the statement currently being written.
private final Set<String>	staticImportClassNames
private final Set<String>	staticImports
private boolean	trailingNewline
private final List<TypeSpec>	typeSpecStack

Constructor Summary

Constructors

Constructor	Description
CodeWriter(Appendable out)
CodeWriter(Appendable out, String indent, Map<String, ClassName> importedTypes, Set<String> staticImports)
CodeWriter(Appendable out, String indent, Set<String> staticImports)

Method Summary

Modifier and Type	Method	Description
CodeWriter	emit(CodeBlock codeBlock)
CodeWriter	emit(String s)
CodeWriter	emit(String format, Object... args)
(package private) CodeWriter	emitAndIndent(String s)	Emits s with indentation as required.
void	emitAnnotations(List<AnnotationSpec> annotations, boolean inline)
void	emitComment(CodeBlock codeBlock)
private void	emitIndentation()
void	emitJavadoc(CodeBlock javadocCodeBlock)
private void	emitLiteral(Object o)
void	emitModifiers(Set<Modifier> modifiers)
void	emitModifiers(Set<Modifier> modifiers, Set<Modifier> implicitModifiers)	Emits modifiers in the standard order.
private boolean	emitStaticImportMember(String canonical, String part)
void	emitTypeVariables(List<TypeVariableName> typeVariables)	Emit type variables with their bounds.
private static String	extractMemberName(String part)
private void	importableType(ClassName className)
Map<String, ClassName>	importedTypes()
CodeWriter	indent()
CodeWriter	indent(int levels)
(package private) String	lookupName(ClassName className)	Returns the best name to identify className with in the current context.
CodeWriter	popPackage()
CodeWriter	popType()
CodeWriter	pushPackage(String packageName)
CodeWriter	pushType(TypeSpec type)
private ClassName	resolve(String simpleName)	Returns the class referenced by simpleName, using the current nesting context and imports.
private ClassName	stackClassName(int stackDepth, String simpleName)	Returns the class named simpleName when nested in the class at stackDepth.
(package private) Map<String, ClassName>	suggestedImports()	Returns the types that should have been imported for this code.
CodeWriter	unindent()
CodeWriter	unindent(int levels)

Methods inherited from class Object

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

Field Details

NO_PACKAGE

private static final String NO_PACKAGE

Sentinel value that indicates that no user-provided package has been set.

indent

private final String indent

out

private final Appendable out

indentLevel

private int indentLevel

javadoc

private boolean javadoc

comment

private boolean comment

packageName

private String packageName

typeSpecStack

private final List<TypeSpec> typeSpecStack

staticImportClassNames

private final Set<String> staticImportClassNames

staticImports

private final Set<String> staticImports

importedTypes

private final Map<String, ClassName> importedTypes

importableTypes

private final Map<String, ClassName> importableTypes

referencedNames

private final Set<String> referencedNames

trailingNewline

private boolean trailingNewline

statementLine

int statementLine

When emitting a statement, this is the line of the statement currently being written. The first line of a statement is indented normally and subsequent wrapped lines are double-indented. This is -1 when the currently-written line isn't part of a statement.

Constructor Details

CodeWriter

CodeWriter(Appendable out)

CodeWriter

CodeWriter(Appendable out,
 String indent,
 Set<String> staticImports)

CodeWriter

CodeWriter(Appendable out,
 String indent,
 Map<String, ClassName> importedTypes,
 Set<String> staticImports)

Method Details

importedTypes

public Map<String, ClassName> importedTypes()

indent

public CodeWriter indent()

indent

public CodeWriter indent(int levels)

unindent

public CodeWriter unindent()

unindent

public CodeWriter unindent(int levels)

pushPackage

public CodeWriter pushPackage(String packageName)

popPackage

public CodeWriter popPackage()

pushType

public CodeWriter pushType(TypeSpec type)

popType

public CodeWriter popType()

emitComment

public void emitComment(CodeBlock codeBlock)
                 throws IOException

Throws:

IOException

emitJavadoc

public void emitJavadoc(CodeBlock javadocCodeBlock)
                 throws IOException

Throws:

IOException

emitAnnotations

public void emitAnnotations(List<AnnotationSpec> annotations,
 boolean inline)
                     throws IOException

Throws:

IOException

emitModifiers

public void emitModifiers(Set<Modifier> modifiers,
 Set<Modifier> implicitModifiers)
                   throws IOException

Emits modifiers in the standard order. Modifiers in implicitModifiers will not be emitted.

Throws:

IOException

emitModifiers

public void emitModifiers(Set<Modifier> modifiers)
                   throws IOException

Throws:

IOException

emitTypeVariables

public void emitTypeVariables(List<TypeVariableName> typeVariables)
                       throws IOException

Emit type variables with their bounds. This should only be used when declaring type variables; everywhere else bounds are omitted.

Throws:

IOException

emit

public CodeWriter emit(String s)
                throws IOException

Throws:

IOException

emit

public CodeWriter emit(String format,
 Object... args)
                throws IOException

Throws:

IOException

emit

public CodeWriter emit(CodeBlock codeBlock)
                throws IOException

Throws:

IOException

extractMemberName

private static String extractMemberName(String part)

emitStaticImportMember

private boolean emitStaticImportMember(String canonical,
 String part)
                                throws IOException

Throws:

IOException

emitLiteral

private void emitLiteral(Object o)
                  throws IOException

Throws:

IOException

lookupName

String lookupName(ClassName className)

Returns the best name to identify className with in the current context. This uses the available imports and the current scope to find the shortest name available. It does not honor names visible due to inheritance.

importableType

private void importableType(ClassName className)

resolve

private ClassName resolve(String simpleName)

Returns the class referenced by simpleName, using the current nesting context and imports.

stackClassName

private ClassName stackClassName(int stackDepth,
 String simpleName)

Returns the class named simpleName when nested in the class at stackDepth.

emitAndIndent

CodeWriter emitAndIndent(String s)
                  throws IOException

Emits s with indentation as required. It's important that all code that writes to out does it through here, since we emit indentation lazily in order to avoid unnecessary trailing whitespace.

Throws:

IOException

emitIndentation

private void emitIndentation()
                      throws IOException

Throws:

IOException

suggestedImports

Map<String, ClassName> suggestedImports()

Returns the types that should have been imported for this code. If there were any simple name collisions, that type's first use is imported.