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

public Class ImportCustomizerFactory

extends AbstractFactory
Class Inheritance
Imports
groovy.lang.Closure, .GString, groovy.util.AbstractFactory, .FactoryBuilderSupport, org.codehaus.groovy.control.customizers.ImportCustomizer, java.util.Collection, .Map

This factory allows the generation of an import customizer. You may embed several elements: For example:
builder.imports {
 alias 'AI', 'java.util.concurrent.atomic.AtomicInteger'
 alias 'AL', 'java.util.concurrent.atomic.AtomicLong'
}
Since
2.1.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
private void
addImport(final ImportCustomizer customizer, final Object value)

public boolean
public Object
newInstance(final FactoryBuilderSupport
the FactoryBuilder
builder
,
final Object
the name of the node being built
name
,
final Object
the 'value' argument in the build node
value
,
final Map<K, V>
the attributes of the build arg
attributes
)

Implements groovy.util.Factory.newInstance.

public boolean
onNodeChildren(final FactoryBuilderSupport
the FactoryBuilder
builder
,
final Object
the node (returned from newINstance) to consider the attributes for
node
,
final Closure<V>
the child content closure of the builder
childContent
)

Overrides groovy.util.AbstractFactory.onNodeChildren.

Implements groovy.util.Factory.onNodeChildren.

Only called if it isLeaf is false and isHandlesNodeChildren is true
Inherited from groovy.util.AbstractFactory:
isLeafonFactoryRegistrationonHandleNodeAttributesonNodeCompletedsetChildsetParent

Constructor Detail

ImportCustomizerFactoryback to summary
public ImportCustomizerFactory()

Method Detail

addImportback to summary
private void addImport(final ImportCustomizer customizer, final Object value)
isHandlesNodeChildrenback to summary
public boolean isHandlesNodeChildren()

Overrides groovy.util.AbstractFactory.isHandlesNodeChildren.

Implements groovy.util.Factory.isHandlesNodeChildren.

Doc from groovy.util.Factory.isHandlesNodeChildren.

Does this factory "Own" its child closure.

Returns:boolean

true if the factory should have onContentClosure() called, false if the builder should handle it

Annotations
@Override
newInstanceback to summary
public Object newInstance(final FactoryBuilderSupport builder, final Object name, final Object value, final Map<K, V> attributes) throws InstantiationException, IllegalAccessException

Implements groovy.util.Factory.newInstance.

Parameters
builder:FactoryBuilderSupport

Doc from groovy.util.Factory.newInstance.

the FactoryBuilder

name:Object

Doc from groovy.util.Factory.newInstance.

the name of the node being built

value:Object

Doc from groovy.util.Factory.newInstance.

the 'value' argument in the build node

attributes:Map<K, V>

Doc from groovy.util.Factory.newInstance.

the attributes of the build arg

Returns:Object

Doc from groovy.util.Factory.newInstance.

the object created for the builder

Exceptions
InstantiationException:

Doc from groovy.util.Factory.newInstance.

if attempting to instantiate an interface or abstract class

IllegalAccessException:

Doc from groovy.util.Factory.newInstance.

if the instance can't be created due to a security violation

onNodeChildrenback to summary
public boolean onNodeChildren(final FactoryBuilderSupport builder, final Object node, final Closure<V> childContent)

Overrides groovy.util.AbstractFactory.onNodeChildren.

Implements groovy.util.Factory.onNodeChildren.

Doc from groovy.util.Factory.onNodeChildren.

Only called if it isLeaf is false and isHandlesNodeChildren is true

Parameters
builder:FactoryBuilderSupport

the FactoryBuilder

node:Object

the node (returned from newINstance) to consider the attributes for

childContent:Closure<V>

the child content closure of the builder

Returns:boolean

true if the factory builder should apply default node processing to the content child

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

private final Class ImportCustomizerFactory.ImportHelper

extends Object
Class Inheritance
  • java.lang.Object
  • org.codehaus.groovy.control.customizers.builder.ImportCustomizerFactory.ImportHelper

Field Summary

Modifier and TypeField and Description
private final ImportCustomizer

Constructor Summary

AccessConstructor and Description
private
ImportHelper(final ImportCustomizer customizer)

Method Summary

Modifier and TypeMethod and Description
protected void
alias(String alias, String name)

protected void
alias(String alias, Class<T> clazz)

protected void
normal(String... names)

protected void
normal(Class<T>... classes)

protected void
star(String... packages)

protected void
staticMember(String name, String field)

protected void
staticMember(String alias, String name, String field)

protected void
staticStar(String... classNames)

protected void
staticStar(Class<T>... classes)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

customizerback to summary
private final ImportCustomizer customizer

Constructor Detail

ImportHelperback to summary
private ImportHelper(final ImportCustomizer customizer)

Method Detail

aliasback to summary
protected void alias(String alias, String name)
aliasback to summary
protected void alias(String alias, Class<T> clazz)
normalback to summary
protected void normal(String... names)
normalback to summary
protected void normal(Class<T>... classes)
starback to summary
protected void star(String... packages)
staticMemberback to summary
protected void staticMember(String name, String field)
staticMemberback to summary
protected void staticMember(String alias, String name, String field)
staticStarback to summary
protected void staticStar(String... classNames)
staticStarback to summary
protected void staticStar(Class<T>... classes)