Class ImportManager

java.lang.Object

org.inferred.freebuilder.processor.source.ImportManager

class ImportManager
extends Object

Adds imports and applies scope visibility rules to a compilation unit.

To ensure we never import common names like 'Builder', nested classes must have at least one non-lowercase letter (apart from the first) in their name.

Field Summary

Fields

Modifier and Type	Field	Description
private static final QualifiedName	CONFLICT	Impossible typename, to use instead of null (which toMap goes odd over).
private final com.google.common.collect.Multimap<QualifiedName, TypeUsage>	imports	Types to import, and for which usages.
private final Map<String, QualifiedName>	namespace	Simple name → type, or CONFLICT if multiple types conflicted for that name.
private final String	pkg
private final Map<TypeUsage, QualifiedName>	resolutions	Which type, imported or in scope, to use to shorten each type usage.
private final ScopeHandler	scopeHandler
private final Deque<TypeUsage>	todo	Type usages to process.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ImportManager(List<TypeUsage> usages, ScopeHandler scopeHandler, String pkg)

Method Summary

Modifier and Type	Method	Description
private boolean	addImport(QualifiedName name, TypeUsage usage)
private void	appendImports(StringBuilder result)
private void	appendUsage(StringBuilder result, TypeUsage usage)
private static boolean	isSensibleImport(QualifiedName name)
private void	rejectName(QualifiedName name)
private boolean	reserveName(QualifiedName name)
private void	resolveUsage(TypeUsage usage)
private void	selectImports()
(package private) static String	shortenReferences(CharSequence codeWithQualifiedNames, String pkg, int importsIndex, List<TypeUsage> typeUsages, ScopeHandler scopeHandler)
private Function<QualifiedName, ScopeHandler.ScopeState>	visibilityIn(ScopeHandler scopeHandler, TypeUsage usage)

Methods inherited from class Object

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

Field Details

CONFLICT

private static final QualifiedName CONFLICT

Impossible typename, to use instead of null (which toMap goes odd over).

todo

private final Deque<TypeUsage> todo

Type usages to process.

namespace

private final Map<String, QualifiedName> namespace

Simple name → type, or CONFLICT if multiple types conflicted for that name.

imports

private final com.google.common.collect.Multimap<QualifiedName, TypeUsage> imports

Types to import, and for which usages.

resolutions

private final Map<TypeUsage, QualifiedName> resolutions

Which type, imported or in scope, to use to shorten each type usage.

scopeHandler

private final ScopeHandler scopeHandler

pkg

private final String pkg

Constructor Details

ImportManager

private ImportManager(List<TypeUsage> usages,
 ScopeHandler scopeHandler,
 String pkg)

Method Details

shortenReferences

static String shortenReferences(CharSequence codeWithQualifiedNames,
 String pkg,
 int importsIndex,
 List<TypeUsage> typeUsages,
 ScopeHandler scopeHandler)

selectImports

private void selectImports()

appendImports

private void appendImports(StringBuilder result)

appendUsage

private void appendUsage(StringBuilder result,
 TypeUsage usage)

reserveName

private boolean reserveName(QualifiedName name)

rejectName

private void rejectName(QualifiedName name)

addImport

private boolean addImport(QualifiedName name,
 TypeUsage usage)

resolveUsage

private void resolveUsage(TypeUsage usage)

visibilityIn

private Function<QualifiedName, ScopeHandler.ScopeState> visibilityIn(ScopeHandler scopeHandler,
 TypeUsage usage)

isSensibleImport

private static boolean isSensibleImport(QualifiedName name)