public interface PomFilterContainer
MavenPom
instances and their associated PublishFilter
instances.Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_ARTIFACT_POM_NAME |
Modifier and Type | Method and Description |
---|---|
MavenPom |
addFilter(String name,
Closure filter)
Adds a publish filter.
|
MavenPom |
addFilter(String name,
PublishFilter publishFilter)
If you want to deploy more than one artifact you need to define filters to select each of those artifacts.
|
void |
filter(Closure filter)
Sets the default publish filter.
|
PublishFilter |
filter(String name)
Returns a filter added with
addFilter(String, org.gradle.api.artifacts.maven.PublishFilter) . |
Iterable<org.gradle.api.publication.maven.internal.PomFilter> |
getActivePomFilters() |
PublishFilter |
getFilter()
Returns the default filter being used.
|
MavenPom |
getPom()
Returns the POM property of the custom filter.
|
MavenPom |
pom(Closure configureClosure)
Configures the default POM by a closure.
|
MavenPom |
pom(String name)
Returns the POM associated with a filter added with
addFilter(String, org.gradle.api.artifacts.maven.PublishFilter) . |
MavenPom |
pom(String name,
Closure configureClosure)
Configures a POM by a closure.
|
void |
setFilter(PublishFilter defaultFilter)
Sets the default filter to be used.
|
void |
setPom(MavenPom defaultPom)
Sets the default POM to be used.
|
static final String DEFAULT_ARTIFACT_POM_NAME
PublishFilter getFilter()
void setFilter(PublishFilter defaultFilter)
Sets the default filter to be used. This filter is active if no custom filters have been added (see addFilter(String, org.gradle.api.artifacts.maven.PublishFilter)
).
If at least one custom filter has been added the default filter is not used any longer.
The default for this property is PublishFilter.ALWAYS_ACCEPT
.
If there is only one artifact you are fine with this filter. If there is more than one artifact, deployment will lead to
an exception, if you don't specify a filter that selects the artifact to deploy. If you want to deploy more than one artifact you have
to use the (see addFilter(String, org.gradle.api.artifacts.maven.PublishFilter)
method.
defaultFilter
- getFilter()
MavenPom getPom()
void setPom(MavenPom defaultPom)
Sets the default POM to be used. This POM is active if no custom filters have been added (see addFilter(String, org.gradle.api.artifacts.maven.PublishFilter)
).
If at least one custom filter has been added the default POM is not used any longer.
Usually you don't need to set this property as the default value provides you a POM object you might use for configuration. By default the properties of such a POM object are all null. If they are null, Gradle will use default values for generating the Maven POM. Those default values are derived from the deployable artifact and from the project type (e.g. java, war, ...). If you explicitly set a POM property, Gradle will use this instead.
defaultPom
- MavenPom addFilter(String name, PublishFilter publishFilter)
name
- The name of the filterpublishFilter
- The filter to useMavenPom addFilter(String name, Closure filter)
name
- The name of the filterfilter
- The filterPublishFilter
,
addFilter(String, org.gradle.api.artifacts.maven.PublishFilter)
PublishFilter filter(String name)
addFilter(String, org.gradle.api.artifacts.maven.PublishFilter)
.name
- The name of the filtervoid filter(Closure filter)
filter
- The filter to be setPublishFilter
,
setFilter(org.gradle.api.artifacts.maven.PublishFilter)
MavenPom pom(String name)
addFilter(String, org.gradle.api.artifacts.maven.PublishFilter)
.name
- The name of the filter.MavenPom pom(String name, Closure configureClosure)
name
- configureClosure
- pom(String)
MavenPom pom(Closure configureClosure)
configureClosure
- getPom()
Iterable<org.gradle.api.publication.maven.internal.PomFilter> getActivePomFilters()