|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.AbstractMavenComponent
org.apache.maven.MavenSession
public class MavenSession
This class should represent the single place to access everything that MavenSession provides and control any options provided by MavenSession. Currently this is not entirely the case: there are bits of logic that need to be moved out of App.java and some code that needs to be shuffled between the PluginManager and MavenSession proper.
Field Summary | |
---|---|
static java.lang.String |
BUILD_END_GOAL
Tag for build end goal. |
static java.lang.String |
BUILD_START_GOAL
Tag for build start goal. |
static java.lang.String |
DRIVER_SCRIPT_NAME
Initialization jellyscript name. |
Constructor Summary | |
---|---|
MavenSession()
Default Constructor. |
Method Summary | |
---|---|
void |
attainGoals(Project project,
java.util.List goals)
Attain a list of goals. |
java.util.Set |
getAllGoalNames()
Return all goals requested to be attained. |
java.lang.String |
getGoalDescription(java.lang.String goalName)
Get a given goal's description. |
java.util.Collection |
getPluginList()
Return the current list of plugins. |
PluginManager |
getPluginManager()
|
Project |
getPluginProjectFromGoal(java.lang.String goal)
Returns a plugin project for the given goal. |
java.util.Set |
getProjectGoals(Project project)
Return the goals for the given project. |
MavenJellyContext |
getRootContext()
|
static java.io.File |
getRootDescriptorFile()
|
Project |
getRootProject()
|
void |
initialize()
Perform pre-build initialization. |
void |
setPluginManager(PluginManager pluginManager)
Set the plugin manager to handle plugin loading for the session |
void |
setRootContext(MavenJellyContext context)
Set the context for the session |
static void |
setRootDescriptorFile(java.io.File descriptorFile)
Set the top level project for the session |
void |
setRootProject(Project project)
Set the top level project object for the session |
Methods inherited from class org.apache.maven.AbstractMavenComponent |
---|
getMessage, getMessage, getProject, setProject |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String BUILD_START_GOAL
public static final java.lang.String BUILD_END_GOAL
public static final java.lang.String DRIVER_SCRIPT_NAME
Constructor Detail |
---|
public MavenSession()
Method Detail |
---|
public void setRootContext(MavenJellyContext context)
context
- the context to usepublic MavenJellyContext getRootContext()
public static void setRootDescriptorFile(java.io.File descriptorFile)
descriptorFile
- the POM for the top level projectpublic static java.io.File getRootDescriptorFile()
public void setRootProject(Project project)
project
- the top level projectpublic Project getRootProject()
public void setPluginManager(PluginManager pluginManager)
pluginManager
- a plugin managerpublic PluginManager getPluginManager()
public void initialize() throws java.lang.Exception
java.lang.Exception
- If an error occurs while performing
runtime initialization.public java.util.Set getAllGoalNames()
public java.lang.String getGoalDescription(java.lang.String goalName)
goalName
- Goal name to get the description for.
public void attainGoals(Project project, java.util.List goals) throws java.lang.Exception
project
- the project being processedgoals
- a list of goal names to execute
java.lang.Exception
- when anything goes wrongpublic Project getPluginProjectFromGoal(java.lang.String goal) throws MavenException
goal
- a goal name
MavenException
- when anything goes wrongpublic java.util.Set getProjectGoals(Project project) throws MavenException
project
- A project
MavenException
- when anything goes wrongpublic java.util.Collection getPluginList()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |