WarOverlay (maven-plugin 8.3 API)

java.lang.Object
- io.freefair.gradle.plugins.maven.war.WarOverlay

```
public class WarOverlay
extends Object
```

Constructor Summary

Constructors
Constructor and Description

WarOverlay(String name, War warTask)

Constructors
Constructor and Description
`WarOverlay(String name, War warTask)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`exclude(groovy.lang.Closure excludeSpec)`
`void`	`exclude(Iterable<String> excludes)`
`void`	`exclude(Spec<FileTreeElement> excludeSpec)`
`void`	`exclude(String... excludes)`
`void`	`from(Object object)`
`void`	`from(Object object, groovy.lang.Closure configureClosure)`
`String`	`getConfigurationName()`
`groovy.lang.Closure`	`getConfigureClosure()` This `Closure` is passed to `DependencyHandler.create(Object, Closure)` when `source` is resolved as dependency.
`Set<String>`	`getExcludes()`
`Set<String>`	`getIncludes()`
`String`	`getName()`
`Object`	`getSource()` The source of the overlay, this can be: An arbitrary `AbstractArchiveTask` An other Project which has the `'war'-plugin` applied A `File` instance Anything that can be used as Dependency.
`org.gradle.api.internal.file.copy.CopySpecInternal`	`getWarCopySpec()`
`War`	`getWarTask()`
`CopySpec`	`include(groovy.lang.Closure includeSpec)`
`CopySpec`	`include(Iterable<String> includes)`
`CopySpec`	`include(Spec<FileTreeElement> includeSpec)`
`CopySpec`	`include(String... includes)`
`void`	`into(Object destPath)`
`boolean`	`isDeferProvidedConfiguration()` If set to true (default) the `provided` setting is applied to the `War task` before its execution.
`boolean`	`isEnableCompilation()` Enable (java-)compilation against the classes(`WEB-INF/classes`) and jars(`WEB-INF/lib`) of the overlay
`boolean`	`isEnabled()`
`boolean`	`isProvided()`
`boolean`	`isSkip()`
`void`	`provided()`
`void`	`provided(boolean provided)`
`void`	`setConfigureClosure(groovy.lang.Closure configureClosure)` This `Closure` is passed to `DependencyHandler.create(Object, Closure)` when `source` is resolved as dependency.
`void`	`setDeferProvidedConfiguration(boolean deferProvidedConfiguration)` If set to true (default) the `provided` setting is applied to the `War task` before its execution.
`void`	`setEnableCompilation(boolean enableCompilation)` Enable (java-)compilation against the classes(`WEB-INF/classes`) and jars(`WEB-INF/lib`) of the overlay
`void`	`setEnabled(boolean enabled)`
`void`	`setExcludes(Iterable<String> excludes)`
`CopySpec`	`setIncludes(Iterable<String> includes)`
`void`	`setInto(String destPath)`
`void`	`setProvided(boolean provided)`
`void`	`setSkip(boolean skip)`
`void`	`setSource(Object source)` The source of the overlay, this can be: An arbitrary `AbstractArchiveTask` An other Project which has the `'war'-plugin` applied A `File` instance Anything that can be used as Dependency.
`void`	`setTargetPath(String targetPath)`
`void`	`setWarCopySpec(org.gradle.api.internal.file.copy.CopySpecInternal warCopySpec)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WarOverlay
```
public WarOverlay(String name,
                  War warTask)
```
- Method Detail
  - from
```
public void from(Object object)
```
  - from
```
public void from(Object object,
                 groovy.lang.Closure configureClosure)
```
    Parameters:
    
    object - see source
    
    configureClosure - see configureClosure
  - provided
```
public void provided()
```
  - provided
```
public void provided(boolean provided)
```
  - setTargetPath
```
public void setTargetPath(String targetPath)
```
    See Also:
    
    into(java.lang.Object)
  - setSkip
```
public void setSkip(boolean skip)
```
    See Also:
    
    enabled
  - isSkip
```
public boolean isSkip()
```
    See Also:
    
    enabled
  - getConfigurationName
```
public String getConfigurationName()
```
  - setInto
```
public void setInto(String destPath)
```
  - into
```
public void into(Object destPath)
```
  - setExcludes
```
public void setExcludes(Iterable<String> excludes)
```
  - include
```
public CopySpec include(String... includes)
```
  - include
```
public CopySpec include(Iterable<String> includes)
```
  - include
```
public CopySpec include(Spec<FileTreeElement> includeSpec)
```
  - include
```
public CopySpec include(groovy.lang.Closure includeSpec)
```
  - exclude
```
public void exclude(String... excludes)
```
  - exclude
```
public void exclude(Iterable<String> excludes)
```
  - exclude
```
public void exclude(Spec<FileTreeElement> excludeSpec)
```
  - exclude
```
public void exclude(groovy.lang.Closure excludeSpec)
```
  - getIncludes
```
public Set<String> getIncludes()
```
  - getExcludes
```
public Set<String> getExcludes()
```
  - setIncludes
```
public CopySpec setIncludes(Iterable<String> includes)
```
  - getName
```
public String getName()
```
  - getWarTask
```
public War getWarTask()
```
  - getWarCopySpec
```
public org.gradle.api.internal.file.copy.CopySpecInternal getWarCopySpec()
```
  - getSource
```
public Object getSource()
```
    The source of the overlay, this can be:
    - An arbitrary AbstractArchiveTask
    - An other Project which has the 'war'-plugin applied
    - A File instance
    - Anything that can be used as Dependency. See DependencyHandler.create(Object)
  - getConfigureClosure
```
public groovy.lang.Closure getConfigureClosure()
```
    This Closure is passed to DependencyHandler.create(Object, Closure) when source is resolved as dependency.
    
    See Also:
    
    DependencyHandler.create(Object, Closure)
  - isEnabled
```
public boolean isEnabled()
```
  - isProvided
```
public boolean isProvided()
```
  - isDeferProvidedConfiguration
```
public boolean isDeferProvidedConfiguration()
```
    If set to true (default) the provided setting is applied to the War task before its execution. If set to false, the task will be completely configured at configuration time.
    This can be used to get auto-competition in some IDE's (IntelliJ)
  - isEnableCompilation
```
public boolean isEnableCompilation()
```
    Enable (java-)compilation against the classes(WEB-INF/classes) and jars(WEB-INF/lib) of the overlay
  - setWarCopySpec
```
public void setWarCopySpec(org.gradle.api.internal.file.copy.CopySpecInternal warCopySpec)
```
  - setSource
```
public void setSource(Object source)
```
    The source of the overlay, this can be:
    - An arbitrary AbstractArchiveTask
    - An other Project which has the 'war'-plugin applied
    - A File instance
    - Anything that can be used as Dependency. See DependencyHandler.create(Object)
  - setConfigureClosure
```
public void setConfigureClosure(groovy.lang.Closure configureClosure)
```
    This Closure is passed to DependencyHandler.create(Object, Closure) when source is resolved as dependency.
    
    See Also:
    
    DependencyHandler.create(Object, Closure)
  - setEnabled
```
public void setEnabled(boolean enabled)
```
  - setProvided
```
public void setProvided(boolean provided)
```
  - setDeferProvidedConfiguration
```
public void setDeferProvidedConfiguration(boolean deferProvidedConfiguration)
```
    If set to true (default) the provided setting is applied to the War task before its execution. If set to false, the task will be completely configured at configuration time.
    This can be used to get auto-competition in some IDE's (IntelliJ)
  - setEnableCompilation
```
public void setEnableCompilation(boolean enableCompilation)
```
    Enable (java-)compilation against the classes(WEB-INF/classes) and jars(WEB-INF/lib) of the overlay

Class WarOverlay

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WarOverlay

Method Detail

from

from

provided

provided

setTargetPath

setSkip

isSkip

getConfigurationName

setInto

into

setExcludes

include

include

include

include

exclude

exclude

exclude

exclude

getIncludes

getExcludes

setIncludes

getName

getWarTask

getWarCopySpec

getSource

getConfigureClosure

isEnabled

isProvided

isDeferProvidedConfiguration

isEnableCompilation

setWarCopySpec

setSource

setConfigureClosure

setEnabled

setProvided

setDeferProvidedConfiguration

setEnableCompilation