public final class ImportRewrite extends Object
ImportRewrite
helps updating imports following a import order and on-demand imports threshold as configured by a project.
The import rewrite is created on a compilation unit and collects references to types that are added or removed. When adding imports, e.g. using
addImport(String)
, the import rewrite evaluates if the type can be imported and returns the a reference to the type that can be used in code.
This reference is either unqualified if the import could be added, or fully qualified if the import failed due to a conflict with another element of the same name.
On rewriteImports(IProgressMonitor)
the rewrite translates these descriptions into
text edits that can then be applied to the original source. The rewrite infrastructure tries to generate minimal text changes and only
works on the import statements. It is possible to combine the result of an import rewrite with the result of a ASTRewrite
as long as no import statements are modified by the AST rewrite.
The options controlling the import order and on-demand thresholds are:
setImportOrder(String[])
specifies the import groups and their preferred ordersetOnDemandImportThreshold(int)
specifies the number of imports in a group needed for a on-demand import statement (star import)setStaticOnDemandImportThreshold(int)
specifies the number of static imports in a group needed for a on-demand import statement (star import)Modifier and Type | Class and Description |
---|---|
static class |
ImportRewrite.ImportRewriteContext
A
ImportRewrite.ImportRewriteContext can optionally be used in e.g. |
Modifier and Type | Method and Description |
---|---|
Annotation |
addAnnotation(IAnnotationBinding annotation,
AST ast,
ImportRewrite.ImportRewriteContext context)
Adds the necessary imports for the given annotation binding to the rewriter's record
and returns an
Annotation that can be used in the code. |
String |
addImport(ITypeBinding binding)
Adds a new import to the rewriter's record and returns a type reference that can be used
in the code.
|
Type |
addImport(ITypeBinding binding,
AST ast)
Adds a new import to the rewriter's record and returns a
Type that can be used
in the code. |
Type |
addImport(ITypeBinding binding,
AST ast,
ImportRewrite.ImportRewriteContext context)
Adds a new import to the rewriter's record and returns a
Type that can be used
in the code. |
String |
addImport(ITypeBinding binding,
ImportRewrite.ImportRewriteContext context)
Adds a new import to the rewriter's record and returns a type reference that can be used
in the code.
|
String |
addImport(String qualifiedTypeName)
Adds a new import to the rewriter's record and returns a type reference that can be used
in the code.
|
String |
addImport(String qualifiedTypeName,
ImportRewrite.ImportRewriteContext context)
Adds a new import to the rewriter's record and returns a type reference that can be used
in the code.
|
Type |
addImportFromSignature(String typeSig,
AST ast)
Adds a new import to the rewriter's record and returns a
Type node that can be used
in the code as a reference to the type. |
Type |
addImportFromSignature(String typeSig,
AST ast,
ImportRewrite.ImportRewriteContext context)
Adds a new import to the rewriter's record and returns a
Type node that can be used
in the code as a reference to the type. |
String |
addStaticImport(IBinding binding)
Adds a new static import to the rewriter's record and returns a name - single member name if
import is successful, else qualified name.
|
String |
addStaticImport(IBinding binding,
ImportRewrite.ImportRewriteContext context)
Adds a new static import to the rewriter's record and returns a name - single member name if
import is successful, else qualified name.
|
String |
addStaticImport(String declaringTypeName,
String simpleName,
boolean isField)
Adds a new static import to the rewriter's record and returns a name - single member name if
import is successful, else qualified name.
|
String |
addStaticImport(String declaringTypeName,
String simpleName,
boolean isField,
ImportRewrite.ImportRewriteContext context)
Adds a new static import to the rewriter's record and returns a name - single member name if
import is successful, else qualified name.
|
static ImportRewrite |
create(CompilationUnit astRoot,
boolean restoreExistingImports)
Creates an
ImportRewrite from an AST (CompilationUnit ). |
static ImportRewrite |
create(ICompilationUnit cu,
boolean restoreExistingImports)
Creates an
ImportRewrite from an ICompilationUnit . |
String[] |
getAddedImports()
Returns all non-static imports that are recorded to be added.
|
String[] |
getAddedStaticImports()
Returns all static imports that are recorded to be added.
|
ICompilationUnit |
getCompilationUnit()
The compilation unit for which this import rewrite was created for.
|
String[] |
getCreatedImports()
Returns all new non-static imports created by the last invocation of
rewriteImports(IProgressMonitor)
or null if these methods have not been called yet. |
String[] |
getCreatedStaticImports()
Returns all new static imports created by the last invocation of
rewriteImports(IProgressMonitor)
or null if these methods have not been called yet. |
ImportRewrite.ImportRewriteContext |
getDefaultImportRewriteContext()
Returns the default rewrite context that only knows about the imported types.
|
String[] |
getRemovedImports()
Returns all non-static imports that are recorded to be removed.
|
String[] |
getRemovedStaticImports()
Returns all static imports that are recorded to be removed.
|
boolean |
hasRecordedChanges()
Returns
true if imports have been recorded to be added or removed. |
boolean |
removeImport(String qualifiedName)
Records to remove a import.
|
boolean |
removeStaticImport(String qualifiedName)
Records to remove a static import.
|
TextEdit |
rewriteImports(IProgressMonitor monitor)
Converts all modifications recorded by this rewriter into an object representing the corresponding text
edits to the source code of the rewrite's compilation unit.
|
void |
setFilterImplicitImports(boolean filterImplicitImports)
Specifies that implicit imports (for types in
java.lang , types in the same package as the rewrite
compilation unit, and types in the compilation unit's main type) should not be created, except if necessary to
resolve an on-demand import conflict. |
void |
setImportOrder(String[] order)
Defines the import groups and order to be used by the
ImportRewrite . |
void |
setOnDemandImportThreshold(int threshold)
Sets the on-demand import threshold for normal (non-static) imports.
|
void |
setStaticOnDemandImportThreshold(int threshold)
Sets the on-demand import threshold for static imports.
|
void |
setUseContextToFilterImplicitImports(boolean useContextToFilterImplicitImports)
Sets whether a context should be used to properly filter implicit imports.
|
public static ImportRewrite create(ICompilationUnit cu, boolean restoreExistingImports) throws JavaModelException
ImportRewrite
from an ICompilationUnit
. If restoreExistingImports
is true
, all existing imports are kept, and new imports will be inserted at best matching locations. If
restoreExistingImports
is false
, the existing imports will be removed and only the
newly added imports will be created.
Note that create(CompilationUnit, boolean)
is more efficient than this method if an AST for
the compilation unit is already available.
cu
- the compilation unit to create the imports forrestoreExistingImports
- specifies if the existing imports should be kept or removed.JavaModelException
- thrown when the compilation unit could not be accessed.public static ImportRewrite create(CompilationUnit astRoot, boolean restoreExistingImports)
ImportRewrite
from an AST (CompilationUnit
). The AST has to be created from an
ICompilationUnit
, that means ASTParser.setSource(ICompilationUnit)
has been used when creating the
AST. If restoreExistingImports
is true
, all existing imports are kept, and new imports
will be inserted at best matching locations. If restoreExistingImports
is false
, the
existing imports will be removed and only the newly added imports will be created.
Note that this method is more efficient than using create(ICompilationUnit, boolean)
if an AST is already available.
astRoot
- the AST root node to create the imports forrestoreExistingImports
- specifies if the existing imports should be kept or removed.IllegalArgumentException
- thrown when the passed AST is null or was not created from a compilation unit.public void setImportOrder(String[] order)
ImportRewrite
.
Imports are added to the group matching their qualified name most. The empty group name groups all imports not matching
any other group. Static imports are managed in separate groups. Static import group names are prefixed with a '#' character.order
- A list of strings defining the import groups. A group name must be a valid package name or empty. If can be
prefixed by the '#' character for static import groupspublic void setOnDemandImportThreshold(int threshold)
threshold
- a positive number defining the on-demand import threshold
for normal (non-static) imports.IllegalArgumentException
- a IllegalArgumentException
is thrown
if the number is not positive.public void setStaticOnDemandImportThreshold(int threshold)
threshold
- a positive number defining the on-demand import threshold
for normal (non-static) imports.IllegalArgumentException
- a IllegalArgumentException
is thrown
if the number is not positive.public ICompilationUnit getCompilationUnit()
public ImportRewrite.ImportRewriteContext getDefaultImportRewriteContext()
public void setFilterImplicitImports(boolean filterImplicitImports)
java.lang
, types in the same package as the rewrite
compilation unit, and types in the compilation unit's main type) should not be created, except if necessary to
resolve an on-demand import conflict.
The filter is enabled by default.
Note: setUseContextToFilterImplicitImports(boolean)
can be used to filter implicit imports
when a context is used.
filterImplicitImports
- if true
, implicit imports will be filteredsetUseContextToFilterImplicitImports(boolean)
public void setUseContextToFilterImplicitImports(boolean useContextToFilterImplicitImports)
By default, the option is disabled to preserve pre-3.6 behavior.
When this option is set, the context passed to the addImport*(...)
methods is used to determine
whether an import can be filtered because the type is implicitly visible. Note that too many imports
may be kept if this option is set and addImport*(...)
methods are called without a context.
useContextToFilterImplicitImports
- the given settingsetFilterImplicitImports(boolean)
public Annotation addAnnotation(IAnnotationBinding annotation, AST ast, ImportRewrite.ImportRewriteContext context)
Annotation
that can be used in the code.
No imports are added for types that are already known. If an import for a type is recorded to be removed, this record is discarded instead.
The content of the compilation unit itself is actually not modified in any way by this method; rather, the rewriter just records newly added imports.
annotation
- the annotation to be addedast
- the AST to create the returned annotation forcontext
- an optional context that knows about types visible in the current scope or null
to use the default context (only using the available imports)public Type addImportFromSignature(String typeSig, AST ast)
Type
node that can be used
in the code as a reference to the type. The type binding can be an array binding, type variable or wildcard.
If the binding is a generic type, the type parameters are ignored. For parameterized types, also the type
arguments are processed and imports added if necessary. Anonymous types inside type arguments are normalized to their base type, wildcard
of wildcards are ignored.
No imports are added for types that are already known. If a import for a type is recorded to be removed, this record is discarded instead.
The content of the compilation unit itself is actually not modified in any way by this method; rather, the rewriter just records that a new import has been added.
typeSig
- the signature of the type to be added.ast
- the AST to create the returned type for.public Type addImportFromSignature(String typeSig, AST ast, ImportRewrite.ImportRewriteContext context)
Type
node that can be used
in the code as a reference to the type. The type binding can be an array binding, type variable or wildcard.
If the binding is a generic type, the type parameters are ignored. For parameterized types, also the type
arguments are processed and imports added if necessary. Anonymous types inside type arguments are normalized to their base type, wildcard
of wildcards are ignored.
No imports are added for types that are already known. If a import for a type is recorded to be removed, this record is discarded instead.
The content of the compilation unit itself is actually not modified in any way by this method; rather, the rewriter just records that a new import has been added.
typeSig
- the signature of the type to be added.ast
- the AST to create the returned type for.context
- an optional context that knows about types visible in the current scope or null
to use the default context only using the available imports.public String addImport(ITypeBinding binding)
No imports are added for types that are already known. If a import for a type is recorded to be removed, this record is discarded instead.
The content of the compilation unit itself is actually not modified in any way by this method; rather, the rewriter just records that a new import has been added.
binding
- the signature of the type to be added.public String addImport(ITypeBinding binding, ImportRewrite.ImportRewriteContext context)
No imports are added for types that are already known. If a import for a type is recorded to be removed, this record is discarded instead.
The content of the compilation unit itself is actually not modified in any way by this method; rather, the rewriter just records that a new import has been added.
binding
- the signature of the type to be added.context
- an optional context that knows about types visible in the current scope or null
to use the default context only using the available imports.public Type addImport(ITypeBinding binding, AST ast)
Type
that can be used
in the code. The type binding can be an array binding, type variable or wildcard.
If the binding is a generic type, the type parameters are ignored. For parameterized types, also the type
arguments are processed and imports added if necessary. Anonymous types inside type arguments are normalized to their base type, wildcard
of wildcards are ignored. If type annotations or type arguments are present at any point, the import is added up to that point and
the type is retained from that point with type annotations and type arguments.
No imports are added for types that are already known. If a import for a type is recorded to be removed, this record is discarded instead.
The content of the compilation unit itself is actually not modified in any way by this method; rather, the rewriter just records that a new import has been added.
binding
- the signature of the type to be added.ast
- the AST to create the returned type for.public Type addImport(ITypeBinding binding, AST ast, ImportRewrite.ImportRewriteContext context)
Type
that can be used
in the code. The type binding can be an array binding, type variable or wildcard.
If the binding is a generic type, the type parameters are ignored. For parameterized types, also the type
arguments are processed and imports added if necessary. Anonymous types inside type arguments are normalized to their base type, wildcard
of wildcards are ignored. If type annotations or type arguments are present at any point, the import is added up to that point and
the type is retained from that point with type annotations and type arguments
No imports are added for types that are already known. If a import for a type is recorded to be removed, this record is discarded instead.
The content of the compilation unit itself is actually not modified in any way by this method; rather, the rewriter just records that a new import has been added.
binding
- the signature of the type to be added.ast
- the AST to create the returned type for.context
- an optional context that knows about types visible in the current scope or null
to use the default context only using the available imports.public String addImport(String qualifiedTypeName, ImportRewrite.ImportRewriteContext context)
No imports are added for types that are already known. If a import for a type is recorded to be removed, this record is discarded instead.
The content of the compilation unit itself is actually not modified in any way by this method; rather, the rewriter just records that a new import has been added.
qualifiedTypeName
- the qualified type name of the type to be addedcontext
- an optional context that knows about types visible in the current scope or null
to use the default context only using the available imports.public String addImport(String qualifiedTypeName)
No imports are added for types that are already known. If a import for a type is recorded to be removed, this record is discarded instead.
The content of the compilation unit itself is actually not modified in any way by this method; rather, the rewriter just records that a new import has been added.
qualifiedTypeName
- the qualified type name of the type to be addedpublic String addStaticImport(IBinding binding)
No imports are added for members that are already known. If a import for a type is recorded to be removed, this record is discarded instead.
The content of the compilation unit itself is actually not modified in any way by this method; rather, the rewriter just records that a new import has been added.
binding
- The binding of the static field or method to be added.IllegalArgumentException
- an IllegalArgumentException
is thrown if the binding is not a static field
or method.public String addStaticImport(IBinding binding, ImportRewrite.ImportRewriteContext context)
No imports are added for members that are already known. If a import for a type is recorded to be removed, this record is discarded instead.
The content of the compilation unit itself is actually not modified in any way by this method; rather, the rewriter just records that a new import has been added.
binding
- The binding of the static field or method to be added.context
- an optional context that knows about members visible in the current scope or null
to use the default context only using the available imports.IllegalArgumentException
- an IllegalArgumentException
is thrown if the binding is not a static field
or method.public String addStaticImport(String declaringTypeName, String simpleName, boolean isField)
No imports are added for members that are already known. If a import for a type is recorded to be removed, this record is discarded instead.
The content of the compilation unit itself is actually not modified in any way by this method; rather, the rewriter just records that a new import has been added.
declaringTypeName
- The qualified name of the static's member declaring typesimpleName
- the simple name of the member; either a field or a method name.isField
- true
specifies that the member is a field, false
if it is a
method.public String addStaticImport(String declaringTypeName, String simpleName, boolean isField, ImportRewrite.ImportRewriteContext context)
No imports are added for members that are already known. If a import for a type is recorded to be removed, this record is discarded instead.
The content of the compilation unit itself is actually not modified in any way by this method; rather, the rewriter just records that a new import has been added.
declaringTypeName
- The qualified name of the static's member declaring typesimpleName
- the simple name of the member; either a field or a method name.isField
- true
specifies that the member is a field, false
if it is a
method.context
- an optional context that knows about members visible in the current scope or null
to use the default context only using the available imports.public boolean removeImport(String qualifiedName)
The content of the compilation unit itself is actually not modified in any way by this method; rather, the rewriter just records that an import has been removed.
qualifiedName
- The import name to remove.true
is returned of an import of the given name could be found.public boolean removeStaticImport(String qualifiedName)
The content of the compilation unit itself is actually not modified in any way by this method; rather, the rewriter just records that a new import has been removed.
qualifiedName
- The import name to remove.true
is returned of an import of the given name could be found.public final TextEdit rewriteImports(IProgressMonitor monitor) throws CoreException
Calling this methods does not discard the modifications on record. Subsequence modifications are added to the ones already on record. If this method is called again later, the resulting text edit object will accurately reflect the net cumulative effect of all those changes.
monitor
- the progress monitor or null
CoreException
- the exception is thrown if the rewrite fails.public String[] getCreatedImports()
rewriteImports(IProgressMonitor)
or null
if these methods have not been called yet.
Note that this list doesn't need to be the same as the added imports (see getAddedImports()
) as
implicit imports are not created and some imports are represented by on-demand imports instead.
public String[] getCreatedStaticImports()
rewriteImports(IProgressMonitor)
or null
if these methods have not been called yet.
Note that this list doesn't need to be the same as the added static imports (getAddedStaticImports()
) as
implicit imports are not created and some imports are represented by on-demand imports instead.
public String[] getAddedImports()
public String[] getAddedStaticImports()
public String[] getRemovedImports()
public String[] getRemovedStaticImports()
public boolean hasRecordedChanges()
true
if imports have been recorded to be added or removed.
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.