org.mevenide.goals.grabber
Interface IGoalsGrabber

All Known Implementing Classes:

AbstractGoalsGrabber, GoalsGrabbersAggregator

public interface IGoalsGrabber

Version:

$Id: IGoalsGrabber.java 3 mai 2003 22:20:0113:34:35 Exp gdodinet

Author:

Gilles Dodinet (gdodinet@wanadoo.fr)

Field Summary

static java.lang.String	ORIGIN_PLUGIN
static java.lang.String	ORIGIN_PROJECT

Method Summary

java.lang.String	getDescription(java.lang.String fullyQualifiedGoalName) return the description of plugin:goal
java.lang.String[]	getGoals(java.lang.String plugin) return the goals declared by the plugin whose name is passed as parameter
java.lang.String	getName()
java.lang.String	getOrigin(java.lang.String fullyQualifiedGoalName) will return where the goal is defined.
java.lang.String[]	getPlugins() return all available plugins
java.lang.String[]	getPrereqs(java.lang.String fullyQualifiedGoalName)
void	refresh()

Field Detail

ORIGIN_PROJECT

public static final java.lang.String ORIGIN_PROJECT

See Also:

Constant Field Values

ORIGIN_PLUGIN

public static final java.lang.String ORIGIN_PLUGIN

See Also:

Constant Field Values

Method Detail

getPlugins

public java.lang.String[] getPlugins()

return all available plugins

Returns:

Collection

getGoals

public java.lang.String[] getGoals(java.lang.String plugin)

return the goals declared by the plugin whose name is passed as parameter

Parameters:

plugin -

Returns:

Collection

getDescription

public java.lang.String getDescription(java.lang.String fullyQualifiedGoalName)

return the description of plugin:goal

getPrereqs

public java.lang.String[] getPrereqs(java.lang.String fullyQualifiedGoalName)

refresh

public void refresh()
             throws java.lang.Exception

Throws:

java.lang.Exception

getOrigin

public java.lang.String getOrigin(java.lang.String fullyQualifiedGoalName)

will return where the goal is defined.

Returns:

ORIGIN_PLUGIN or ORIGIN_PROJECT

getName

public java.lang.String getName()