GenerateEclipseWtpComponent

API Documentation:GenerateEclipseWtpComponent

Generates the org.eclipse.wst.common.component settings file for Eclipse WTP. If you want to fine tune the eclipse configuration

At this moment nearly all configuration is done via EclipseWtpComponent.

Properties

PropertyDescription
contextPath

Deprecated. Please use #eclipse.wtp.component.contextPath. See examples in EclipseWtpComponent.

deployName

Deprecated. Please use #eclipse.wtp.component.deployName. See examples in EclipseWtpComponent.

inputFile

The input file to load the initial configuration from. Defaults to the output file. If the specified input file does not exist, this task uses some default initial configuration.

minusConfigurations

Deprecated. Please use #eclipse.wtp.component.minusConfigurations. See examples in EclipseWtpComponent.

outputFile

The output file to write the final configuration to.

properties

Deprecated. Please use #eclipse.wtp.component.properties. See examples in EclipseWtpComponent.

resources

Deprecated. Please use #eclipse.wtp.component.resources. See examples in EclipseWtpComponent.

sourceDirs

Deprecated. Please use #eclipse.wtp.component.sourceDirs. See examples in EclipseWtpComponent.

variables

Deprecated. Please use #eclipse.pathVariables. See examples in EclipseWtpComponent.

Property details

String contextPath

Deprecated. Please use #eclipse.wtp.component.contextPath. See examples in EclipseWtpComponent.

The context path for the web application

Default with eclipse and war plugins:
project.war.baseName

String deployName

Deprecated. Please use #eclipse.wtp.component.deployName. See examples in EclipseWtpComponent.

The deploy name to be used.

Default with eclipse and war plugins:
project.name
Default with eclipse and ear plugins:
project.name

File inputFile

The input file to load the initial configuration from. Defaults to the output file. If the specified input file does not exist, this task uses some default initial configuration.

Set<Configuration> minusConfigurations

Deprecated. Please use #eclipse.wtp.component.minusConfigurations. See examples in EclipseWtpComponent.

The configurations whose files are to be excluded from dependent-module elements.

Default with eclipse and war plugins:
[project.configurations.providedRuntime]
Default with eclipse and ear plugins:
[]

File outputFile

The output file to write the final configuration to.

Default with eclipse and war plugins:
${project.projectDir}/.settings/org.eclipse.wst.common.component
Default with eclipse and ear plugins:
(same)

List<WbProperty> properties

Deprecated. Please use #eclipse.wtp.component.properties. See examples in EclipseWtpComponent.

Additional property elements.

Default with eclipse and war plugins:
[]
Default with eclipse and ear plugins:
[]

List<WbResource> resources

Deprecated. Please use #eclipse.wtp.component.resources. See examples in EclipseWtpComponent.

Additional wb-resource elements.

Default with eclipse and war plugins:
[deployPath: '/', sourcePath: project.webAppDirName]
Default with eclipse and ear plugins:
[]

Set<File> sourceDirs

Deprecated. Please use #eclipse.wtp.component.sourceDirs. See examples in EclipseWtpComponent.

The source directories to be transformed into wb-resource elements.

Default with eclipse and war plugins:
source dirs from project.sourceSets.main.allSource
Default with eclipse and ear plugins:
(same)

Map<String, File> variables

Deprecated. Please use #eclipse.pathVariables. See examples in EclipseWtpComponent.

The variables to be used for replacing absolute path in dependent-module elements.

Default with eclipse and war plugins:
[:]
Default with eclipse and ear plugins:
[:]

Script blocks

No script blocks

Methods

MethodDescription
beforeConfigured(closure)

Deprecated. Moved to the relevant type. Where? For starters, see examples in IdeaProject or EclipseProject.

beforeConfigured(action)

Deprecated. Moved to the relevant type. Where? For starters, see examples in IdeaProject or EclipseProject.

property(args)

Deprecated. Please use #eclipse.wtp.component.property. See examples in EclipseWtpComponent.

resource(args)

Deprecated. Please use #eclipse.wtp.component.resource. See examples in EclipseWtpComponent.

variables(variables)

Deprecated. Please use #eclipse.pathVariables. See examples in EclipseWtpComponent.

whenConfigured(closure)

Deprecated. Moved to the relevant type. Where? For starters, see examples in IdeaProject or EclipseProject.

whenConfigured(action)

Deprecated. Moved to the relevant type. Where? For starters, see examples in IdeaProject or EclipseProject.

withXml(closure)

Deprecated. Moved to the relevant type. Where? For starters, see examples in IdeaProject or EclipseProject.

withXml(action)

Deprecated. Moved to the relevant type. Where? For starters, see examples in IdeaProject or EclipseProject.

Method details

void beforeConfigured(Closure closure)

Deprecated. Moved to the relevant type. Where? For starters, see examples in IdeaProject or EclipseProject.

Adds a closure to be called before the domain object is configured by this task. The domain object is passed as a parameter to the closure.

The closure is executed after the domain object has been loaded from the input file. Using this method allows you to change the domain object in some way before the task configures it.

void beforeConfigured(Action<? super T> action)

Deprecated. Moved to the relevant type. Where? For starters, see examples in IdeaProject or EclipseProject.

Adds an action to be called before the domain object is configured by this task. The domain object is passed as a parameter to the action.

The action is executed after the domain object has been loaded from the input file. Using this method allows you to change the domain object in some way before the task configures it.

void property(Map<String, String> args)

Deprecated. Please use #eclipse.wtp.component.property. See examples in EclipseWtpComponent.

Adds a property.

void resource(Map<String, String> args)

Deprecated. Please use #eclipse.wtp.component.resource. See examples in EclipseWtpComponent.

Adds a wb-resource.

void variables(Map<String, File> variables)

Deprecated. Please use #eclipse.pathVariables. See examples in EclipseWtpComponent.

Adds variables to be used for replacing absolute path in dependent-module elements.

void whenConfigured(Closure closure)

Deprecated. Moved to the relevant type. Where? For starters, see examples in IdeaProject or EclipseProject.

Adds a closure to be called after the domain object has been configured by this task. The domain object is passed as a parameter to the closure.

The closure is executed just before the domain object is written to the output file. Using this method allows you to override the configuration applied by this task.

void whenConfigured(Action<? super T> action)

Deprecated. Moved to the relevant type. Where? For starters, see examples in IdeaProject or EclipseProject.

Adds an action to be called after the domain object has been configured by this task. The domain object is passed as a parameter to the action.

The action is executed just before the domain object is written to the output file. Using this method allows you to override the configuration applied by this task.

void withXml(Closure closure)

Deprecated. Moved to the relevant type. Where? For starters, see examples in IdeaProject or EclipseProject.

Adds a closure to be called when the XML document has been created. The XML is passed to the closure as a parameter in form of a XmlProvider. The closure can modify the XML before it is written to the output file.

void withXml(Action<? super XmlProvider> action)

Deprecated. Moved to the relevant type. Where? For starters, see examples in IdeaProject or EclipseProject.

Adds an action to be called when the XML document has been created. The XML is passed to the action as a parameter in form of a XmlProvider. The action can modify the XML before it is written to the output file.