Top Description Inners Fields Constructors Methods
org.codehaus.groovy.control.customizers

public Class ImportCustomizer

extends CompilationCustomizer
Class Inheritance
Imports
org.codehaus.groovy.ast.ClassHelper, .ClassNode, .ModuleNode, org.codehaus.groovy.classgen.GeneratorContext, org.codehaus.groovy.control.CompilePhase, .SourceUnit, java.util.LinkedList, .List
This compilation customizer allows addiing various types of imports to the compilation unit. Supports adding:
Since
1.8.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
ImportCustomizer.Import

Represents imports which are possibly aliased.

private static enum
ImportCustomizer.ImportType

Field Summary

Modifier and TypeField and Description
private final List<ImportCustomizer.Import>
imports

Constructor Summary

AccessConstructor and Description
public
ImportCustomizer()

Method Summary

Modifier and TypeMethod and Description
public ImportCustomizer
addImport(final String alias, final String className)

private void
addImport(final String className)

public ImportCustomizer
addImports(final String... classNames)

private void
addStarImport(final String packageName)

public ImportCustomizer
addStarImports(final String... packageNames)

public ImportCustomizer
addStaticImport(final String className, final String fieldName)

public ImportCustomizer
addStaticImport(final String alias, final String className, final String fieldName)

private void
addStaticStar(final String className)

public ImportCustomizer
addStaticStars(final String... classNames)

public void
call(final SourceUnit source, final GeneratorContext context, final ClassNode classNode)

Implements org.codehaus.groovy.control.CompilationUnit.IPrimaryClassNodeOperation.call.

Inherited from org.codehaus.groovy.control.customizers.CompilationCustomizer:
getPhase

Field Detail

importsback to summary
private final List<ImportCustomizer.Import> imports

Constructor Detail

ImportCustomizerback to summary
public ImportCustomizer()

Method Detail

addImportback to summary
public ImportCustomizer addImport(final String alias, final String className)
addImportback to summary
private void addImport(final String className)
addImportsback to summary
public ImportCustomizer addImports(final String... classNames)
addStarImportback to summary
private void addStarImport(final String packageName)
addStarImportsback to summary
public ImportCustomizer addStarImports(final String... packageNames)
addStaticImportback to summary
public ImportCustomizer addStaticImport(final String className, final String fieldName)
addStaticImportback to summary
public ImportCustomizer addStaticImport(final String alias, final String className, final String fieldName)
addStaticStarback to summary
private void addStaticStar(final String className)
addStaticStarsback to summary
public ImportCustomizer addStaticStars(final String... classNames)
callback to summary
public void call(final SourceUnit source, final GeneratorContext context, final ClassNode classNode)

Implements org.codehaus.groovy.control.CompilationUnit.IPrimaryClassNodeOperation.call.

Annotations
@Override
org.codehaus.groovy.control.customizers back to summary

private final Class ImportCustomizer.Import

extends Object
Class Inheritance
  • java.lang.Object
  • org.codehaus.groovy.control.customizers.ImportCustomizer.Import
Represents imports which are possibly aliased.

Field Summary

Modifier and TypeField and Description
pack-priv final String
alias

pack-priv final ClassNode
classNode

pack-priv final String
field

pack-priv final String
star

pack-priv final ImportCustomizer.ImportType
type

Constructor Summary

AccessConstructor and Description
private
Import(final ImportCustomizer.ImportType type, final String alias, final ClassNode classNode, final String field)

private
Import(final ImportCustomizer.ImportType type, final String alias, final ClassNode classNode)

private
Import(final ImportCustomizer.ImportType type, final String star)

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

aliasback to summary
pack-priv final String alias
classNodeback to summary
pack-priv final ClassNode classNode
fieldback to summary
pack-priv final String field
starback to summary
pack-priv final String star
typeback to summary
pack-priv final ImportCustomizer.ImportType type

Constructor Detail

Importback to summary
private Import(final ImportCustomizer.ImportType type, final String alias, final ClassNode classNode, final String field)
Importback to summary
private Import(final ImportCustomizer.ImportType type, final String alias, final ClassNode classNode)
Importback to summary
private Import(final ImportCustomizer.ImportType type, final String star)
org.codehaus.groovy.control.customizers back to summary

private final Enum ImportCustomizer.ImportType

extends Enum<ImportCustomizer.ImportType>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final ImportCustomizer.ImportType
regular

public static final ImportCustomizer.ImportType
star

public static final ImportCustomizer.ImportType
staticImport

public static final ImportCustomizer.ImportType
staticStar

Constructor Summary

AccessConstructor and Description
private
ImportType()

Method Summary

Modifier and TypeMethod and Description
public static ImportCustomizer.ImportType
valueOf(String name)

public static ImportCustomizer.ImportType[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

regularback to summary
public static final ImportCustomizer.ImportType regular
starback to summary
public static final ImportCustomizer.ImportType star
staticImportback to summary
public static final ImportCustomizer.ImportType staticImport
staticStarback to summary
public static final ImportCustomizer.ImportType staticStar

Constructor Detail

ImportTypeback to summary
private ImportType()

Method Detail

valueOfback to summary
public static ImportCustomizer.ImportType valueOf(String name)
valuesback to summary
public static ImportCustomizer.ImportType[] values()