org.jboss.shrinkwrap.resolver.api.maven.pom

Interface ParsedPomFile

public interface ParsedPomFile

Representation of a parsed Project Object Model file

Author:

Karel Piwko

Method Summary

Methods

Modifier and Type	Method and Description
String	getArtifactId() ArtifactId of the project
File	getBaseDirectory() Returns a base directory of the project.
File	getBuildOutputDirectory() Returns a directory where project build output is stored.
Set<MavenDependency>	getDependencies() Returns
Set<MavenDependency>	getDependencyManagement() Returns dependency management of the Project Object Model
String	getFinalName() Final name of the project packaged as a JAR, WAR or EAR; by default it is artifactId + "." + packagingType
String	getGroupId() GroupId of the project
String	getName() Name of the project
String	getOrganizationName() Returns organization name
URL	getOrganizationUrl() Returns organization url
PackagingType	getPackagingType() Packaging type of the project
Map<String,Object>	getPluginConfiguration(String pluginKey) Returns a plugin configuration in from of a map.
List<File>	getProjectResources() Deprecated.
Properties	getProperties() Returns interpolated properties defined in the current project
List<Resource>	getResources() Returns a list of defined resources for current project.
File	getSourceDirectory() Returns a directory where project sources are stored.
File	getTestSourceDirectory() Returns a directory where project test sources are stored.
String	getVersion() Version of the project

Method Detail

getGroupId

String getGroupId()

GroupId of the project

Returns:

getArtifactId

String getArtifactId()

ArtifactId of the project

Returns:

getVersion

String getVersion()

Version of the project

Returns:

getName

String getName()

Name of the project

Returns:

getOrganizationName

String getOrganizationName()

Returns organization name

Returns:

getOrganizationUrl

URL getOrganizationUrl()
                       throws IllegalStateException

Returns organization url

Returns:

Throws:

IllegalStateException - if organization URL in PMO file does not represent a valid URL

getFinalName

String getFinalName()

Final name of the project packaged as a JAR, WAR or EAR; by default it is artifactId + "." + packagingType

Returns:

getPackagingType

PackagingType getPackagingType()

Packaging type of the project

Returns:

getBaseDirectory

File getBaseDirectory()

Returns a base directory of the project. Might be null.

Returns:

getSourceDirectory

File getSourceDirectory()

Returns a directory where project sources are stored. Might be null.t

Returns:

getBuildOutputDirectory

File getBuildOutputDirectory()

Returns a directory where project build output is stored. Might be null.

Returns:

getTestSourceDirectory

File getTestSourceDirectory()

Returns a directory where project test sources are stored. Might be null.

Returns:

getDependencies

Set<MavenDependency> getDependencies()

Returns

Returns:

getDependencyManagement

Set<MavenDependency> getDependencyManagement()

Returns dependency management of the Project Object Model

Returns:

getProjectResources

@Deprecated
List<File> getProjectResources()

Deprecated.

Returns a list of files defined as a resources for current project. This method is not able to handle hierarchical resources and includes/excludes

Returns:

See Also:

getResources()

getResources

List<Resource> getResources()

Returns a list of defined resources for current project.

Returns:

getProperties

Properties getProperties()

Returns interpolated properties defined in the current project

getPluginConfiguration

Map<String,Object> getPluginConfiguration(String pluginKey)

Returns a plugin configuration in from of a map. Never returns null

Parameters:

pluginKey - a combination of groupId:artifactId

Returns: