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 dependencies of the Project Object Model
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	getTestOutputDirectory() Returns a directory where project test output is stored.
List<Resource>	getTestResources() Returns a list of defined test resources for current project.
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:

GroupId of the project

getArtifactId

String getArtifactId()

ArtifactId of the project

Returns:

ArtifactId of the project

getVersion

String getVersion()

Version of the project

Returns:

Version of the project

getName

String getName()

Name of the project

Returns:

Name of the project

getOrganizationName

String getOrganizationName()

Returns organization name

Returns:

Organization name

getOrganizationUrl

URL getOrganizationUrl()
                       throws IllegalStateException

Returns organization url

Returns:

Organization url

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:

Final name of the project packaged as a JAR, WAR or EAR

getPackagingType

PackagingType getPackagingType()

Packaging type of the project

Returns:

Packaging type of the project

getBaseDirectory

File getBaseDirectory()

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

Returns:

A base directory of the project.

getSourceDirectory

File getSourceDirectory()

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

Returns:

A directory where project sources are stored.

getBuildOutputDirectory

File getBuildOutputDirectory()

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

Returns:

A directory where project build output is stored.

getTestSourceDirectory

File getTestSourceDirectory()

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

Returns:

A directory where project test sources are stored.

getTestOutputDirectory

File getTestOutputDirectory()

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

Returns:

A directory where project test output is stored.

getDependencies

Set<MavenDependency> getDependencies()

Returns dependencies of the Project Object Model

Returns:

Dependencies of the Project Object Model

getDependencyManagement

Set<MavenDependency> getDependencyManagement()

Returns dependency management of the Project Object Model

Returns:

Dependency management of the Project Object Model

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:

A list of files defined as a resources for current project.

See Also:

getResources()

getResources

List<Resource> getResources()

Returns a list of defined resources for current project.

Returns:

A list of defined resources for current project.

getTestResources

List<Resource> getTestResources()

Returns a list of defined test resources for current project.

Returns:

A list of defined test resources for current project.

getProperties

Properties getProperties()

Returns interpolated properties defined in the current project

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:

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