org.apache.maven.werkz
Interface Action

All Known Implementing Classes:

DefaultAction, DummyAction, ListAddAction, MavenGoalTag.MavenGoalAction

public interface Action

Interface for goal-satisfying actions.

Author:

bob mcwhirter

See Also:

Goal, Goal.setAction(org.apache.maven.werkz.Action), DefaultAction

Method Summary

void	performAction(Session session) Perform the action required to satisfy the Goal.
boolean	requiresAction() Determine if this Action's performAction(org.apache.maven.werkz.Session) method should be invoked.

Method Detail

requiresAction

boolean requiresAction()

Determine if this Action's performAction(org.apache.maven.werkz.Session) method should be invoked.

This method is called after this Goal's prerequisites have been completely satisfied, and immediately before the possibility of invoking performAction().

If this method returns true, then this Goal's performAction() will be called in order to satisfy this Goal. If this method returns false, then this Goal is considered satisfied without invoking the performAction() method.

This method is the location to implement intra-goal dependency-checking.

Returns:

true if this Goal's performAction() method should be immediately invoked, otherwise false.

See Also:

performAction(org.apache.maven.werkz.Session)

performAction

void performAction(Session session)
                   throws java.lang.Exception

Perform the action required to satisfy the Goal.

Once all prerequisites have been satisfied, the Goal's performAction() method may be invoked, depending on the return value of requiresAction(), in order to satisfy this Goal.

Throws:

java.lang.Exception - if an errors occurs during execution.