org.apache.maven.dotnet.embedder
Interface MavenProject

All Superinterfaces:
java.lang.Comparable
All Known Implementing Classes:
MavenProjectImpl

public interface MavenProject
extends java.lang.Comparable

Provides web services for obtaining maven project information.

Author:
Shane Isbell

Field Summary
static java.lang.String ROLE
          Role used to register component implementations with the container.
 
Method Summary
 java.lang.String getArtifactId()
          Returns the artifact id of the maven project.
 java.lang.String getGroupId()
          Returns the group id of the maven project.
 java.util.Set<MavenProject> getMavenProjects()
          Returns a set of maven project children (typically the modules of a parent pom).
 java.lang.String getPomPath()
          Returns the path to the maven project's pom.
 java.lang.String getVersion()
          Returns the version of the maven project.
 boolean isOrphaned()
          Returns true if both of the following conditions apply: 1) the project is not in the root directory AND 2) the project is not attached (as a module) to a pom that exists in the root directory, otherwise returns false.
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Field Detail

ROLE

static final java.lang.String ROLE
Role used to register component implementations with the container.

Method Detail

getPomPath

java.lang.String getPomPath()
Returns the path to the maven project's pom.

Returns:
the path to the maven project's pom

getGroupId

java.lang.String getGroupId()
Returns the group id of the maven project.

Returns:
the group id of the maven project.

getArtifactId

java.lang.String getArtifactId()
Returns the artifact id of the maven project.

Returns:
the artifact id of the maven project

getVersion

java.lang.String getVersion()
Returns the version of the maven project.

Returns:
the version of the maven project

getMavenProjects

java.util.Set<MavenProject> getMavenProjects()
Returns a set of maven project children (typically the modules of a parent pom).

Returns:
a set of maven project children

isOrphaned

boolean isOrphaned()
Returns true if both of the following conditions apply: 1) the project is not in the root directory AND 2) the project is not attached (as a module) to a pom that exists in the root directory, otherwise returns false.

Returns:
true if both of the following conditions apply: 1) the project is not in the root directory AND 2) the project is not attached (as a module) to a pom that exists in the root directory, otherwise returns false.


Copyright © 2007 NMaven. All Rights Reserved.