org.mevenide.goals.grabber
Class AbstractGoalsGrabber

java.lang.Object
  org.mevenide.goals.grabber.AbstractGoalsGrabber

All Implemented Interfaces:

IGoalsGrabber

Direct Known Subclasses:

DefaultGoalsGrabber, ProjectGoalsGrabber

public abstract class AbstractGoalsGrabber
extends java.lang.Object
implements IGoalsGrabber

Version:

$Id: AbsractGoalsGrabber.java 5 sept. 2003 Exp gdodinet

Author:

Gilles Dodinet (gdodinet@wanadoo.fr)

Field Summary

protected java.util.Map	descriptions
protected java.util.Map	plugins
protected java.util.Map	prereqs

Fields inherited from interface org.mevenide.goals.grabber.IGoalsGrabber

ORIGIN_PLUGIN, ORIGIN_PROJECT

Constructor Summary

protected

AbstractGoalsGrabber()

Method Summary

protected boolean	containsGoal(java.lang.String fullyQualifiedGoalName)
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	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()
protected void	registerGoal(java.lang.String fullyQualifiedGoalName, java.lang.String properties)
protected void	registerGoalName(java.lang.String fullyQualifiedGoalName)
protected void	registerGoalProperties(java.lang.String fullyQualifiedGoalName, java.lang.String properties)
protected java.lang.String[]	toStringArray(java.util.Collection stringCollection) convert a Collection of Strings into an String[] The resulted array is also sorted according to the natural order

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.mevenide.goals.grabber.IGoalsGrabber

getName

Field Detail

plugins

protected java.util.Map plugins

prereqs

protected java.util.Map prereqs

descriptions

protected java.util.Map descriptions

Constructor Detail

AbstractGoalsGrabber

protected AbstractGoalsGrabber()

Method Detail

refresh

public void refresh()
             throws java.lang.Exception

Specified by:

refresh in interface IGoalsGrabber

Throws:

java.lang.Exception

registerGoal

protected void registerGoal(java.lang.String fullyQualifiedGoalName,
                            java.lang.String properties)

registerGoalName

protected void registerGoalName(java.lang.String fullyQualifiedGoalName)

registerGoalProperties

protected void registerGoalProperties(java.lang.String fullyQualifiedGoalName,
                                      java.lang.String properties)

getPlugins

public java.lang.String[] getPlugins()

Description copied from interface: IGoalsGrabber

return all available plugins

Specified by:

getPlugins in interface IGoalsGrabber

Returns:

Collection

getGoals

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

Description copied from interface: IGoalsGrabber

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

Specified by:

getGoals in interface IGoalsGrabber

Returns:

Collection

containsGoal

protected boolean containsGoal(java.lang.String fullyQualifiedGoalName)

getOrigin

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

Description copied from interface: IGoalsGrabber

will return where the goal is defined.

Specified by:

getOrigin in interface IGoalsGrabber

Returns:

ORIGIN_PLUGIN or ORIGIN_PROJECT

getDescription

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

Description copied from interface: IGoalsGrabber

return the description of plugin:goal

Specified by:

getDescription in interface IGoalsGrabber

getPrereqs

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

Specified by:

getPrereqs in interface IGoalsGrabber

toStringArray

protected java.lang.String[] toStringArray(java.util.Collection stringCollection)

convert a Collection of Strings into an String[] The resulted array is also sorted according to the natural order

See Also:

java.util.TreeSet}