ru.yandex.qatools.clay.maven.settings

Class FluentModelBuilder

java.lang.Object

ru.yandex.qatools.clay.maven.settings.FluentModelBuilder

public class FluentModelBuilder
extends java.lang.Object

Author:

innokenty

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.maven.model.Model	build()
FluentModelBuilder	marshalTo(java.io.File file)
FluentModelBuilder	marshalTo(java.io.FileOutputStream outputStream)
FluentModelBuilder	marshalTo(java.io.Writer writer)
static FluentModelBuilder	newModel()
static FluentModelBuilder	newModel(java.io.FileInputStream inputStream)
static FluentModelBuilder	newPom()
protected static FluentModelBuilder	newPom(java.io.FileInputStream inputStream)
FluentModelBuilder	withArtifactId(java.lang.String artifactId) Set the identifier for this artifact that is unique within the group given by the group ID.
FluentModelBuilder	withBuild(org.apache.maven.model.Build build) Set information required to build the project.
FluentModelBuilder	withCiManagement(org.apache.maven.model.CiManagement ciManagement) Set the project's continuous integration information.
FluentModelBuilder	withContributor(org.apache.maven.model.Contributor contributor) Method addContributor.
FluentModelBuilder	withContributors(java.util.List<org.apache.maven.model.Contributor> contributors) Set describes the contributors to a project that are not yet committers.
FluentModelBuilder	withDependencies(java.util.List<org.apache.maven.model.Dependency> dependencies) Set this element describes all of the dependencies associated with a project.
FluentModelBuilder	withDependency(org.apache.maven.model.Dependency dependency) Method addDependency.
FluentModelBuilder	withDependencyManagement(org.apache.maven.model.DependencyManagement dependencyManagement) Set default dependency information for projects that inherit from this one.
FluentModelBuilder	withDescription(java.lang.String description) Set a detailed description of the project, used by Maven whenever it needs to describe the project, such as on the web site.
FluentModelBuilder	withDeveloper(org.apache.maven.model.Developer developer) Method addDeveloper.
FluentModelBuilder	withDevelopers(java.util.List<org.apache.maven.model.Developer> developers) Set describes the committers of a project.
FluentModelBuilder	withDistributionManagement(org.apache.maven.model.DistributionManagement distributionManagement) Set distribution information for a project that enables deployment of the site and artifacts to remote web servers and repositories respectively.
FluentModelBuilder	withGroupId(java.lang.String groupId) Set a universally unique identifier for a project.
FluentModelBuilder	withInceptionYear(java.lang.String inceptionYear) Set the year of the project's inception, specified with 4 digits.
FluentModelBuilder	withIssueManagement(org.apache.maven.model.IssueManagement issueManagement) Set the project's issue management system information.
FluentModelBuilder	withLicense(org.apache.maven.model.License license) Method addLicense.
FluentModelBuilder	withLicenses(java.util.List<org.apache.maven.model.License> licenses) Set this element describes all of the licenses for this project.
FluentModelBuilder	withLocation(java.lang.Object key, org.apache.maven.model.InputLocation location)
FluentModelBuilder	withMailingList(org.apache.maven.model.MailingList mailingList) Method addMailingList.
FluentModelBuilder	withMailingLists(java.util.List<org.apache.maven.model.MailingList> mailingLists) Set contains information about a project's mailing lists.
FluentModelBuilder	withModelEncoding(java.lang.String modelEncoding) Set the modelEncoding field.
FluentModelBuilder	withModelVersion(java.lang.String modelVersion) Set declares to which version of project descriptor this POM conforms.
FluentModelBuilder	withModule(java.lang.String string) Method addModule.
FluentModelBuilder	withModules(java.util.List<java.lang.String> modules) Set the modules (sometimes called subprojects) to build as a part of this project.
FluentModelBuilder	withName(java.lang.String name) Set the full name of the project.
FluentModelBuilder	withOrganization(org.apache.maven.model.Organization organization) Set this element describes various attributes of the organization to which the project belongs.
FluentModelBuilder	withPackaging(java.lang.String packaging) Set the type of artifact this project produces, for example jar war ear pom.
FluentModelBuilder	withParent(org.apache.maven.model.Parent parent) Set the location of the parent project, if one exists.
FluentModelBuilder	withPluginRepositories(java.util.List<org.apache.maven.model.Repository> pluginRepositories) Set the lists of the remote repositories for discovering plugins for builds and reports.
FluentModelBuilder	withPluginRepository(org.apache.maven.model.Repository repository) Method addPluginRepository.
FluentModelBuilder	withPomFile(java.io.File pomFile)
FluentModelBuilder	withPrerequisites(org.apache.maven.model.Prerequisites prerequisites) Set describes the prerequisites in the build environment for this project.
FluentModelBuilder	withProfile(org.apache.maven.model.Profile profile) Method addProfile.
FluentModelBuilder	withProfiles(java.util.List<org.apache.maven.model.Profile> profiles) Set a listing of project-local build profiles which will modify the build process when activated.
FluentModelBuilder	withProperties(java.util.Properties properties) Set properties that can be used throughout the POM as a substitution, and are used as filters in resources if enabled.
FluentModelBuilder	withProperty(java.lang.String key, java.lang.String value) Method addProperty.
FluentModelBuilder	withReporting(org.apache.maven.model.Reporting reporting) Set this element includes the specification of report plugins to use to generate the reports on the Maven-generated site.
FluentModelBuilder	withReports(java.lang.Object reports) Set Deprecated.
FluentModelBuilder	withRepositories(java.util.List<org.apache.maven.model.Repository> repositories) Set the lists of the remote repositories for discovering dependencies and extensions.
FluentModelBuilder	withRepository(org.apache.maven.model.Repository repository) Method addRepository.
FluentModelBuilder	withScm(org.apache.maven.model.Scm scm) Set specification for the SCM used by the project, such as CVS, Subversion, etc.
FluentModelBuilder	withUrl(java.lang.String url) Set the URL to the project's homepage.
FluentModelBuilder	withVersion(java.lang.String version) Set the current version of the artifact produced by this project.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newModel

public static FluentModelBuilder newModel()

newPom

public static FluentModelBuilder newPom()

newModel

public static FluentModelBuilder newModel(java.io.FileInputStream inputStream)
                                   throws java.io.IOException,
                                          org.codehaus.plexus.util.xml.pull.XmlPullParserException

Throws:

java.io.IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

newPom

protected static FluentModelBuilder newPom(java.io.FileInputStream inputStream)
                                    throws java.io.IOException,
                                           org.codehaus.plexus.util.xml.pull.XmlPullParserException

Throws:

java.io.IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

marshalTo

public FluentModelBuilder marshalTo(java.io.File file)
                             throws java.io.IOException

Throws:

java.io.IOException

marshalTo

public FluentModelBuilder marshalTo(java.io.FileOutputStream outputStream)
                             throws java.io.IOException

Throws:

java.io.IOException

marshalTo

public FluentModelBuilder marshalTo(java.io.Writer writer)
                             throws java.io.IOException

Throws:

java.io.IOException

build

public org.apache.maven.model.Model build()

withContributor

public FluentModelBuilder withContributor(org.apache.maven.model.Contributor contributor)

Method addContributor.

Parameters:

contributor -

withDeveloper

public FluentModelBuilder withDeveloper(org.apache.maven.model.Developer developer)

Method addDeveloper.

Parameters:

developer -

withLicense

public FluentModelBuilder withLicense(org.apache.maven.model.License license)

Method addLicense.

Parameters:

license -

withMailingList

public FluentModelBuilder withMailingList(org.apache.maven.model.MailingList mailingList)

Method addMailingList.

Parameters:

mailingList -

withProfile

public FluentModelBuilder withProfile(org.apache.maven.model.Profile profile)

Method addProfile.

Parameters:

profile -

withArtifactId

public FluentModelBuilder withArtifactId(java.lang.String artifactId)

Set the identifier for this artifact that is unique within the group given by the group ID. An artifact is something that is either produced or used by a project. Examples of artifacts produced by Maven for a project include: JARs, source and binary distributions, and WARs.

Parameters:

artifactId -

withBuild

public FluentModelBuilder withBuild(org.apache.maven.model.Build build)

Set information required to build the project.

Parameters:

build -

withCiManagement

public FluentModelBuilder withCiManagement(org.apache.maven.model.CiManagement ciManagement)

Set the project's continuous integration information.

Parameters:

ciManagement -

withContributors

public FluentModelBuilder withContributors(java.util.List<org.apache.maven.model.Contributor> contributors)

Set describes the contributors to a project that are not yet committers.

Parameters:

contributors -

withDescription

public FluentModelBuilder withDescription(java.lang.String description)

Set a detailed description of the project, used by Maven whenever it needs to describe the project, such as on the web site. While this element can be specified as CDATA to enable the use of HTML tags within the description, it is discouraged to allow plain text representation. If you need to modify the index page of the generated web site, you are able to specify your own instead of adjusting this text.

Parameters:

description -

withDevelopers

public FluentModelBuilder withDevelopers(java.util.List<org.apache.maven.model.Developer> developers)

Set describes the committers of a project.

Parameters:

developers -

withGroupId

public FluentModelBuilder withGroupId(java.lang.String groupId)

Set a universally unique identifier for a project. It is normal to use a fully-qualified package name to distinguish it from other projects with a similar name (eg. org.apache.maven).

Parameters:

groupId -

withInceptionYear

public FluentModelBuilder withInceptionYear(java.lang.String inceptionYear)

Set the year of the project's inception, specified with 4 digits. This value is used when generating copyright notices as well as being informational.

Parameters:

inceptionYear -

withIssueManagement

public FluentModelBuilder withIssueManagement(org.apache.maven.model.IssueManagement issueManagement)

Set the project's issue management system information.

Parameters:

issueManagement -

withLicenses

public FluentModelBuilder withLicenses(java.util.List<org.apache.maven.model.License> licenses)

Set this element describes all of the licenses for this project. Each license is described by a license element, which is then described by additional elements. Projects should only list the license(s) that applies to the project and not the licenses that apply to dependencies. If multiple licenses are listed, it is assumed that the user can select any of them, not that they must accept all.

Parameters:

licenses -

withMailingLists

public FluentModelBuilder withMailingLists(java.util.List<org.apache.maven.model.MailingList> mailingLists)

Set contains information about a project's mailing lists.

Parameters:

mailingLists -

withModelEncoding

public FluentModelBuilder withModelEncoding(java.lang.String modelEncoding)

Set the modelEncoding field.

Parameters:

modelEncoding -

withModelVersion

public FluentModelBuilder withModelVersion(java.lang.String modelVersion)

Set declares to which version of project descriptor this POM conforms.

Parameters:

modelVersion -

withName

public FluentModelBuilder withName(java.lang.String name)

Set the full name of the project.

Parameters:

name -

withOrganization

public FluentModelBuilder withOrganization(org.apache.maven.model.Organization organization)

Set this element describes various attributes of the organization to which the project belongs. These attributes are utilized when documentation is created (for copyright notices and links).

Parameters:

organization -

withPackaging

public FluentModelBuilder withPackaging(java.lang.String packaging)

Set the type of artifact this project produces, for example jar war ear pom. Plugins can create their own packaging, and therefore their own packaging types, so this list does not contain all possible types.

Parameters:

packaging -

withParent

public FluentModelBuilder withParent(org.apache.maven.model.Parent parent)

Set the location of the parent project, if one exists. Values from the parent project will be the default for this project if they are left unspecified. The location is given as a group ID, artifact ID and version.

Parameters:

parent -

withPrerequisites

public FluentModelBuilder withPrerequisites(org.apache.maven.model.Prerequisites prerequisites)

Set describes the prerequisites in the build environment for this project.

Parameters:

prerequisites -

withProfiles

public FluentModelBuilder withProfiles(java.util.List<org.apache.maven.model.Profile> profiles)

Set a listing of project-local build profiles which will modify the build process when activated.

Parameters:

profiles -

withScm

public FluentModelBuilder withScm(org.apache.maven.model.Scm scm)

Set specification for the SCM used by the project, such as CVS, Subversion, etc.

Parameters:

scm -

withUrl

public FluentModelBuilder withUrl(java.lang.String url)

Set the URL to the project's homepage.
Default value is: parent value [+ path adjustment] + artifactId.

Parameters:

url -

withVersion

public FluentModelBuilder withVersion(java.lang.String version)

Set the current version of the artifact produced by this project.

Parameters:

version -

withPomFile

public FluentModelBuilder withPomFile(java.io.File pomFile)

withDependency

public FluentModelBuilder withDependency(org.apache.maven.model.Dependency dependency)

Method addDependency.

Parameters:

dependency -

withModule

public FluentModelBuilder withModule(java.lang.String string)

Method addModule.

Parameters:

string -

withPluginRepository

public FluentModelBuilder withPluginRepository(org.apache.maven.model.Repository repository)

Method addPluginRepository.

Parameters:

repository -

withProperty

public FluentModelBuilder withProperty(java.lang.String key,
                              java.lang.String value)

Method addProperty.

Parameters:

key -

value -

withRepository

public FluentModelBuilder withRepository(org.apache.maven.model.Repository repository)

Method addRepository.

Parameters:

repository -

withDependencies

public FluentModelBuilder withDependencies(java.util.List<org.apache.maven.model.Dependency> dependencies)

Set this element describes all of the dependencies associated with a project. These dependencies are used to construct a classpath for your project during the build process. They are automatically downloaded from the repositories defined in this project. See the dependency mechanism for more information.

Parameters:

dependencies -

withDependencyManagement

public FluentModelBuilder withDependencyManagement(org.apache.maven.model.DependencyManagement dependencyManagement)

Set default dependency information for projects that inherit from this one. The dependencies in this section are not immediately resolved. Instead, when a POM derived from this one declares a dependency described by a matching groupId and artifactId, the version and other values from this section are used for that dependency if they were not already specified.

Parameters:

dependencyManagement -

withDistributionManagement

public FluentModelBuilder withDistributionManagement(org.apache.maven.model.DistributionManagement distributionManagement)

Set distribution information for a project that enables deployment of the site and artifacts to remote web servers and repositories respectively.

Parameters:

distributionManagement -

withLocation

public FluentModelBuilder withLocation(java.lang.Object key,
                              org.apache.maven.model.InputLocation location)

Parameters:

key -

location -

withModules

public FluentModelBuilder withModules(java.util.List<java.lang.String> modules)

Set the modules (sometimes called subprojects) to build as a part of this project. Each module listed is a relative path to the directory containing the module. To be consistent with the way default urls are calculated from parent, it is recommended to have module names match artifact ids.

Parameters:

modules -

withPluginRepositories

public FluentModelBuilder withPluginRepositories(java.util.List<org.apache.maven.model.Repository> pluginRepositories)

Set the lists of the remote repositories for discovering plugins for builds and reports.

Parameters:

pluginRepositories -

withProperties

public FluentModelBuilder withProperties(java.util.Properties properties)

Set properties that can be used throughout the POM as a substitution, and are used as filters in resources if enabled. The format is <name>value</name>.

Parameters:

properties -

withReporting

public FluentModelBuilder withReporting(org.apache.maven.model.Reporting reporting)

Set this element includes the specification of report plugins to use to generate the reports on the Maven-generated site. These reports will be run when a user executes mvn site. All of the reports will be included in the navigation bar for browsing.

Parameters:

reporting -

withReports

public FluentModelBuilder withReports(java.lang.Object reports)

Set Deprecated. Now ignored by Maven.

Parameters:

reports -

withRepositories

public FluentModelBuilder withRepositories(java.util.List<org.apache.maven.model.Repository> repositories)

Set the lists of the remote repositories for discovering dependencies and extensions.

Parameters:

repositories -