org.eclipse.xtext.xbase.imports

Class RewritableImportSection

java.lang.Object

org.eclipse.xtext.xbase.imports.RewritableImportSection

public class RewritableImportSection
extends Object

Model of an import section that can be changed.

Author:

Jan Koehnlein - Initial contribution and API

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RewritableImportSection.Factory

Constructor Summary

Constructors

Constructor and Description
RewritableImportSection(XtextResource resource, IImportsConfiguration importsConfiguration, XImportSection originalImportSection, String lineSeparator, ImportSectionRegionUtil regionUtil, IValueConverter<String> nameConverter)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addImport(JvmDeclaredType type)
boolean	addImport(String fqn)
protected void	addSectionToAppend(IAcceptor<ReplaceRegion> acceptor)
boolean	addStaticExtensionImport(JvmDeclaredType type, String memberName)
boolean	addStaticExtensionImport(JvmMember member)
boolean	addStaticExtensionImport(String typeFqn, String member)
boolean	addStaticImport(JvmDeclaredType type, String memberName)
boolean	addStaticImport(JvmMember member)
boolean	addStaticImport(String typeFqn, String member)
protected void	appendImport(StringBuilder builder, XImportDeclaration newImportDeclaration)
protected boolean	appendSubsection(StringBuilder builder, Iterable<XImportDeclaration> subSection, boolean needsNewline)
protected XImportDeclaration	createImport(String importedNamespace, String member)
protected List<XImportDeclaration>	findOriginalImports(JvmDeclaredType type, String memberName, Collection<XImportDeclaration> list, boolean isStatic, boolean isExtension)
protected StringBuilder	getImportDeclarationsToAppend()
List<JvmDeclaredType>	getImportedTypes(String simpleName)
boolean	hasImportedType(JvmDeclaredType type)
boolean	hasStaticImport(JvmDeclaredType declaringType, String memberName, boolean extension)
boolean	hasStaticImport(String memberName, boolean extension)
boolean	isSort()
boolean	needsImport(JvmDeclaredType type)
protected boolean	needsImport(String fqn)
protected boolean	needsPreceedingBlankLine()
boolean	removeImport(JvmDeclaredType type)
boolean	removeStaticExtensionImport(JvmDeclaredType type, String memberName)
boolean	removeStaticImport(JvmDeclaredType type, String memberName)
protected boolean	removeStaticImport(Map<JvmDeclaredType,Set<String>> staticImports, JvmDeclaredType type, String memberName, boolean isStatic, boolean isExtension)
List<ReplaceRegion>	rewrite()
protected String	serializeImports(List<XImportDeclaration> allDeclarations)
protected String	serializeType(JvmDeclaredType type) We cannot rely on JvmType#getIdentifier as it is cached and does not pick up changed simpleNames, e.g. in rename refactoring.
void	setSort(boolean isSort)
protected List<XImportDeclaration>	sort(Iterable<XImportDeclaration> declarations)
void	update()

Methods inherited from class java.lang.Object

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

Constructor Detail

RewritableImportSection

public RewritableImportSection(XtextResource resource,
                       IImportsConfiguration importsConfiguration,
                       XImportSection originalImportSection,
                       String lineSeparator,
                       ImportSectionRegionUtil regionUtil,
                       IValueConverter<String> nameConverter)

Method Detail

setSort

public void setSort(boolean isSort)

isSort

public boolean isSort()

addImport

public boolean addImport(JvmDeclaredType type)

addImport

public boolean addImport(String fqn)

createImport

protected XImportDeclaration createImport(String importedNamespace,
                              String member)

needsImport

protected boolean needsImport(String fqn)

needsImport

public boolean needsImport(JvmDeclaredType type)

removeImport

public boolean removeImport(JvmDeclaredType type)

findOriginalImports

protected List<XImportDeclaration> findOriginalImports(JvmDeclaredType type,
                                           String memberName,
                                           Collection<XImportDeclaration> list,
                                           boolean isStatic,
                                           boolean isExtension)

hasImportedType

public boolean hasImportedType(JvmDeclaredType type)

getImportedTypes

public List<JvmDeclaredType> getImportedTypes(String simpleName)

addStaticImport

public boolean addStaticImport(JvmMember member)

addStaticImport

public boolean addStaticImport(JvmDeclaredType type,
                      String memberName)

addStaticImport

public boolean addStaticImport(String typeFqn,
                      String member)

Parameters:

typeFqn - The fully qualified name of the type to import. E.g. java.util.List. May not be null.

member - member name to import. May not be null. For wildcard use *

addStaticExtensionImport

public boolean addStaticExtensionImport(String typeFqn,
                               String member)

Parameters:

typeFqn - The fully qualified name of the type to import. E.g. java.util.List. May not be null.

member - member name to import. May not be null. For wildcard use *

removeStaticImport

public boolean removeStaticImport(JvmDeclaredType type,
                         String memberName)

addStaticExtensionImport

public boolean addStaticExtensionImport(JvmMember member)

addStaticExtensionImport

public boolean addStaticExtensionImport(JvmDeclaredType type,
                               String memberName)

removeStaticExtensionImport

public boolean removeStaticExtensionImport(JvmDeclaredType type,
                                  String memberName)

removeStaticImport

protected boolean removeStaticImport(Map<JvmDeclaredType,Set<String>> staticImports,
                         JvmDeclaredType type,
                         String memberName,
                         boolean isStatic,
                         boolean isExtension)

update

public void update()

rewrite

public List<ReplaceRegion> rewrite()

addSectionToAppend

protected void addSectionToAppend(IAcceptor<ReplaceRegion> acceptor)

getImportDeclarationsToAppend

protected StringBuilder getImportDeclarationsToAppend()

appendImport

protected void appendImport(StringBuilder builder,
                XImportDeclaration newImportDeclaration)

serializeType

protected String serializeType(JvmDeclaredType type)

We cannot rely on JvmType#getIdentifier as it is cached and does not pick up changed simpleNames, e.g. in rename refactoring.

serializeImports

protected String serializeImports(List<XImportDeclaration> allDeclarations)

needsPreceedingBlankLine

protected boolean needsPreceedingBlankLine()

appendSubsection

protected boolean appendSubsection(StringBuilder builder,
                       Iterable<XImportDeclaration> subSection,
                       boolean needsNewline)

sort

protected List<XImportDeclaration> sort(Iterable<XImportDeclaration> declarations)

hasStaticImport

public boolean hasStaticImport(JvmDeclaredType declaringType,
                      String memberName,
                      boolean extension)

hasStaticImport

public boolean hasStaticImport(String memberName,
                      boolean extension)