org.netbeans.modules.maven.spi.actions

Class AbstractMavenActionsProvider

java.lang.Object

org.netbeans.modules.maven.spi.actions.AbstractMavenActionsProvider

All Implemented Interfaces:

MavenActionsProvider

Direct Known Subclasses:

DefaultActionGoalProvider, NbGlobalActionGoalProvider

public abstract class AbstractMavenActionsProvider
extends Object
implements MavenActionsProvider

a default implementation of MavenActionsProvider, a fallback when nothing is user configured or overridden by a more specialized provider.

Field Summary

Fields

Modifier and Type	Field and Description
protected ActionToGoalMapping	originalMappings
protected NetbeansBuildActionXpp3Reader	reader

Constructor Summary

Constructors

Constructor and Description
AbstractMavenActionsProvider() Creates a new instance of DefaultActionProvider

Method Summary

Modifier and Type	Method and Description
RunConfig	createConfigForDefaultAction(String actionName, Project project, Lookup lookup) Create an instance of RunConfig configured for execution.
static String	dynamicSubstitutions(Map<String,String> replaceMap, String in)
protected static FileObject[]	extractFileObjectsfromLookup(Lookup lookup) just gets the array of FOs from lookup.
static MavenActionsProvider	fromNbActions(Project mavenProject, URL resourceURL) Constructs a MavenActionsProvider from declarative action descriptions.
protected abstract InputStream	getActionDefinitionStream() content of the input stream shall be the xml with action definitions
NetbeansActionMapping	getMappingForAction(String actionName, Project project) get a action to maven mapping configuration for the given action.
ActionToGoalMapping	getRawMappings()
String	getRawMappingsAsString()
Set<String>	getSupportedDefaultActions() default implementation will look in the content of the
boolean	isActionEnable(String action, Project project, Lookup lookup) return is action is supported or not
boolean	isActionEnable(String action, String prjPack) Performance convenience to AbstractMavenActionsProvider.isActionEnable(java.lang.String, org.netbeans.api.project.Project, org.openide.util.Lookup).
protected Reader	performDynamicSubstitutions(Map<String,String> replaceMap, String in) takes the input stream and a map, and for each occurence of ${<mapKey>} , replaces it with map entry value..
protected boolean	reloadStream() override in children that are listening on changes of model and need refreshing..

Methods inherited from class java.lang.Object

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

Field Detail

originalMappings

protected ActionToGoalMapping originalMappings

reader

protected NetbeansBuildActionXpp3Reader reader

Constructor Detail

AbstractMavenActionsProvider

public AbstractMavenActionsProvider()

Creates a new instance of DefaultActionProvider

Method Detail

extractFileObjectsfromLookup

protected static FileObject[] extractFileObjectsfromLookup(Lookup lookup)

just gets the array of FOs from lookup.

Parameters:

lookup -

Returns:

isActionEnable

public boolean isActionEnable(String action,
                              Project project,
                              Lookup lookup)

Description copied from interface: MavenActionsProvider

return is action is supported or not

Specified by:

isActionEnable in interface MavenActionsProvider

Parameters:

action - action name, see ActionProvider for details.

project - project that the action is invoked on.

lookup - context for the action

Returns:

isActionEnable

public final boolean isActionEnable(String action,
                                    String prjPack)

Performance convenience to AbstractMavenActionsProvider.isActionEnable(java.lang.String, org.netbeans.api.project.Project, org.openide.util.Lookup). Avoids redundant and potentially costly packaging retrieval.

Parameters:

action -

prjPack -

Returns:

createConfigForDefaultAction

public final RunConfig createConfigForDefaultAction(String actionName,
                                                    Project project,
                                                    Lookup lookup)

Description copied from interface: MavenActionsProvider

Create an instance of RunConfig configured for execution.

Specified by:

createConfigForDefaultAction in interface MavenActionsProvider

Parameters:

actionName - one of the ActionProvider constants

Returns:

RunConfig or null, if action not supported

getRawMappings

public ActionToGoalMapping getRawMappings()

getRawMappingsAsString

public String getRawMappingsAsString()

getSupportedDefaultActions

public Set<String> getSupportedDefaultActions()

default implementation will look in the content of the

Specified by:

getSupportedDefaultActions in interface MavenActionsProvider

Returns:

reloadStream

protected boolean reloadStream()

override in children that are listening on changes of model and need refreshing..

Returns:

getMappingForAction

public NetbeansActionMapping getMappingForAction(String actionName,
                                                 Project project)

get a action to maven mapping configuration for the given action. No replacements happen. The instance returned is always a new copy, can be modified or reused.

Specified by:

getMappingForAction in interface MavenActionsProvider

Parameters:

actionName -

project -

Returns:

getActionDefinitionStream

protected abstract InputStream getActionDefinitionStream()

content of the input stream shall be the xml with action definitions

Returns:

performDynamicSubstitutions

protected Reader performDynamicSubstitutions(Map<String,String> replaceMap,
                                             String in)
                                      throws IOException

takes the input stream and a map, and for each occurence of ${<mapKey>} , replaces it with map entry value..

Parameters:

replaceMap -

in -

Returns:

Throws:

IOException

dynamicSubstitutions

public static String dynamicSubstitutions(Map<String,String> replaceMap,
                                          String in)

fromNbActions

public static MavenActionsProvider fromNbActions(Project mavenProject,
                                                 URL resourceURL)

Constructs a MavenActionsProvider from declarative action descriptions. The resourceURL parameter identifies a nbactions.xml-format resource which can add/define actions in the default configuration. It can also contribute configurations (profiles) using the nested <profile> element.

Actions in the contributed configuration profiles are merged; multiple MavenActionsProviders created by AbstractMavenActionsProvider.fromNbActions(org.netbeans.api.project.Project, java.net.URL) can supply their actions. The first definition of a given actionName counts, subsequent definitions from MavenActionsProvider further in the project's Lookup are ignored.

Note: at the moment it is not possible to build the default configuration actions from multiple MavenActionsProviders.

This is a part of Maven module's friend API. If possible, use se MavenActions to register actions declaratively, using module layers.

Parameters:

mavenProject - the maven project.

resourceURL - action definitions.

Returns:

new MavenActionsProvider instance.

Since:

2.148