MavenPom (Gradle API 2.2-20140924021627+0000)

```
public interface MavenPom
```
Is used for generating a Maven POM file and customizing the generation. To learn about the Maven POM see: http://maven.apache.org/pom.html

フィールドの概要

フィールド
修飾子とタイプフィールドと説明

static String POM_FILE_ENCODING

フィールド
修飾子とタイプ	フィールドと説明
`static String`	`POM_FILE_ENCODING`

メソッドの概要

All Methods Instance Methods Abstract Methods
修飾子とタイプ	メソッドと説明
`String`	`getArtifactId()` Returns the artifact id for this POM.
`ConfigurationContainer`	`getConfigurations()` Returns the configuration container used for mapping configurations to Maven scopes.
`List<?>`	`getDependencies()` Returns the dependencies for this POM.
`MavenPom`	`getEffectivePom()` Returns a POM with the generated dependencies and the `whenConfigured(org.gradle.api.Action)` actions applied.
`String`	`getGroupId()` Returns the group id for this POM.
`Object`	`getModel()` Returns the underlying native Maven `Model` object.
`String`	`getPackaging()` Returns the packaging for this POM.
`Conf2ScopeMappingContainer`	`getScopeMappings()` Returns the scope mappings used for generating this POM.
`String`	`getVersion()` Returns the version for this POM.
`MavenPom`	`project(Closure pom)` Provides a builder for the Maven POM for adding or modifying properties of the Maven `getModel()`.
`MavenPom`	`setArtifactId(String artifactId)` Sets the artifact id for this POM.
`MavenPom`	`setConfigurations(ConfigurationContainer configurations)` Sets the configuration container used for mapping configurations to Maven scopes.
`MavenPom`	`setDependencies(List<?> dependencies)` Sets the dependencies for this POM.
`MavenPom`	`setGroupId(String groupId)` Sets the group id for this POM.
`MavenPom`	`setModel(Object model)` Sets the underlying native Maven `Model` object.
`MavenPom`	`setPackaging(String packaging)` Sets the packaging for this POM.
`MavenPom`	`setVersion(String version)` Sets the version for this POM.
`MavenPom`	`whenConfigured(Action<MavenPom> action)` Adds an action to be called when the POM has been configured.
`MavenPom`	`whenConfigured(Closure closure)` Adds a closure to be called when the POM has been configured.
`MavenPom`	`withXml(Action<XmlProvider> action)` Adds an action to be called when the POM XML has been created.
`MavenPom`	`withXml(Closure closure)` Adds a closure to be called when the POM XML has been created.
`MavenPom`	`writeTo(Object path)` Writes the `getEffectivePom()` XML to a file while applying the `withXml(org.gradle.api.Action)` actions.
`MavenPom`	`writeTo(Writer writer)` Writes the `getEffectivePom()` XML to a writer while applying the `withXml(org.gradle.api.Action)` actions.

- フィールドの詳細
  - POM_FILE_ENCODING
```
static final String POM_FILE_ENCODING
```
    関連項目:
    
    定数フィールド値
- メソッドの詳細
  - getScopeMappings
```
Conf2ScopeMappingContainer getScopeMappings()
```
    Returns the scope mappings used for generating this POM.
  - project
```
MavenPom project(Closure pom)
```
    Provides a builder for the Maven POM for adding or modifying properties of the Maven getModel(). The syntax is exactly the same as used by polyglot Maven. For example:
```
 pom.project {
    inceptionYear '2008'
    licenses {
       license {
          name 'The Apache Software License, Version 2.0'
          url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
          distribution 'repo'
       }
    }
 }
 
```
    パラメータ:
    
    pom -
    
    戻り値:
    
    this
  - getGroupId
```
String getGroupId()
```
    Returns the group id for this POM.
    
    関連項目:
    
    Model.setGroupId(String)
  - setGroupId
```
MavenPom setGroupId(String groupId)
```
    Sets the group id for this POM.
    
    戻り値:
    
    this
    
    関連項目:
    
    Model.getGroupId()
  - getArtifactId
```
String getArtifactId()
```
    Returns the artifact id for this POM.
    
    関連項目:
    
    Model.getArtifactId()
  - setArtifactId
```
MavenPom setArtifactId(String artifactId)
```
    Sets the artifact id for this POM.
    
    戻り値:
    
    this
    
    関連項目:
    
    Model.setArtifactId(String)
  - getVersion
```
String getVersion()
```
    Returns the version for this POM.
    
    関連項目:
    
    Model.getVersion()
  - setVersion
```
MavenPom setVersion(String version)
```
    Sets the version for this POM.
    
    戻り値:
    
    this
    
    関連項目:
    
    Model.setVersion(String)
  - getPackaging
```
String getPackaging()
```
    Returns the packaging for this POM.
    
    関連項目:
    
    Model.getPackaging()
  - setPackaging
```
MavenPom setPackaging(String packaging)
```
    Sets the packaging for this POM.
    
    戻り値:
    
    this
    
    関連項目:
    
    Model.setPackaging(String)
  - setDependencies
```
MavenPom setDependencies(List<?> dependencies)
```
    Sets the dependencies for this POM.
    
    戻り値:
    
    this
    
    関連項目:
    
    ModelBase.setDependencies(java.util.List)
  - getDependencies
```
List<?> getDependencies()
```
    Returns the dependencies for this POM.
    
    関連項目:
    
    ModelBase.getDependencies()
  - getModel
```
Object getModel()
```
    Returns the underlying native Maven Model object. The MavenPom object delegates all the configuration information to this object. There Gradle MavenPom objects provides delegation methods just for setting the groupId, artifactId, version and packaging. For all other elements, either use the model object or project(groovy.lang.Closure).
    
    戻り値:
    
    the underlying native Maven object
  - setModel
```
MavenPom setModel(Object model)
```
    Sets the underlying native Maven Model object.
    
    パラメータ:
    
    model -
    
    戻り値:
    
    this
    
    関連項目:
    
    getModel()
  - writeTo
```
MavenPom writeTo(Writer writer)
```
    Writes the getEffectivePom() XML to a writer while applying the withXml(org.gradle.api.Action) actions. Closes the supplied Writer when finished.
    
    パラメータ:
    
    writer - The writer to write the POM to.
    
    戻り値:
    
    this
  - writeTo
```
MavenPom writeTo(Object path)
```
    Writes the getEffectivePom() XML to a file while applying the withXml(org.gradle.api.Action) actions. The path is resolved as defined by Project.files(Object...) The file will be encoded as UTF-8.
    
    パラメータ:
    
    path - The path of the file to write the POM into.
    
    戻り値:
    
    this
  - whenConfigured
```
MavenPom whenConfigured(Closure closure)
```
    Adds a closure to be called when the POM has been configured. The POM is passed to the closure as a parameter.
    
    パラメータ:
    
    closure - The closure to execute when the POM has been configured.
    
    戻り値:
    
    this
  - whenConfigured
```
MavenPom whenConfigured(Action<MavenPom> action)
```
    Adds an action to be called when the POM has been configured. The POM is passed to the action as a parameter.
    
    パラメータ:
    
    action - The action to execute when the POM has been configured.
    
    戻り値:
    
    this
  - withXml
```
MavenPom withXml(Closure closure)
```
    Adds a closure to be called when the POM XML has been created. The XML is passed to the closure as a parameter in form of a XmlProvider. The action can modify the XML.
    
    パラメータ:
    
    closure - The closure to execute when the POM XML has been created.
    
    戻り値:
    
    this
  - withXml
```
MavenPom withXml(Action<XmlProvider> action)
```
    Adds an action to be called when the POM XML has been created. The XML is passed to the action as a parameter in form of a XmlProvider. The action can modify the XML.
    
    パラメータ:
    
    action - The action to execute when the POM XML has been created.
    
    戻り値:
    
    this
  - getConfigurations
```
ConfigurationContainer getConfigurations()
```
    Returns the configuration container used for mapping configurations to Maven scopes.
  - setConfigurations
```
MavenPom setConfigurations(ConfigurationContainer configurations)
```
    Sets the configuration container used for mapping configurations to Maven scopes.
    
    戻り値:
    
    this
  - getEffectivePom
```
MavenPom getEffectivePom()
```
    Returns a POM with the generated dependencies and the whenConfigured(org.gradle.api.Action) actions applied.
    
    戻り値:
    
    the effective POM

インタフェース MavenPom

フィールドの概要

メソッドの概要

フィールドの詳細

POM_FILE_ENCODING

メソッドの詳細

getScopeMappings

project

getGroupId

setGroupId

getArtifactId

setArtifactId

getVersion

setVersion

getPackaging

setPackaging

setDependencies

getDependencies

getModel

setModel

writeTo

writeTo

whenConfigured

whenConfigured

withXml

withXml

getConfigurations

setConfigurations

getEffectivePom