|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.project.BaseObject
org.apache.maven.project.Project
Field Summary |
Fields inherited from class org.apache.maven.project.BaseObject |
id |
Constructor Summary | |
Project()
Default constructor. |
Method Summary | |
void |
addBranch(Branch branch)
Add a branch to this project. |
void |
addContributor(Contributor contributor)
Add a contributor to this project. |
void |
addDependency(Dependency dependency)
Add a unique dependency for this project. |
void |
addDeveloper(Developer developer)
Add a developer to this project. |
void |
addLicense(License license)
Add a license to this project. |
void |
addMailingList(MailingList mailingList)
Add a mailing list for this project. |
void |
addPackageGroup(PackageGroup packageGroup)
Adds a new PackageGroup to this project |
void |
addReport(java.lang.String report)
Add a unique report for this project. |
void |
addVersion(Version version)
Add a distribution to this project. |
void |
buildArtifactList()
Build the artifact list. |
org.dom4j.Document |
createDocument()
Create a dom4j document from the POM. |
java.lang.String |
getArtifactDirectory()
|
java.lang.String |
getArtifactId()
Get the artifact id. |
java.util.List |
getArtifacts()
Get the atrifact attribute. |
java.util.List |
getBranches()
Return the branches for this project. |
Build |
getBuild()
Get the build model for this project. |
MavenJellyContext |
getContext()
Get the context attribute. |
java.util.List |
getContributors()
Return the contributors for this project. |
java.lang.String |
getCurrentVersion()
Gets the currentVersion attribute of the Project object. |
java.util.List |
getDependencies()
Get the list of dependencies for this project. |
Dependency |
getDependency(java.lang.String depId)
Get an individual dependency by id. |
java.lang.String |
getDependencyClasspath()
Get the dependency classpath. |
java.lang.String |
getDependencyPath(java.lang.String depId)
Get an individual dependencies classpath entry. |
DependencyVerifier |
getDependencyVerifier()
Get the dependency verifier for this project. |
java.util.Set |
getDependentProjectIds()
Get the list of dependent projects ids. |
java.lang.String |
getDescription()
Gets the description attribute of the Project object. |
java.util.List |
getDevelopers()
Return the developers for this project. |
java.lang.String |
getDistributionDirectory()
Get the project's distribution directory. |
java.lang.String |
getDistributionSite()
Get the project's distribution site. |
java.lang.String |
getExtend()
Get the path to the file that this project extends. |
java.io.File |
getFile()
Get the file this POM was derived from |
java.lang.String |
getGroupId()
The group id in a particular POM refers to a real id of another project. |
java.lang.String |
getGumpRepositoryId()
Get the gump repository descriptor. |
java.lang.String |
getId()
Gets the id attribute |
java.lang.String |
getInceptionYear()
Gets the inceptionYear attribute of the Project object |
java.lang.String |
getIssueTrackingUrl()
Set the URL to this project's issue tracking system. |
java.util.List |
getLicenses()
Return the licenses for this project. |
java.lang.String |
getLogo()
Return the project logo image URL. |
java.util.List |
getMailingLists()
Return the mailing lists for this project. |
java.io.File |
getMavenXml()
|
Organization |
getOrganization()
Get the Project Organization. |
java.lang.String |
getPackage()
Gets the package attribute of the Project object. |
java.util.List |
getPackageGroups()
Returns a list of PackageGroup instances used for documenting the packages |
Project |
getParent()
|
MavenJellyContext |
getPluginContext(java.lang.String pluginId)
Deprecated. use the tag instead |
java.lang.String |
getPomVersion()
Gets the version attribute of the Project object. |
java.util.List |
getReports()
Get the list of dependencies for this project. |
Repository |
getRepository()
Return the repository used by this project. |
java.lang.String |
getShortDescription()
Get short description |
java.lang.String |
getSiteAddress()
Get the projects site address. |
java.lang.String |
getSiteDirectory()
Get the project's site directory. |
java.lang.String |
getUrl()
Set the URL to this project's main page. |
Version |
getVersionById(java.lang.String versionId)
Return a distribution for this project. |
java.util.List |
getVersions()
Return the distributions for this project. |
boolean |
hasMavenXml()
|
boolean |
hasParent()
Determine whether this project has a parent. |
boolean |
hasRepository()
Get flag to indicate the presence of a source repository. |
void |
initialize()
Initialize the project. |
boolean |
isPomCurrent()
Indicate whether the POM is of the latest version. |
static java.lang.String |
legacyToStandardId(java.lang.String id)
This is to support methods that are using the legacy form of the project id. |
void |
mergeParent(Project parent)
Setup inheritance from a parent project. |
java.io.File |
parentBasedir()
Get the parent's basedir. |
java.io.File |
parentMavenXml()
Get parent maven.xml file. |
void |
popContext()
|
void |
pushContext(MavenJellyContext context)
Push a new context onto the stack. |
void |
setArtifactId(java.lang.String artifactId)
Set the artifactId for this project. |
void |
setArtifacts(java.util.List artifactList)
Set the artifactList attribute. |
void |
setBranches(java.util.List branches)
Set the branches for this project. |
void |
setBuild(Build build)
Sets the build attribute of the Project object |
void |
setContext(MavenJellyContext context)
Set the context attribute. |
void |
setContributors(java.util.List contributors)
Set contributors for this project. |
void |
setCurrentVersion(java.lang.String currentVersion)
Sets the currentVersion attribute of the Project object. |
void |
setDependencies(java.util.List dependencies)
Set a list of dependencies. |
void |
setDependencyPath(java.lang.String depId,
java.lang.String path)
Set an individual dependency's classpath entry. |
void |
setDependencyVerifier(DependencyVerifier dependencyVerifier)
Set the dependency verifier. |
void |
setDescription(java.lang.String description)
Sets the description attribute of the Project object. |
void |
setDevelopers(java.util.List developers)
Set the list of developers for this project. |
void |
setDistributionDirectory(java.lang.String distributionDirectory)
Set the distribution directory. |
void |
setDistributionSite(java.lang.String distributionSite)
Set the distribution site. |
void |
setExtend(java.lang.String pomToExtend)
Set the path to the file that this project extends. |
void |
setFile(java.io.File file)
Set the file that this POM was derived from. |
void |
setGroupId(java.lang.String groupId)
Set the project group id. |
void |
setGumpRepositoryId(java.lang.String gumpRepositoryId)
Set the gump repository descriptor. |
void |
setInceptionYear(java.lang.String inceptionYear)
Sets the inceptionYear attribute of the Project object. |
void |
setIssueTrackingUrl(java.lang.String issueTrackingUrl)
Sets the issueTrackingUrl attribute of the Project object. |
void |
setLicenses(java.util.List licenses)
Set licenses for this project. |
void |
setLogo(java.lang.String logo)
Set the project logo image URL. |
void |
setMailingLists(java.util.List mailingLists)
Set mailing lists. |
void |
setOrganization(Organization organization)
Sets the project Organization. |
void |
setPackage(java.lang.String projectPackage)
Sets the package attribute of the Project object. |
void |
setPackageGroups(java.util.List packageGroups)
Sets the list of PackageGroup instances used for documenting the packages |
void |
setParent(Project parent)
Set the project that this one extends |
void |
setPomVersion(java.lang.String pomVersion)
Sets the version attribute of the Project object |
void |
setReports(java.util.List reports)
Set a list of dependencies. |
void |
setRepository(Repository repository)
Set the repository for this project. |
void |
setShortDescription(java.lang.String shortDescription)
Set short description |
void |
setSiteAddress(java.lang.String siteAddress)
Set the site address where the documentation lives. |
void |
setSiteDirectory(java.lang.String siteDirectory)
Set the site directory where the documentation lives. |
void |
setUrl(java.lang.String url)
Sets the url attribute of the Project object. |
void |
setVersions(java.util.List versions)
Set the versions for this project. |
static java.lang.String |
standardToLegacyId(java.lang.String id)
This method is to support methods are expecting legacy ids. |
void |
verifyDependencies()
Verify the dependencies for this project. |
Methods inherited from class org.apache.maven.project.BaseObject |
addProperty, equals, getName, getProperties, getProperty, hashCode, isValid, resolvedProperties, setId, setName, setProperties, toString |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public Project()
Method Detail |
public java.io.File getMavenXml()
public boolean hasMavenXml()
public java.lang.String getId()
BaseObject
getId
in class BaseObject
public void setArtifactId(java.lang.String artifactId)
artifactId
- The artifactId.public java.lang.String getArtifactId()
public void setGroupId(java.lang.String groupId)
groupId
- Project group id.public java.lang.String getGroupId()
public MavenJellyContext getPluginContext(java.lang.String pluginId) throws java.lang.Exception
pluginId
- Plugin name.
UnknownPluginException
- if the plugin could not be found
java.lang.Exception
public void setContext(MavenJellyContext context)
context
- the context to usepublic void pushContext(MavenJellyContext context)
context
- public void popContext()
public MavenJellyContext getContext()
public void setArtifacts(java.util.List artifactList)
artifactList
- list of artifacts for the projectpublic java.util.List getArtifacts()
public void setFile(java.io.File file)
file
- POM filepublic java.io.File getFile()
public void setExtend(java.lang.String pomToExtend)
pomToExtend
- Project which this project extends.public java.lang.String getExtend()
public Project getParent()
public boolean hasParent()
public void setParent(Project parent)
parent
- the parent projectpublic java.io.File parentBasedir()
public java.io.File parentMavenXml()
public void setGumpRepositoryId(java.lang.String gumpRepositoryId)
gumpRepositoryId
- Gump repository id.public java.lang.String getGumpRepositoryId()
public void setShortDescription(java.lang.String shortDescription)
shortDescription
- Short description of project.public java.lang.String getShortDescription()
public java.lang.String getArtifactDirectory()
public void setSiteAddress(java.lang.String siteAddress)
siteAddress
- the hostname of the web server that hosts the
project's web site (ex: "jakarta.apache.org")public java.lang.String getSiteAddress()
public void setSiteDirectory(java.lang.String siteDirectory)
siteDirectory
- the directory on the web server where the public
web site for this project resides
(ex: "/www/maven.apache.org/")public java.lang.String getSiteDirectory()
public void setDistributionSite(java.lang.String distributionSite)
distributionSite
- the server where the
final distributions will be publishedpublic java.lang.String getDistributionSite()
public void setDistributionDirectory(java.lang.String distributionDirectory)
distributionDirectory
- the directory on the web server where the
final distributions will be published
(ex: "/www/maven.apache.org/builds/")public java.lang.String getDistributionDirectory()
public void addDependency(Dependency dependency)
dependency
- Dependency for this project.public void setDependencies(java.util.List dependencies)
dependencies
- List of dependencies to add to the project.public java.util.List getDependencies()
public java.util.Set getDependentProjectIds()
public void setDependencyPath(java.lang.String depId, java.lang.String path)
depId
- Dependency id.path
- Classpath for the given dependency.public java.lang.String getDependencyPath(java.lang.String depId)
depId
- Dependency id.
public Dependency getDependency(java.lang.String depId)
depId
- Dependency id.
public void addReport(java.lang.String report)
report
- report for this project.public void setReports(java.util.List reports)
reports
- the reports this project will producepublic java.util.List getReports()
public void setBuild(Build build)
build
- the build environment of a projectpublic Build getBuild()
public void addMailingList(MailingList mailingList)
mailingList
- Mailing list for this project.public void setMailingLists(java.util.List mailingLists)
mailingLists
- Set the mailing lists for the project.public java.util.List getMailingLists()
public void addDeveloper(Developer developer)
developer
- Developer for this project.public void setDevelopers(java.util.List developers)
developers
- Project developers.public java.util.List getDevelopers()
public void setContributors(java.util.List contributors)
contributors
- Contributors for this project.public void addContributor(Contributor contributor)
contributor
- Contributor for this project.public java.util.List getContributors()
public void setLicenses(java.util.List licenses)
licenses
- Licenses for this project.public void addLicense(License license)
license
- License for this project.public java.util.List getLicenses()
public void setRepository(Repository repository)
repository
- the repository this project is part ofpublic Repository getRepository()
Repository
for this projectpublic void setUrl(java.lang.String url)
url
- the URL to the organization's home pagepublic java.lang.String getUrl()
public void setIssueTrackingUrl(java.lang.String issueTrackingUrl)
issueTrackingUrl
- the URL to the project's issue tracking systempublic java.lang.String getIssueTrackingUrl()
public void setDescription(java.lang.String description)
description
- the long description of the projectpublic java.lang.String getDescription()
public boolean hasRepository()
true
if the project is part of a repository,
false
otherwisepublic void setCurrentVersion(java.lang.String currentVersion)
currentVersion
- the current version number of the project, e.g.
1.0
, 1.1-dev
public java.lang.String getCurrentVersion()
1.0
,
1.1-dev
public void setOrganization(Organization organization)
organization
- the organisation namepublic Organization getOrganization()
public void setPackage(java.lang.String projectPackage)
projectPackage
- the package name, e.g.
org.apache.maven
public java.lang.String getPackage()
org.apache.maven
public void setInceptionYear(java.lang.String inceptionYear)
inceptionYear
- the year the project started, e.g. 2000
public java.lang.String getInceptionYear()
public void setPomVersion(java.lang.String pomVersion)
pomVersion
- the new valuepublic java.lang.String getPomVersion()
1
if no value is providedpublic boolean isPomCurrent()
true
if the pom version is the same as the
currently running version of maven specified by MavenConstants
,
or false
otherwisepublic void addVersion(Version version)
version
- Distribution for this project.public void setVersions(java.util.List versions)
versions
- List of versions for this project.public java.util.List getVersions()
public void addBranch(Branch branch)
branch
- Branch for this project.public void setBranches(java.util.List branches)
branches
- List of branches for this project.public java.util.List getBranches()
public Version getVersionById(java.lang.String versionId)
versionId
- the id of the version to return
public void setLogo(java.lang.String logo)
logo
- the url for the project logo image.public java.lang.String getLogo()
public java.util.List getPackageGroups()
public void setPackageGroups(java.util.List packageGroups)
packageGroups
- is the list of PackageGroup instancespublic void addPackageGroup(PackageGroup packageGroup)
packageGroup
- is the new PackageGroup instance to be added to the
listpublic org.dom4j.Document createDocument() throws java.lang.Exception
java.lang.Exception
- If an error occurs while creating the dom4j document.public void initialize() throws java.io.IOException
java.lang.Exception
- If an error occurs during project initialization.
java.io.IOException
public void verifyDependencies() throws RepoConfigException, UnsatisfiedDependencyException, ChecksumVerificationException
RepoConfigException
- If an error occurs checking the local settings.
UnsatisfiedDependencyException
- If an error occurs due to missing exceptions.
ChecksumVerificationException
- if the downloaded files fail verificationpublic void setDependencyVerifier(DependencyVerifier dependencyVerifier)
dependencyVerifier
- Dependency Verifier.public DependencyVerifier getDependencyVerifier()
public java.lang.String getDependencyClasspath()
public void buildArtifactList()
public static java.lang.String legacyToStandardId(java.lang.String id)
id
- the legacy id to convert
public static java.lang.String standardToLegacyId(java.lang.String id)
id
- the standard id to convert
public void mergeParent(Project parent)
parent
- the parent project
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |