HelpUtil (Maven Help Plugin 2.2 API)

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.maven.plugins.help
Class HelpUtil

java.lang.Object
  org.apache.maven.plugins.help.HelpUtil

public class HelpUtil
extends Object
extends Object

Utility methods to play with Help Mojos.

Version:: $Id: HelpUtil.java 1446786 2013-02-15 21:54:28Z rfscholte $
Author:: Vincent Siveton

Method Summary
`protected static MojoDescriptor`	`getMojoDescriptor(String task, MavenSession session, MavenProject project, String invokedVia, boolean canUsePrefix, boolean isOptionalMojo)` Invoke the following private method `DefaultLifecycleExecutor#getMojoDescriptor(String, MavenSession, MavenProject, String, boolean, boolean)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

getMojoDescriptor

protected static MojoDescriptor getMojoDescriptor(String task,
                                                  MavenSession session,
                                                  MavenProject project,
                                                  String invokedVia,
                                                  boolean canUsePrefix,
                                                  boolean isOptionalMojo)
                                           throws MojoFailureException,
                                                  MojoExecutionException

Invoke the following private method


 DefaultLifecycleExecutor#getMojoDescriptor(String, MavenSession, MavenProject, String, boolean, boolean)

Parameters:: task - not null; session - not null; project - not null; invokedVia - not null; canUsePrefix - not null; isOptionalMojo - not null
Returns:: MojoDescriptor for the task
Throws:: MojoFailureException - if can not invoke the method.; MojoExecutionException - if no descriptor was found for task.
See Also:: DefaultLifecycleExecutor.getMojoDescriptor(String, MavenSession, MavenProject, String, boolean, boolean)